UltraNote RPC Wallet

Start

On this page you will find description of every method in UltraNote Ininfity RPC Wallet API. UltraNote Infinity RPC Wallet is a HTTP server which provides JSON 2.0 RPC interface for UltraNote payment operations and address management. Each method has its own page that can be found by clicking on this method.

To make a JSON PRC request to your UltraNote Infinity RPC Wallet you should use POST request that looks like this:

http://service_address:service_port/json_rpc

Where:

service_address: is an IP of UltraNote Infinity RPC Wallet, if RPC Wallet is located on local machine it is either 127.0.0.1 or localhost.

service_port: is UltraNote Infinity RPC Wallet port, by default it is binded to 8070 port, but it can be manually binded to any port you want.

Walletd common options:

Option Description

-c [ --config ]

Configuration file.

-h [ --help ]

Produce this help message and exit.

--local

Start with local node. (remote is default)

--testnet

Testnet mode.

--data-dir

Specify data directory.

--bind-address

Which address to bind UltraNote RPC Wallet to. Default value is 0.0.0.0

--bind-port

Which port to bind UltraNote RPC Wallet to. Default value is 8070

--rpc-user

Username to use the payment service. If authorization is not required, you can leave it empty.

--rpc-password

Password to use the payment service. If authorization is not required, you can leave it empty.

-w [ --container-file ]

Container file.

-p [ --container-password ]

Container password.

-g [ --generate-container ]

Generate a new container.

-d [ --daemon ]

Run as daemon in Unix or as a service in Windows.

--register-service

Register service and exit. (Windows Only).

--unregister-service

Unregister service and exit. (Windows Only).

-l [ --log-file ]

Log file

--server-root

Working directory that you wish to use for UltraNote RPC Wallet. Default is current working directory.

--log-level

Set log level.

--address

Print wallet address and exit.

Remote node options:

Parameter Description

--daemon-address

UltraNote daemon address, You can set to localhost.

--daemon-port

UltraNote daemon port, You can use 8081.

Local node options:


Parameter Description

--p2p-bind-ip

Interface for p2p network protocol, You can use 0.0.0.0.

--p2p-bind-port

Port for p2p network protocol, You can use 30000.

--p2p-external-port

External port for p2p network protocol. Use 0 if port forwarding used with NAT.

--allow-local-ip

Allow local ip add to peer list, mostly in debug puposes.

--add-peer

Manually add peer to local peer list.

--add-priority-node

Specify list of peers to connect to and attempt to keep connection open.

--add-exclusive-node

Specify list of peers to connect to only.

--seed-node

Connect to a node to retrieve peer address and disconnect.

--hide-my-port

Do not announce yourself as peerlist candidate.

Example of config file

container-file= # REQUIRED. Path to wallet container container-password= # REQUIRED. Password data-dir=/srv/ultranote # Where blockchain data is stored. Defaults to /home/user/.UltraNote bind-address=0.0.0.0 # Use server IP or 127.0.0.1 bind-port=8070 # Port rpc-user= # Auth user for RPC service rpc-password= # Password for RPC service server-root=/srv/ultranote # Working directory log-level= # Log level 0-4 local=1 # Use In-process node daemon-address=localhost # remote daemon address, don't use it with in-process mode daemon-port=30000 # UltraNote P2P port.

Minimal Configuration

container-file=/etc/ultranote/container.iwallet container-password=secret123 bind-address=127.0.0.1 bind-port=8070 log-file=/var/log/walletd.log local=1

Generate wallet container

walletd --config=/etc/paymentgate.conf --generate-container

Start UltraNote RPC wallet

walletd --config=/etc/paymentgate.conf

Didn't find an answer to your question?

Contact Us