Skip to content

Releases: Chia-Mine/chia-agent

v14.3.3

17 Oct 17:55
aba52b6
Compare
Choose a tag to compare

Compatibility

This code is compatible with:

Changed

  • The default service name which Daemon client tries to register is now wallet_ui.
    Previously chia_agent service and optionally wallet_ui service were registered to chia-blockchain's Daemon.

v14.3.2

11 Oct 17:22
03601a8
Compare
Choose a tag to compare

Compatibility

This code is compatible with:

Changed

  • Error logs are generated when
    • an error occurs during sending a message.
    • it receives a websocket message with unexpected format.
  • Debug logs are generated when ping/pong events are triggered.

v14.3.1

25 Sep 03:46
58856ac
Compare
Choose a tag to compare

v14.3.0

03 Sep 15:38
2f3b559
Compare
Choose a tag to compare

Compatibility

This code is compatible with:

Changed

  • Removed RpcWalletMessageOnWs since it's costly to maintain while there are a few use cases.
  • Enhanced type resolutions on Wallet RPC APIs with TXEndpointRequest

Removed

  • Removed deprecated TCreate_New_RL_WalletRequest and TCreate_New_RL_WalletResponse

Added

Fixed

v14.2.2

19 Aug 11:42
735ece0
Compare
Choose a tag to compare

Compatibility

This code is compatible with:

Changed

  • For the log which is output when success property in API response is false, the log level is now INFO instead of ERROR.

v14.2.1

04 Aug 17:37
c328aa6
Compare
Choose a tag to compare

v14.2.0

04 Jul 17:38
e50e267
Compare
Choose a tag to compare

Compatibility

This code is compatible with:

Note

  • add_private_key
    • The request parameters kc_user and kc_service is temporarily not working with 2.4.0 and 2.4.1 of
      chia-blockchain.
      This is a bug and not spec change so chia-agent stays to be able to set those params for now.

Changed

Added

Removed

Fixed

Read more

v14.1.0

21 May 18:47
6274879
Compare
Choose a tag to compare

Compatibility

This code is compatible with:

Changed

-get_network_info RPC API is now commonized and available in addition to full_node and wallet.

Added

Fixed

  • Renamed ReceiveBlockResult to AddBlockResult (type ReceiveBlockResult is still available to avoid breaking change)
  • Fixed an invalid TCreate_New_DAO_WalletRequest README location.
  • Fixed an issue where pubkey and pubhash in request of Wallet RPC API did_recovery_spend was not optional in the API doc.
  • Fixed lint errors

Removed

v14.0.0

10 Mar 18:10
0b196aa
Compare
Choose a tag to compare

Compatibility

This code is compatible with:

Breaking change

  • When RPC API responds with success: false, its Promise now does reject. (Previously it does resolve)
  • At [email protected], 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>;
}

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);

Fixed

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

v13.2.0

29 Dec 11:32
0a911ee
Compare
Choose a tag to compare

Compatibility

This code is compatible with:

Added

Changed

  • RPC Agent
    • Allow to specify host / port on instantiating RPCAgent when protocol is not specified.
    const agent = new RPCAgent({host: 'example.com', port: 8444, service: 'full_node', configPath: '...'});
  • Farmer RPC API
    • get_pool_state
      • Added new properties
        • insufficient_partials_since_start
        • insufficient_partials_24h
  • Wallet RPC API
    • select_coins
      • The types of both excluded_coins and exclude_coins were changed to Coin[] from str[].
      • Please note that both of the above properties are just kept for compatibility so don't use them unless you have
        strong reasons. Use excluded_coin_ids: str[] instead.
    • sign_message_by_address
      • Added safe_mode to request parameter
    • sign_message_by_id
      • Added safe_mode to request parameter

Fixed

  • Typo in SpendBundle: cons_spends renamed to coin_spends
  • Fixed an issue where sometimes error logs were not reported due to circular dependencies.