v14.0.0

Compatibility

This code is compatible with:

• b98219687331fc6c8121d0c0243a49d2427ccd60 of chia-blockchain 2.2.1
  • Diff to the main branch of chia-blockchain
• fc641b915d95ca00f33c268f820cee196c61ca65 of pool-reference
  • Diff to the main branch of pool-reference

Breaking change

• When RPC API responds with success: false, its Promise now does reject. (Previously it does resolve)
• At chia-blockchain@2.2.1, in chia/consensus/cost_calculator.py,
  NPCResult.cost was removed.
  As a result, the RPC APIs below might be incompatible between 2.1.4 and 2.2.1.
  • get_all_mempool_items Of FullNode RPC API
  • get_mempool_item_by_tx_id Of FullNode RPC API

Changed

• Loosened a type of agent to call RPC APIs. RPC APIs can be invoked with agent which just implements
  sendMessage method depicted as below.

export interface APIAgent {
  sendMessage<M extends unknown>(
          destination: string,
          command: string,
          data?: Record<string, unknown>,
  ): Promise<M>;
}

• sp_source_data was added to NewSignagePoint
  As a result the following API responses were affected
  • on_signage_point
  • on_new_signage_point
• include_signature_source_data was added to DeclareProofOfSpace
  As a result the following API responses were affected
  • on_proof
• foliage_block_data, foliage_transaction_block_data and rc_block_unfinished were added to RequestSignedValues
• eligible_for_fast_forward was added to BundleCoinSpend
• CHIP_0002_P2_DELEGATED_CONDITIONS was added to SigningMode
  As a result the following API responses were affected
  • verify_signature
  • sign_message_by_address
  • sign_message_by_id
• Wallet RPC API
  • get_notifications
    • The types of request parameters were slightly changed
      • ids are now bytes32[] (previously str[])
      • start are now uint32 (previously int[])
      • end are now uint32 (previously int[])
    • The types of response parameters were slightly changed
      • id are now bytes32 (previously str)
      • message are now bytes (previously str)
  • get_offer_summary
    • The following properties were added to the response parameters
      • additions: str[]
      • removals: str[]
  • nft_get_info
    • The following properties were removed from the response parameters
      • ignore_size_limit

Added

• Added connectivity options for RPCAgent.
  • keepAlive (default: true)
  • keepAliveMsecs (default: 1000)
  • maxSockets (default: Infinity)
  • timeout (default: undefined)

// Usage
const {RPCAgent} = require("chia-agent");
const {get_plots} = require("chia-agent/api/rpc");

const agent = new RPCAgent({
  service: "harvester",
  keepAlive: true,
  keepAliveMsecs: 3000,
  maxSockets: 1, // Avoid to set `1` if your requests may be sent in parallel.
  timeout: 5000,
});
const res = await get_plots(agent);

• Added httpsAgent, httpAgent option for RPCAgent.
  You can now configure and inject your own require('https').Agent into RPCAgent.

// Usage
const {Agent: HttpsAgent} = require("https"); // or const {Agent: HttpAgent} = require('http');
const {RPCAgent} = require("chia-agent");
const {get_plots} = require("chia-agent/api/rpc");

const httpsAgent = new HttpsAgent({
  host: "localhost",
  port: 8560,
  ca: ...,
  cert: ...,
  key: ...,
  rejectUnauthorized: false,
});
const agent = new RPCAgent({httpsAgent: httpsAgent}); // `new RPCAgent({httpAgent: httpAgent});` is also allowed.
const res = await get_plots(agent);

• DataLayer RPC API
  • get_proof
  • verify_proof
• FullNode RPC API
  • get_aggsig_additional_data
• Wallet RPC API
  • dl_verify_proof

Fixed

• Fixed an issue where some of the RPC Pool APIs did not handle request parameters correctly.
• Added missing attribute peak_height to NewSignagePoint