Skip to content

Instantly share code, notes, and snippets.

@j3dyy
Created December 1, 2020 21:54
Show Gist options
  • Save j3dyy/619bdac5daa807ddfc0b0201daab497f to your computer and use it in GitHub Desktop.
Save j3dyy/619bdac5daa807ddfc0b0201daab497f to your computer and use it in GitHub Desktop.

Wave Blockchain Websocket-RPC Documentation

Basic Information

Basic Connection to rpc

    var wsUri = 'ws://localhost:55400'
    var ws = new WebSocket(wsUri);

Request Example Json

{
       "command":"register_service",
       "data":{
          "service":"wallet_ui"
       },
       "ack":false,
       "origin":"wallet_ui",
       "destination":"daemon",
       "request_id":"89d216f0117cef5c4b22b79fd5d46b41a00147d129d633607ccb6d910828e96c"
}

Response Example Json

{
        "ack": true,
        "command": "register_service",
        "data": { "success": true },
        "destination": "wallet_ui",
        "origin": "daemon",
        "request_id": "89d216f0117cef5c4b22b79fd5d46b41a00147d129d633607ccb6d910828e96c"
}

Request List

parameter values

  • service: wallet_ui,wave_full_node,wave_wallet,wave_farmer,wave_harvester
  • destination: daemon,wave_full_node,wallet_ui,wave_wallet

Register Service Request

{
       "command":"register_service",
       "data":{
          "service":"wallet_ui"
       },
       "ack":false,
       "origin":"wallet_ui",
       "destination":"daemon",
       "request_id":"89d216f0117cef5c4b22b79fd5d46b41a00147d129d633607ccb6d910828e96c"
}

Is Running Service Request

{
   "command":"is_running",
   "data":{
      "service":"wave plots create"
   },
   "ack":false,
   "origin":"wallet_ui",
   "destination":"daemon",
   "request_id":"6752a15414fc2fb37ffc7d7aa5e0e6811fa56cf168253662235d9aa116095e46"
}

Start Service Request

{
   "command":"start_service",
   "data":{
      "service":"wave_wallet"
   },
   "ack":false,
   "origin":"where_from_request",
   "destination":"daemon",
   "request_id":"b5f86078b971915573ece93548499e6648b71ccbccdcfa857879c1cbc0d59001"
}

Ping Request

{
   "command":"ping",
   "data":{   },
   "ack":false,
   "origin":"wallet_ui",
   "destination":"wave_wallet",
   "request_id":"27689fc6b60c1a3cd410756027efcdc5478ced77504bfb1186ef676766a425ef"
}

Connection Manager Request

{
   "command":"get_connections",
   "data":{  },
   "ack":false,
   "origin":"wallet_ui",
   "destination":"wave_wallet",
   "request_id":"5948eba0c867737b7f1b36d826c25642613cf45a8e98ae91eb7cc6e24d8f794d"
}

Public Keys Request

{
   "command":"get_public_keys",
   "data":{},
   "ack":false,
   "origin":"wallet_ui",
   "destination":"wave_wallet",
   "request_id":"fea9675e068bf917448a1ba7b786c1a2a4a8e660ed8a4ec2dd2398d9fe04f5d8"
}

BlockChain State Request

{
   "command":"get_blockchain_state",
   "data":{

   },
   "ack":false,
   "origin":"wallet_ui",
   "destination":"wave_full_node",
   "request_id":"56f1f4d9de842a55a4806bd1c38bb6836b362422c41d2499dfb097247a1406b7"
}

Block Headers State Request

{
   "command":"get_latest_block_headers",
   "data":{

   },
   "ack":false,
   "origin":"wallet_ui",
   "destination":"wave_full_node",
   "request_id":"80d83975ebcc692f6b9a40e7049e157b81471a736281dca3d27af0da7e6b5322"
}

Login Request

{
   "command":"log_in",
   "data":{
      "fingerprint":3047917333,
      "host":"server-blockchain",
      "type":"normal"
   },
   "ack":false,
   "origin":"wallet_ui",
   "destination":"wave_wallet",
   "request_id":"30577ae85ba0805471237bc8a4ace0745b05370b341705fc4d591fe8e287e985"
}

Get Wallets Request

{
   "command":"get_wallets",
   "data":{

   },
   "ack":false,
   "origin":"wallet_ui",
   "destination":"wave_wallet",
   "request_id":"4d7b85295b031a6388274ebce3c202204e717feb14ce5a524110726f31c38f9e"
}

Get Height Request

{
   "command":"get_height_info",
   "data":{

   },
   "ack":false,
   "origin":"wallet_ui",
   "destination":"wave_wallet",
   "request_id":"88169c9f04bb0a81acec27f3f70e8e5160c8d84e7d06c0c6cb4b57c4678b19aa"
}

Get Sync status Request

{
   "command":"get_sync_status",
   "data":{

   },
   "ack":false,
   "origin":"wallet_ui",
   "destination":"wave_wallet",
   "request_id":"f1eea6a4a4ebf6ba5bb19dc61ccc57c0016be5535290b8a610e0ee1d746b68ca"
}

Get Latest Challenges Request

