Skip to main content

Wallet configuration methods

Endpoint
http://127.0.0.1:3420/v3/owner
Credential
Token from open_wallet, inside the encrypted envelope. Loopback only
Methods here
4
Documented against
node 4.0.3, wallet 4.0.0

Point the wallet at a different relay.

Surface
/v3/owner on port 3420
Parameters
1 named
Declared in
api/src/owner_rpc_s.rs:2234
  • Changing the relay changes the domain in your epicbox address, so anyone holding the old one can no longer reach you.
Parameters

Relay host, port and whether to use ws instead of wss.

12 lines
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "set_epicbox_config",
  "params": {
    "epicbox_config": {
      "epicbox_domain": "epicbox.epiccash.com",
      "epicbox_port": 443,
      "epicbox_protocol_unsecure": false
    }
  }
}
Response
N/A

Set the Tor bridge and proxy settings the wallet uses for onion delivery.

Surface
/v3/owner on port 3420
Parameters
1 named
Declared in
api/src/owner_rpc_s.rs:2197
Parameters

Tor bridge and proxy settings.

8 lines
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "set_tor_config",
  "params": {
    "tor_config": null
  }
}
Response
N/A

start_updater

Read only

Start the background thread that refreshes wallet state.

Surface
/v3/owner on port 3420
Parameters
2 named
Declared in
api/src/owner_rpc_s.rs:1894
  • With the updater running, calls can pass refresh_from_node false and still see fresh figures, which is how a responsive UI avoids blocking on the node.
Parameters

Session token. Every method on this surface needs it.

Milliseconds between refreshes.

9 lines
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "start_updater",
  "params": {
    "token": "<token from open_wallet>",
    "frequency": 30000
  }
}
Response
N/A

stop_updater

Read only

Stop the background updater.

Surface
/v3/owner on port 3420
Parameters
none
Declared in
api/src/owner_rpc_s.rs:1924

This method takes no parameters.

6 lines
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "stop_updater",
  "params": {}
}
Response
N/A

Next