Exposing RPC interface

If you are developing a service on Obyte and your programming language is node.js, your best option is to just require() the ocore modules that you need.

For exchanges and other custody wallets, there is a specialized JSON RPC service. However it is limited and exposes only those functions that the exchanges need.
If you are developing a service on Obyte and your programming language is node.js, your best option is to just require() the ocore modules that you need (most likely you need headless-obyte and various modules inside ocore). This way, you'll also be running a Obyte node in-process.
If you are programming in another language, or you'd like to run your Obyte node in a separate process, you can still access many of the functions of headless-obyte and ocoreby creating a thin RPC wrapper around the required functions and then calling them via JSON-RPC.
Get started
To get started, we can add RPCify to existing project or directly to headless-obyte with this command:
1
npm install https://github.com/byteball/rpcify.git
Copied!
See the documentation about RPCify for more details.
Exposing functions and events
To expose the required functions via JSON-RPC, create a project that has headless-obyte, ocore (and any other ocore modules) and RPCify as dependencies:
1
var rpcify = require('rpcify');
2
var eventBus = require('ocore/event_bus.js');
3
​
4
// this is a module whose methods you want to expose via RPC
5
var headlessWallet = require('headless-obyte'); // when headless-obyte is dependency of your project
6
//var headlessWallet = require('../start.js'); // when this script is in headless-obyte tools folder
7
var balances = require('ocore/balances.js'); // another such module
8
​
9
// most of these functions become available only after the passphrase is entered
10
eventBus.once('headless_wallet_ready', function(){
11
	// start listening on RPC port
12
	rpcify.listen(6333, '127.0.0.1');
13
​
14
	// expose some functions via RPC
15
	rpcify.expose(headlessWallet.issueChangeAddressAndSendPayment);
16
	rpcify.expose(balances.readBalance, true);
17
	rpcify.expose(balances.readAllUnspentOutputs);
18
	rpcify.expose([
19
		headlessWallet.readFirstAddress,
20
		headlessWallet.readSingleWallet,
21
		headlessWallet.issueOrSelectAddressByIndex
22
	], true);
23
​
24
	// expose some events 
25
	rpcify.exposeEvent(eventBus, "my_transactions_became_stable");
26
	rpcify.exposeEvent(eventBus, "new_my_transactions");
27
});
Copied!
Calling with HTTP requests
From another Node.js app, calling the function would look something like this:
1
var rpc    = require('json-rpc2');
2
var client = rpc.Client.$create(6333, '127.0.0.1');
3
​
4
client.call('issueChangeAddressAndSendPayment', [asset, amount, to_address, device_address], function(err, unit) {
5
    ...
6
});
Copied!
Listening via WebSockets
From another Node.js app, sending function calls and listening to events would look something like this:
1
var WebSocket = require('ws');
2
var ws        = new WebSocket("ws://127.0.0.1:6333");
3
​
4
ws.on('open', function onWsOpen() {
5
	console.log("ws open");
6
	ws.send(JSON.stringify({
7
		"jsonrpc":"2.0",
8
		"id":1,
9
		"method":"readBalance",
10
		"params":["LUTKZPUKQJDQMUUZAH4ULED6FSCA2FLI"]
11
	})); // send a command
12
});
13
​
14
ws.on('error', function onWsError(e){
15
	console.log("websocket error"+e);
16
})
17
​
18
ws.on('message', function onWsMessage(message){ // JSON responses
19
	console.error(message);
20
	// {"jsonrpc":"2.0","result":{"base":{"stable":0,"pending":0}},"error":null,"id":1} // response to readBalance
21
  // {"event":"my_transactions_became_stable","data":[["1pLZa3aVicNLE6vcClG2IvBe+tO0V7kDsxuzQCGlGuQ="]]} // event my_transactions_became_stable
22
});
Copied!

JSON-RPC

Running RPC service

Last modified 1yr ago

Export as PDF

Copy link

Contents

Get started

Exposing functions and events

Calling with HTTP requests

Listening via WebSockets