Skip to content

Releases: dfinity/ic-js

2024.05.14-0630Z

14 May 06:30
73d4473
Compare
Choose a tag to compare

Overview

The current status of the libraries at the time of the release is as follows:

Library Version Status
@dfinity/ckbtc v2.3.3 Maintained ⚙️
@dfinity/cketh v3.0.1 Maintained ⚙️
@dfinity/cmc v3.0.5 Maintained ⚙️
@dfinity/ic-management v4.0.0 Breaking Changes ⚠️
@dfinity/ledger-icp v2.2.4 Maintained ⚙️
@dfinity/ledger-icrc v2.3.1 Maintained ⚙️
@dfinity/nns v5.1.0 Enhanced 🔧
@dfinity/nns-proto v2.0.0 Breaking Changes ⚠️
@dfinity/sns v3.0.4 Maintained ⚙️
@dfinity/utils v2.3.0 Enhanced 🔧

Breaking changes

  • @dfinity/ic-management function canisterInfo removed because users cannot call this method (see documentation).
  • @dfinity/nns-proto was updated with the most recent proto types, some of which were not backwards compatible.
  • The size of the nns-proto-js library has noticeably increased, as it now exposes all types instead of just a manually picked subset.

Features

  • Update Candid definition in ckBTC, ckETH, CMC, ICP and ICRC Ledgers, Nns and Sns.
  • Add "Subnet Rental" to the list of NnsFunction and to topic support.

Build

  • Upgrade agent-js dependencies to v1.3.0 and revert the default retry times value to 10, given that the issue is fixed.

2024.04.29-0930Z

29 Apr 09:29
8513d59
Compare
Choose a tag to compare

Overview

The current status of the libraries at the time of the release is as follows:

Library Version Status
@dfinity/ckbtc v2.3.2 Maintained ⚙️
@dfinity/cketh v3.0.0 Breaking Changes ⚠️
@dfinity/cmc v3.0.4 Maintained ⚙️
@dfinity/ic-management v3.2.0 Enhanced 🔧
@dfinity/ledger-icp v2.2.3 Maintained ⚙️
@dfinity/ledger-icrc v2.3.0 Enhanced 🔧
@dfinity/nns v5.0.0 Breaking Changes ⚠️
@dfinity/nns-proto v1.0.2 Unchanged️
@dfinity/sns v3.0.3 Maintained ⚙️
@dfinity/utils v2.2.0 Enhanced 🔧

Breaking changes

  • Protocol buffers for hardware wallet transactions are no longer supported. Internet Computer Ledger app 2.4.9 or later is now required.
  • GovernanceCanister.listNeurons no longer throws an error when called with certified: false for hardware wallet transactions.
  • Potential errors thrown by withdrawEth provide now unparsed details.

Features

  • ICP transactions, as provided by the Index canister, have been extended to include their block timestamp information.
  • When no fee is specified when making an ICP transaction, use the mandatory fee of 10000 e8s (0.0001 ICP) instead of fetching the fee from the network.
  • Remove hardware wallet specific code paths from @dfinity/ledger-icp.
  • Remove hardware wallet specific options from LedgerCanister.
  • Remove dependency on @dfinity/nns-proto from @dfinity/ledger-icp.
  • Remove hardware wallet specific code and @dfinity/nns-proto dependency from @dfinity/nns.
  • Add support for withdrawErc20.
  • Additional fields related to ERC20 have been added to ckETH minterInfo.
  • Expose the function ledger_id for Index canister in the ledger-icrc library.
  • Set number of retries to 10 (as opposed to default 3) in createAgent utility to make the agent more resilient against watermark check failures.

Build

  • Upgrade agent-js dependencies to v1.2.1. Note that it is advised to set the number of retries of the agent to 10 to prevent the potential issue Timestamp failed to pass the watermark after retrying the configured 3 times. We cannot guarantee the integrity of the response since it could be a replay attack. (see thread on the forum).
  • Upgrade didc to 0.3.7 that converts candid files into JS and TS.

2024.03.25-1430Z

25 Mar 14:24
1d80864
Compare
Choose a tag to compare

Overview

The current status of the libraries at the time of the release is as follows:

Library Version Status
@dfinity/ckbtc v2.3.1 Unchanged️️
@dfinity/cketh v2.0.1 Unchanged️
@dfinity/cmc v3.0.3 Unchanged️
@dfinity/ic-management v3.1.1 Patched 🩹
@dfinity/ledger-icp v2.2.2 Unchanged️️
@dfinity/ledger-icrc v2.1.1 Unchanged️️
@dfinity/nns v4.0.2 Unchanged️
@dfinity/nns-proto v1.0.2 Unchanged️
@dfinity/sns v3.0.2 Unchanged️️
@dfinity/utils v2.1.3 Unchanged️