{
   "command":"get_latest_challenges",
   "data":{

   },
   "ack":false,
   "origin":"wallet_ui",
   "destination":"wave_farmer",
   "request_id":"33fef2f4f1bdaaed18bd0fac45c5538ae628007b9a2da2476afd971f022d2b88"
}

Get Plots Request

{
   "command":"get_plots",
   "data":{

   },
   "ack":false,
   "origin":"wallet_ui",
   "destination":"wave_harvester",
   "request_id":"b00eb9765d2dbae40269c665395a9aab5628342b2c4757277b0d1848faef1c08"
}

Get Plot Directories Request

 {
   "command":"get_plot_directories",
   "data":{
   },
   "ack":false,
   "origin":"wallet_ui",
   "destination":"wave_harvester",
   "request_id":"7000b8264631d7adac9d9a2600d27e6e9a7e090764dfdec62417ae966c985c66"
}

Get All Trades Request

{
   "command":"get_all_trades",
   "data":{

   },
   "ack":false,
   "origin":"wallet_ui",
   "destination":"wave_wallet",
   "request_id":"ff11c8cadb239734d531fbd7a2894727b6fc491abfd5cd8b3e6472ddf50741de"
}

Get Wallet Balance Request

{
   "command":"get_wallet_balance",
   "data":{
      "wallet_id":1
   },
   "ack":false,
   "origin":"wallet_ui",
   "destination":"wave_wallet",
   "request_id":"96715addaa74c7ab02cf43fe9a49de7750ba7b9aa61b39ecf5e15b0761477f0c"
}

Send Transaction Request

{
   "command":"send_transaction",
   "data":{
      "wallet_id":1,
      "amount":1000000000000,
      "fee":0,
      "address":"hex"
   },
   "ack":false,
   "origin":"wallet_ui",
   "destination":"wave_wallet",
   "request_id":"5ba0b059432652937380950e565bc74b882cdfb1bbe116633734e35cb920fce6"
}

Example Response

{
   "ack":true,
   "command":"send_transaction",
   "data":{
      "error":"Can't select amount higher than our spendable balance.  Amount: 23000000000000, spendable:  0",
      "success":false
   },
   "destination":"wallet_ui",
   "origin":"wave_wallet",
   "request_id":"0253690b99c7088d87f797d3956fbbe7c06530cec5aec50f34a92d9a525d7d8c"
}

Get Transaction

{
   "command":"get_transactions",
   "data":{
      "wallet_id":1
   },
   "ack":false,
   "origin":"wallet_ui",
   "destination":"wave_wallet",
   "request_id":"b16da699e8cb05a7d03b813d7815647804f22c46075858c3398d9da93946bbc2"
}

Get Next Address Request

{
   "command":"get_next_address",
   "data":{
      "wallet_id":1
   },
   "ack":false,
   "origin":"wallet_ui",
   "destination":"wave_wallet",
   "request_id":"b7deaf2ba7690725a249b8bbc3f861d384180f5d461d1fbbc8b7da30638b1f9e"
}

Generate Mnemonic Request

{
   "command":"generate_mnemonic",
   "data":{

   },
   "ack":false,
   "origin":"wallet_ui",
   "destination":"wave_wallet",
   "request_id":"e2e83e2d3bcb75b074a35c4d42a238119e5d554c349cec1531645870e9e6dc48"
}

Mnemmonic Example Response

{
   "ack":false,
   "command":"generate_mnemonic",
   "data":{
      "mnemonic":[
         "diamond",
         "vital",
         "belt",
         "traffic",
         "arrive",
         "quarter",
         "success",
         "dance",
         "alone",
         "lonely",
         "idle",
         "slice",
         "light",
         "cherry",
         "palace",
         "fold",
         "sort",
         "involve",
         "option",
         "prevent",
         "defy",
         "open",
         "soon",
         "shrimp"
      ],
      "success":false
   },
   "destination":"wallet_ui",
   "origin":"wave_wallet",
   "request_id":"e2e83e2d3bcb75b074a35c4d42a238119e5d554c349cec1531645870e9e6dc48"
}

Add Key Request

{
   "command":"add_key",
   "data":{
      "mnemonic":[
         "diamond",
         "vital",
         "belt",
         "traffic",
         "arrive",
         "quarter",
         "success",
         "dance",
         "alone",
         "lonely",
         "idle",
         "slice",
         "light",
         "cherry",
         "palace",
         "fold",
         "sort",
         "involve",
         "option",
         "prevent",
         "defy",
         "open",
         "soon",
         "shrimp"
      ],
      "type":"new_wallet",
      "file_path":"None"
   },
   "ack":false,
   "origin":"wallet_ui",
   "destination":"wave_wallet",
   "request_id":"4b7c8ea7fe05b7137127743261139fd19905dd266d8adcc9387a46b26fc9cea0"
}

Add key Example Response

{
   "ack":true,
   "command":"add_key",
   "data":{
      "success":true
   },
   "destination":"wallet_ui",
   "origin":"wave_wallet",
   "request_id":"4b7c8ea7fe05b7137127743261139fd19905dd266d8adcc9387a46b26fc9cea0"
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment