Home

chia-daemon

Node.js CI CodeQL

NPM

A JS client for chia daemon with dynamically generated end points

Getting Started

npm install
npm test

Documention

https://dkackman.github.io/chia-daemon/

Basic Usage

Each service is a field on the services property of the ChiaDaemon.

  • Since all service calls go through the daemon there is no need for other endpoint configuration
  • All RPC calls are async
  • Since all rpc call are dyanmically invoked there is no need to update the library with new chia release. (i.e. if you invoke daemon.wallet.foo() it will call make an RPC to a function named foo at that endpoint and error if it doesn't exist there)
import loadUIConfig from 'config'
import { ChiaDaemon } from 'chia-daemon';

const daemon = new ChiaDaemon(loadUIConfig(), 'my-chia-app');
const connected = await daemon.connect();
if (connected) {
    const state = await daemon.services.full_node.get_blockchain_state();
    console.log(state);
}

Payload Helpers

Includes helper functions to get request payloads right:

Get the OpenAPI responseBody Schema Descriptor

console.log(daemon.full_node.getPayloadDescriptor('open_connection'));

{
  type: 'object',
  required: [ 'ip', 'port' ],
  properties: {
    ip: { type: 'string', format: 'ipaddress' },
    port: { type: 'integer' }
  }
}

Get a Payload Object Instance

const connection = daemon.full_node.makePayload('open_connection');
console.log(payload);
{ ip: '', port: 0 }
connection.ip = 'chia.net';
connection.port = 4444;

await daemon.full_node.open_connection(connection);