Fix

  • Incorrect import path to utils in ic-management: @dfinity/utils/src.

2024.03.25-1345Z

25 Mar 13:45
86062f2
Compare
Choose a tag to compare

Overview

The current status of the libraries at the time of the release is as follows:

Library Version Status
@dfinity/ckbtc v2.3.1 Maintained ⚙️
@dfinity/cketh v2.0.1 Maintained ⚙️
@dfinity/cmc v3.0.3 Maintained ⚙️
@dfinity/ic-management v3.1.0 Enhanced 🔧
@dfinity/ledger-icp v2.2.2 Maintained ⚙️
@dfinity/ledger-icrc v2.1.1 Maintained ⚙️
@dfinity/nns v4.0.2 Maintained ⚙️
@dfinity/nns-proto v1.0.2 Maintained ⚙️
@dfinity/sns v3.0.2 Maintained ⚙️
@dfinity/utils v2.1.3 Maintained ⚙️

Features

  • Support for the installation of large canisters with chunked code of the Wasm module in @dfinity/ic-management.
  • Update most recent did files for ledgers (new optional field for initialization) and ckETH (new optional field in event).
  • Expose Utxo types in @dfinity/ckbtc.

Build

  • Bump dev dependencies including esbuild and TypeScript.

Documentation

  • Bump tsdoc-markdown to parse optional result into READMEs.

2024.03.05-1130Z

05 Mar 11:27
5a7f21d
Compare
Choose a tag to compare

Overview

The current status of the libraries at the time of the release is as follows:

Library Version Status
@dfinity/ckbtc v2.3.0 Enhanced 🔧️
@dfinity/cketh v2.0.0 Breaking Changes ⚠️
@dfinity/cmc v3.0.2 Unchanged️
@dfinity/ic-management v3.0.0 Breaking Changes ⚠️
@dfinity/ledger-icp v2.2.1 Unchanged️
@dfinity/ledger-icrc v2.1.3 Enhanced 🔧
@dfinity/nns v4.0.1 Unchanged️
@dfinity/nns-proto v1.0.1 Unchanged️
@dfinity/sns v3.0.1 Maintained ⚙
@dfinity/utils v2.1.2 Unchanged️

Breaking Changes

  • Fix typo in ic-management interfaces (senderCanisterVerion -> senderCanisterVersion).
  • ckETH eip1559TransactionPrice expect a parameters which can optionally be set to execute a query (new) or update call.

Features

  • Support for new ckETH endpoint get_minter_info which returns internal minter parameters such as the minimal withdrawal amount, the last observed block number, etc.
  • Add support for bitcoin_get_utxos and bitcoin_get_utxos_query features to @dfinity/ic-management library.
  • Support for new ckBTC endpoint get_known_utxos which returns UTXOs of the given account known by the minter.
  • New IndexNgCanister in @dfinity/ledger-icrc, which can be used to interact with the newer version of the ICRC Index canister, notably exposing getTransactions as a query function.

2024.02.21-0835Z

21 Feb 08:37
b037fe1
Compare
Choose a tag to compare

Overview

The current status of the libraries at the time of the release is as follows:

Library Version Status
@dfinity/ckbtc v2.2.1 Maintained ⚙️
@dfinity/cketh v1.0.2 Maintained ⚙️
@dfinity/cmc v3.0.2 Maintained ⚙️
@dfinity/ic-management v2.2.2 Maintained ⚙️
@dfinity/ledger-icp v2.2.1 Maintained ⚙️
@dfinity/ledger-icrc v2.1.3 Maintained ⚙️
@dfinity/nns v4.0.1 Maintained ⚙️
@dfinity/nns-proto v1.0.1 Unchanged️
@dfinity/sns v3.0.0 Breaking Changes ⚠️
@dfinity/utils v2.1.2 Maintained ⚙️

Breaking changes

  • Update listProposals return type in sns governance canister.

Build

  • Bump agent-js v1.0.1 to hook on their semantic versioning, adopt last improvements and rollout a security patch.

2024.02.14-1600Z

14 Feb 15:56
5b3ee2b
Compare
Choose a tag to compare

Overview

The current status of the libraries at the time of the release is as follows:

Library Version Status
@dfinity/ckbtc v2.2.0 Enhanced 🔧
@dfinity/cketh v1.0.1 Maintained ⚙️
@dfinity/cmc v3.0.1 Maintained ⚙️
@dfinity/ic-management v2.2.1 Maintained ⚙️
@dfinity/ledger-icp v2.2.0 Enhanced 🔧
@dfinity/ledger-icrc v2.1.2 Maintained ⚙️
@dfinity/nns v4.0.0 Breaking Changes ⚠️
@dfinity/nns-proto v1.0.1 Unchanged️
@dfinity/sns v2.1.2 Maintained ⚙️
@dfinity/utils v2.1.1 Maintained ⚙️

Breaking changes

  • Replace duplicate string type AccountIdentifier in @dfinity/nns with AccountIdentifierHex of @dfinity/ledger-icp.

Features

  • Extend ckBTC retrieveBtcStatusV2ByAccount with optional account parameter.
  • Remove unused Uint8Array type SubAccount in @dfinity/nns.
  • Modify the @dfinity/ledger-icp package's SubAccount.formID function to support more than 256 subaccounts, enabling it to handle larger numbers.

Build

  • Bump all dev dependencies of the ic-js workspace.

2024.01.30-1600Z

30 Jan 16:00
76a76d8
Compare
Choose a tag to compare

Overview

The current status of the libraries at the time of the release is as follows:

Library Version Status
@dfinity/ckbtc v2.1.1 Patched 🩹
@dfinity/cketh v1.0.0 Launched 🚀
@dfinity/cmc v3.0.0 Breaking Changes ⚠️
@dfinity/ic-management v2.2.0 Enhanced 🔧
@dfinity/ledger-icp v2.1.2 Patched 🩹
@dfinity/ledger-icrc v2.1.1 Maintained ⚙️
@dfinity/nns v3.1.1 Maintained ⚙️
@dfinity/nns-proto v1.0.1 Maintained ⚙️
@dfinity/sns v2.1.1 Patched 🩹
@dfinity/utils v2.1.0 Enhanced 🔧

Breaking changes

  • Upgrade candid files for cmc canister with new fields subnet_selection and settings.

Features

  • Add support for converting ckETH to ETH through the withdrawEth function and integrate useful features such as eip1559TransactionPrice, encodePrincipalToEthAddress, and retrieve_eth_status.
  • Upgrade candid files for ic-management canister and support new field reserved_cycles_limit.
  • Add "API Boundary Node Management" topic support.
  • Add optional field logo to Token type.
  • Update sns-js candid files with new fields in sns canisters.
  • Add public method toE8s to TokenAmountV2.

Fix

  • Various certified Candid IDL functions had their names trimmed of the keyword "query".

Build

  • Fixed script to generate certified IDL factory files to respect the keyword "query" when used in functions' names.

2024.01.09-1115Z

09 Jan 11:32
0241480
Compare
Choose a tag to compare

Overview

The current status of the libraries at the time of the release is as follows:

Library Version Status
@dfinity/ckbtc v2.1.0 Unchanged
@dfinity/cketh v0.0.1 Unchanged
@dfinity/cmc v2.1.0 Unchanged
@dfinity/ic-management v2.1.0 Unchanged
@dfinity/ledger-icp v2.1.1 Patched 🤕
@dfinity/ledger-icrc v2.1.0 Unchanged
@dfinity/nns v3.1.0 Unchanged
@dfinity/nns-proto v1.0.0 Unchanged
@dfinity/sns v2.1.0 Unchanged
@dfinity/utils v2.0.0 Unchanged️

Fix

  • When @dfinity/ledger-icp is bundled with Rollup v4, it leads to an incompatibility issue with iOS 15.

2024.01.03-1115Z

03 Jan 11:20
9009305
Compare
Choose a tag to compare

Overview

The current status of the libraries at the time of the release is as follows:

Library Version Status
@dfinity/ckbtc v2.1.0 Unchanged
@dfinity/cketh v0.0.1 New 🚀
@dfinity/cmc v2.1.0 Unchanged
@dfinity/ic-management v2.1.0 Unchanged
@dfinity/ledger-icp v2.1.0 Unchanged
@dfinity/ledger-icrc v2.1.0 Unchanged
@dfinity/nns v3.1.0 Unchanged
@dfinity/nns-proto v1.0.0 Unchanged
@dfinity/sns v2.1.0 Unchanged
@dfinity/utils v2.0.0 Unchanged️

Features

  • Introduces an early first version of @dfinity/cketh, which is meant to provide functions for interfacing with ckETH. The library doesn't do much at the moment, but we're releasing it to integrate it into our pipelines, and features will be added iteratively as required.