chia-agent
v14.4.0
Published
chia rpc/websocket client library
Downloads
3,429
Maintainers
Readme
chia-agent
chia rpc/websocket client library for NodeJS.
Supports all RPC/Websocket API available at 2.4.4
of chia-blockchain
.
(If you need previous version, search for the corresponding release here)
you can develop your own nodejs script with chia-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 chia-agent
# or
yarn add chia-agent
Compatibility
This code is compatible with:
39739520211670d398173f87cd1e97c755274195
of chia-blockchain 2.4.454fffb4968364640b4f5dd18d586821e67eaa631
of pool-referencec6cd98f637f07e60f68203c4c27b8cf3a559ae9b
of chia_rs 0.14.0
API
There are 2 kinds of APIs in chia.RPC API
and Websocket API
.
RPC API
RPC API is used to send message directly to chia 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("chia-agent");
const {get_plots} = require("chia-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("chia-agent");
const {get_plots} = require("chia-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 chia daemon
.
With websocket API, you can request chia 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("chia-agent");
const {on_new_farming_info} = require("chia-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
Examples
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'.
Donation
For continuous development, please support me with donation
xch1wr8g2k7cn55xvepmg480dsu2xhf4rz5ezghwwapulj7jxqcz9ztqqclwdj