Releases: dfinity/ic-js
2024.10.09-1140Z
Overview
The current status of the libraries at the time of the release is as follows:
Library | Version | Status |
---|---|---|
@dfinity/ckbtc |
v3.1.1 | Maintained ⚙️ |
@dfinity/cketh |
v3.3.2 | Maintained ⚙️ |
@dfinity/cmc |
v3.2.2 | Maintained ⚙️ |
@dfinity/ic-management |
v5.2.2 | Maintained ⚙️ |
@dfinity/ledger-icp |
v2.6.1 | Maintained ⚙️ |
@dfinity/ledger-icrc |
v2.6.1 | Maintained ⚙️ |
@dfinity/nns |
v7.0.1 | Maintained ⚙️ |
@dfinity/nns-proto |
v2.0.1 | Unchanged️ |
@dfinity/sns |
v3.2.2 | Maintained ⚙️ |
@dfinity/utils |
v2.5.2 | Maintained ⚙️ |
Build
- Downgrade Agent-js to
^2.0.0
to let consumers pick the compatible version they wish to use.
2024.09.30-1100Z
Overview
The current status of the libraries at the time of the release is as follows:
Library | Version | Status |
---|---|---|
@dfinity/ckbtc |
v3.1.0 | Enhanced 🔧️ |
@dfinity/cketh |
v3.3.1 | Maintained ⚙️ |
@dfinity/cmc |
v3.2.1 | Maintained ⚙️ |
@dfinity/ic-management |
v5.2.1 | Maintained ⚙️ |
@dfinity/ledger-icp |
v2.6.0 | Enhanced 🔧️ |
@dfinity/ledger-icrc |
v2.6.0 | Enhanced 🔧️ |
@dfinity/nns |
v7.0.0 | Breaking Changes |
@dfinity/nns-proto |
v2.0.1 | Unchanged️ |
@dfinity/sns |
v3.2.1 | Maintained ⚙️ |
@dfinity/utils |
v2.5.0 | Maintained ⚙️ |
Breaking changes
- Removed deprecated
OpenSnsTokenSwap
,SetSnsTokenSwapOpenTimeWindow
, andSetDefaultFollowees
fromProposalActionRequest
.
Features
- Add support for
icrc21_canister_call_consent_message
to@dfinity/ledger-icp
and@dfinity/ledger-icrc
. - Add support for
"regtest"
inBitcoinNetwork
. - Expose
ledger-converters
utility modules in@dfinity/ledger-icp
and@dfinity/ledger-icrc
.
Build
- Incorporate Agent-js patch
v2.1.2
.
2024.09.02-0830Z
Overview
The current status of the libraries at the time of the release is as follows:
Library | Version | Status |
---|---|---|
@dfinity/ckbtc |
v3.0.0 | Breaking Changes |
@dfinity/cketh |
v3.3.0 | Maintained ⚙️ |
@dfinity/cmc |
v3.2.0 | Maintained ⚙️ |
@dfinity/ic-management |
v5.2.0 | Maintained ⚙️ |
@dfinity/ledger-icp |
v2.5.0 | Maintained ⚙️ |
@dfinity/ledger-icrc |
v2.5.0 | Maintained ⚙️ |
@dfinity/nns |
v6.0.0 | Breaking Changes |
@dfinity/nns-proto |
v2.0.1 | Maintained ⚙️️ |
@dfinity/sns |
v3.2.0 | Maintained ⚙️ |
@dfinity/utils |
v2.5.0 | Maintained ⚙️ |
Breaking changes
- Rename values of enum Topic and NnsFunction to match the backend values.
- Use different request/response types for NNS Governance proposals, and different fields for
InstallCode
proposals. - The
getUtxos
parameterfilter.min_confirmations
has been renamed tofilter.minConfirmations
for consistency with the general naming conventions used in@dfinity/ckbtc
. - Only queries to
getUtxos
of the Bitcoin canister can be executed by external users — i.e., update calls can only be performed by the canister. This is whygetUtxos
now only supports non-certified calls and has been renamed togetUtxosQuery
.
Features
- Provide a new utility to convert Candid
Nat
toBigInt
. This utility is useful for interpreting the fees provided by the SNS Aggregator. - Support conversion of
InstallCode
,StopOrStartCanister
andUpdateCanisterSettings
actions,SetVisibility
neuron operation, andNeuron::visibility
attribute. - Add function
getBalanceQuery
toBitcoinCanister
object of package@dfinity/ckbtc
, that implements thebitcoin_get_balance_query
method of the IC Bitcoin API.
Build
- Upgrade
agent-js
dependencies tov2.0.0
.
2024.07.22-0645Z
Overview
The current status of the libraries at the time of the release is as follows:
Library | Version | Status |
---|---|---|
@dfinity/ckbtc |
v2.5.0 | Maintained ⚙️ |
@dfinity/cketh |
v3.2.0 | Enhanced 🔧️ |
@dfinity/cmc |
v3.1.0 | Maintained ⚙️ |
@dfinity/ic-management |
v5.1.0 | Enhanced 🔧️ |
@dfinity/ledger-icp |
v2.4.0 | Maintained ⚙️ |
@dfinity/ledger-icrc |
v2.4.0 | Maintained ⚙️ |
@dfinity/nns |
v5.2.0 | Enhanced 🔧️ |
@dfinity/nns-proto |
v2.0.1 | Maintained ⚙️️ |
@dfinity/sns |
v3.1.0 | Maintained ⚙️ |
@dfinity/utils |
v2.4.0 | Maintained ⚙️ |
Features
- Add support for
wasm_memory_limit
in the canister settings. - Add optional
includeEmptyNeurons
parameter tolistNeurons
. - Extend
eip1559TransactionPrice
for Erc20. - Add "Protocol Canister Management" and "Service Nervous System Management" topics support.
- Add
asNonNullish
function, likeassertNonNullish
but returns the value.
Fix
updateNeuron
to not change the neuron subaccount.list_neurons
to use oldListNeurons
type for hardware wallet compatibility.
Build
- Upgrade
agent-js
dependencies tov1.4.0
.
2024.06.11-1630Z
Overview
The current status of the libraries at the time of the release is as follows:
Library | Version | Status |
---|---|---|
@dfinity/ckbtc |
v2.4.1 | Maintained ⚙️ |
@dfinity/cketh |
v3.1.1 | Maintained ⚙️ |
@dfinity/cmc |
v3.0.7 | Maintained ⚙️ |
@dfinity/ic-management |
v5.0.1 | Maintained ⚙️ |
@dfinity/ledger-icp |
v2.3.1 | Maintained ⚙️ |
@dfinity/ledger-icrc |
v2.3.3 | Maintained ⚙️ |
@dfinity/nns |
v5.1.2 | Maintained ⚙️ |
@dfinity/nns-proto |
v2.0.1 | Maintained ⚙️️ |
@dfinity/sns |
v3.0.6 | Maintained ⚙️ |
@dfinity/utils |
v2.3.1 | Maintained ⚙️ |
Features
- Update ckETH Candid definition.
Build
- Bump braces.
2024.06.05-0835Z
Overview
The current status of the libraries at the time of the release is as follows:
Library | Version | Status |
---|---|---|
@dfinity/ckbtc |
v2.4.0 | Enhanced 🔧 |
@dfinity/cketh |
v3.1.0 | Enhanced 🔧 |
@dfinity/cmc |
v3.0.6 | Maintained ⚙️ |
@dfinity/ic-management |
v5.0.0 | Breaking Changes |
@dfinity/ledger-icp |
v2.3.0 | Enhanced 🔧 |
@dfinity/ledger-icrc |
v2.3.2 | Maintained ⚙️ |
@dfinity/nns |
v5.1.1 | Maintained ⚙️ |
@dfinity/nns-proto |
v2.0.0 | Unchanged️ |
@dfinity/sns |
v3.0.5 | Maintained ⚙️ |
@dfinity/utils |
v2.3.0 | Enhanced 🔧 |
Breaking changes
bitcoinGetUtxos
andbitcoinGetUtxosQuery
have been removed from the@dfinity/ic-management
library. Instead, usegetUtxos
from the new Bitcoin canister exposed in@dfinity/ckbtc
to access similar data.
Features
- Support for
getUtxos
endpoint in the new Bitcoin canister from@dfinity/ckbtc
. - Canister status response extended with query statistics.
- Add
metadata
function to ledger ICP. - Add optional parameters to ICP ledger
transactionFee
. - Add support for
icrc2_approve
on the ICP ledger canister in@dfinity/ledger-icp
.
2024.05.14-0630Z
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
functioncanisterInfo
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 tov1.3.0
and revert the default retry times value to 10, given that the issue is fixed.
2024.04.29-0930Z
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 theledger-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 tov1.2.1
. Note that it is advised to set the number of retries of the agent to 10 to prevent the potential issueTimestamp 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
to0.3.7
that converts candid files into JS and TS.
2024.03.25-1430Z
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
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.