cactus-agent

cactus-agent

cactus rpc/websocket client library for NodeJS.
Supports all RPC/Websocket API available at cactus 2.0.0.
(If you need previous version, search for the corresponding release here)

you can develop your own nodejs script with cactus-agent to:

• retrieve latest data from RPC servers like farmer, harvester, full_node, wallet, pool, data_layer, crawler.
• send email when proof is found.
• trigger scripts when target event is observed.
• start/stop services.
• write program to schedule plotting with javascript.
• etc, etc, etc

Install

npm install cactus-agent
# or
yarn add cactus-agent

Compatibility

This code is compatible with:

• dc46f46b9a30628b208d38fd7dd0ca085e820781 of cactus-blockchain 2.0.0
  • Diff to the main branch of cactus-blockchain
• 6c1c7ecd2ed7307760d1673dc2b1057f22e08fd5 of pool-reference
  • Diff to the main branch of pool-reference

API

There are 2 kinds of APIs in cactus.
RPC API and Websocket API.

RPC API

RPC API is used to send message directly to cactus services like farmer, harvester, full_node, wallet, data_layer, crawler.

RPC API is just an async function in a traditional request/response style.

const {RPCAgent, setLogLevel} = require("cactus-agent");
const {get_plots} = require("cactus-agent/api/rpc");
setLogLevel("debug");

const agent = new RPCAgent({
  service: "harvester",
});

const res = await get_plots(agent);
console.log(res.plots[0]);

/*
// sample output
{
  file_size: 108875876912,
  filename: 'M:\\plot-k32-yyyy-mm-dd-xx-xx-xxxxxxxxxxxxxxxxxxxxxxxxx.plot',
  plot_id: '...',
  plot_public_key: '0x934a93489...',
  pool_contract_puzzle_hash: null,
  pool_public_key: '0xb0aa9485c0d...',
  size: 32,
  time_modified: 1619540745
}
*/

// Or you can request RPC API via daemon websocket like this
const {getDaemon, setLogLevel} = require("cactus-agent");
const {get_plots} = require("cactus-agent/api/rpc");
const daemon = getDaemon();
await daemon.connect(); // connect to local daemon using config file.
const res = await get_plots(daemon);

Websocket API

Websocket API is used to connect to cactus daemon.

With websocket API, you can request cactus daemon to start/stop plotting or other services,
or capture various broadcast messages like:

• Plotting progress
• Farming info such as passed filter, proofs found, etc.

const {getDaemon, setLogLevel} = require("cactus-agent");
const {on_new_farming_info} = require("cactus-agent/api/ws");

setLogLevel("debug");

const daemon = getDaemon();
await daemon.connect(); // connect to local daemon using config file.
const unsubscribe = await on_new_farming_info(daemon, (e) => {
  console.log(e.data);
})

setTimeout(async () => {
  unsubscribe(); // Stop capturing message
  daemon.close();
}, 30*1000); // Disconnect after 30s passed.

/*
// sample output
{
  farming_info: {
    challenge_hash: '0x07228cf04e8877797adc1e0605018007def282548f009564b00286886e23e88b',
    passed_filter: 0,
    proofs: 0,
    signage_point: '0xfe1272a8e6659c0a3875cac37f8b170f1f85d47fecfee36d825dfae0b2a73a31',
    timestamp: 1621255822,
    total_plots: 299
  },
  success: true
}
 */

API Reference

See Documentation here

Examples

See documentation here

Here are some of those examples

• Send email when proof is found
• RPC API code sample to show block record in certain height
• Create multiple plots with javascript

Build from source

Once source files is build by npm run build:prod, files will be output to /dist directory.
Then the files/directories are published to npm registry.
Please note it does not upload files in project root to npm registry, but files inside '/dist'.

Read details here

Donation

For continuous development, please support me with donation cac1wr8g2k7cn55xvepmg480dsu2xhf4rz5ezghwwapulj7jxqcz9ztqqclwdj