Bytecoin RPC Wallet

From Bytecoin Wiki
Jump to: navigation, search

This wiki section describes Bytecoin integration process into your service with Bytecoin e-commerce solution called Bytecoin RPC Wallet. Bytecoin RPC Wallet is a HTTP server which provides JSON 2.0 RPC interface for Bytecoin payment operations and address management. Bytecoin RPC Wallet allows you to accept incoming payments, generate an address for each user via Bytecoin RPC Wallet JSON RPC API and much more. Bytecoin RPC Wallet JSON RPC API page contains detailed description of every method.

Contents

Download Bytecoin RPC Wallet

To start integration process you should first download Bytecoin RPC Wallet, you can find it here: https://bytecoin.org/downloads/

You may also build RPC Wallet from source code: https://github.com/amjuarez/bytecoin/

Generate a new wallet

To start using RPC wallet you must first generate a container. Container file is the only file that stores all data required to run your service. It contains user addresses and private keys required to operate them. Make sure to backup this file regularly.

To generate a new container you should run the following command:

$ ./walletd --container-file=<mycontainer> --container-password=<mypass> --generate-container

where:

  • <mycontainer> is the container file name and a path to it (relative or absolute); path is optional in this argument, specifying only a container's name will result in new file located in the same folder as RPC Wallet
  • <mypass> is a secret password for the new wallet file. Whichever you like;
  • --generate-container option tells RPC wallet to generate container file and exit.

Note: if <mycontainer> exists Bytecoin RPC Wallet will show you the notification and will ask you to provide a different name.

If the operation was successful you will get a corresponding message with your new Bytecoin address. At the same time Bytecoin RPC Wallet will save your container on the local disk (in the same folder where Bytecoin RPC Wallet is located) and shut down.

Start Bytecoin RPC Wallet

There are two ways to start Bytecoin RPC Wallet:

Start with a remote connection to the Daemon

Remote connection allows you to bind your Bytecoin RPC Wallet to a remote Bytecoin daemon (bytecoind). You may establish Bytecoin daemon on both local and remote machines and connect to. Such type of connection allows you to start Bytecoin RPC Wallet on a relatively slow machine while heavy loaded daemon is going to work on a separate powerful server.

  • For local daemons use localhost or 127.0.0.1 as an IP address.
  • For remote daemons specify the remote daemon's IP address.

Default Bytecoin daemon ports are 8080 and 8081.

Use the following command to start Bytecoin RPC Wallet with a remote connection:

$ ./walletd --container-file=<mycontainer> --container-password=<mypass> --daemon-address=<remote_ip> --daemon-port=8080

Note: Bytecoin daemon (bytecoind) should be running at the moment RPC wallet is starting in a remote connection mode.

Note: Bytecoin RPC Wallet will still provide some functionality even if Daemon server fails. For example, you will be able to generate addresses for your users.

Start as in-process node

You can also start Bytecoin RPC Wallet with an in-process node. This allows you to start RPC Wallet out-of-box with no external daemon required. You will get a fully functional node for Bytecoin network inside Bytecoin RPC Wallet. You don't have to download or install anything besides Bytecoin RPC Wallet. This approach will help reduce the overheads required for infrastructure maintenance.

Use the following command to start Bytecoin RPC Wallet with an in-process node

$ ./walletd --container-file=<mycontainer> --container-password=<mypass> --local

Configure Bytecoin RPC Wallet

To configure RPC wallet you can use both command line and config file. Config file allows you to configure your settings only once and use "--config" option further. The command below launches Bytecoin RPC Wallet with a specific config file:

$ ./walletd --config=/home/Downloads/myconfig.conf

To get help on available options run:

$ ./walletd -h

Please note, Bytecoin RPC Wallet config file may consist only of these options:

Option Description Config Example Console Example
bind-address Which address to bind Bytecoin RPC Wallet to. Default value is 0.0.0.0 bind-address = 127.0.0.1 --bind-address=127.0.0.1
bind-port Which port to bind Bytecoin RPC Wallet to. Default value is 8070 bind-port = 8071 --bind-port=8071
daemon-address Bytecoin daemon (bytecoind) address for remote daemon connection infrastructure daemon-address = 127.0.0.1 --daemon-address=127.0.0.1
daemon-port Bytecoin daemon (bytecoind) port for remote daemon connection infrastructure. Default Bytecoin daemon ports are 8080 and 8081 daemon-port = 8080 --daemon-port=8080
container-file Mandatory. Your container's file name container-file = mycontainer --container-file=mycontainer
container-password Mandatory. Your container's password container-password = mypassword --container-password=mypassword
log-file A name of log file that you want to use for logging. Default is walletd.log log-file = mylog.log --log-file=mylog.log
server-root Working directory that you wish to use for Bytecoin RPC Wallet. Default is current working directory. server-root = /home/Downloads/RPCWallet --server-root=/home/Downloads/RPCWallet
log-level Level of logging. Default is 1. log-level = 2 --log-level=2
testnet Allows you to run Bytecoin RPC Wallet in testnet. testnet = no --testnet=no
local Option that allows you to start Bytecoin RPC Wallet as an in-process node local --local


Here's an example of a config file:

$ cat rpc_wallet.conf 
container-file = mycontainer
container-password = mypassword
daemon-port = 8091
bind-port = 8050
testnet = no

You may specify Bytecoin config directly through console arguments. Here's the same example as above in console:

./walletd --container-file=mycontainer --container-password=mypassword --daemon-port=8080 --bind-port=8050 --testnet=no

Note: config file's path is relative to current working directory, not server root.

Note: options "container-file" and "container-password" should ALWAYS be set (in either command line or config file mode).

Note: "container-file" and "log-file" options are relative to "server-root". "server-root" default is the current working directory.

Run Bytecoin RPC Wallet

Bytecoin RPC wallet can be started in both daemon and console modes.

  • Daemon mode - Bytecoin RPC Wallet is launched in the background, while you can continue to work with a console window.
  • Console mode - Bytecoin RPC Wallet is launched and prints log messages on the screen.

Bytecoin RPC wallet starts in console mode by default.

Start as daemon (UNIX only)

To start RPC wallet as daemon just set "--daemon" (or short "-d") option.

./walletd --container-file=mycontainer --container-password=mypassword --daemon

Note: it's a common practice for daemons to set server root directory.

Server root is the directory where RPC Wallet stores all its files. All relative paths in RPC Wallet configuration are relative to the server root directory.

Start as service (Windows only)

To run RPC wallet as a service on Windows you have to do the following:

1. Create a config file and place it in the same directory as your RPC wallet's executable resides in.

A note for Windows Users: In case the server root in config file is not specified all paths should be ABSOLUTE. If you set server root you can use relative paths (relative to your server root);

2. Register your Bytecoin RPC Wallet as a service. To do so, run the following command as an ADMINISTRATOR:

walletd.exe --register-service

3. After you see message about successful service registration you can run it in your Services panel.

Uninstall service (Windows only)

If you want to delete RPC wallet you have to unregister windows service first (if you have registered it before). Run as an ADMINISTRATOR:

walletd.exe --unregister-service

Bytecoin RPC Wallet JSON RPC API

Bytecoin RPC Wallet API allows you to create addresses for your users, accept and send transactions and much more.

Detailed description for every Bytecoin RPC Wallet API method can be found here: Bytecoin RPC Wallet JSON RPC API

Personal tools
Namespaces

Variants
Actions
Navigation
Tools