Releases: dfinity/ic-js
2024.03.05-1130Z
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
andbitcoin_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 exposinggetTransactions
as aquery
function.
2024.02.21-0835Z
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
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
withAccountIdentifierHex
of@dfinity/ledger-icp
.
Features
- Extend ckBTC
retrieveBtcStatusV2ByAccount
with optionalaccount
parameter. - Remove unused Uint8Array type
SubAccount
in@dfinity/nns
. - Modify the
@dfinity/ledger-icp
package'sSubAccount.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
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
andsettings
.
Features
- Add support for converting ckETH to ETH through the
withdrawEth
function and integrate useful features such aseip1559TransactionPrice
,encodePrincipalToEthAddress
, andretrieve_eth_status
. - Upgrade candid files for
ic-management
canister and support new fieldreserved_cycles_limit
. - Add "API Boundary Node Management" topic support.
- Add optional field
logo
toToken
type. - Update
sns-js
candid files with new fields in sns canisters. - Add public method
toE8s
toTokenAmountV2
.
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
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
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.
2023.12.20-1000Z
Overview
The current status of the libraries at the time of the release is as follows:
Library | Version | Status |
---|---|---|
@dfinity/ckbtc |
v2.1.0 | Enhanced 🔧 |
@dfinity/cmc |
v2.1.0 | Enhanced 🔧 |
@dfinity/ic-management |
v2.1.0 | Enhanced 🔧 |
@dfinity/ledger-icp |
v2.1.0 | Enhanced 🔧 |
@dfinity/ledger-icrc |
v2.1.0 | Enhanced 🔧 |
@dfinity/nns |
v3.1.0 | Enhanced 🔧 |
@dfinity/nns-proto |
v1.0.0 | Unchanged |
@dfinity/sns |
v2.1.0 | Enhanced 🔧 |
@dfinity/utils |
v2.0.0 | Breaking Changes |
Breaking changes
decimals
mandatory field inToken
.TokenAmount
rejects tokens withdecimals !== 8
.
Features
- Substitute
?
fields withOption
fields in the converters related to NNS proposals. - Add retrieveBtcStatus to ckbtc minter canister.
- Add retrieveBtcStatusV2ByAccount to ckbtc minter canister.
- Make uint8ArrayToHexString also accept
number[]
as input. - Add a new type TokenAmountV2 which supports
decimals !== 8
. - Fix issue when converting token amount from small numbers with
TokenAmountV2
. - Bump agent-js to v0.20.2 in a non-breaking manner by introducing
verifyQuerySignatures
as an opt-in feature (for the time being). - Replace
https://ic0.app
byhttps://icp-api.io
as the default host for the default anonymous agent provided bydefaultAgent
.
Fix
- Utilize ICP Index
accountBalance
andgetTransactions
with account identifier hex directly, eliminating the need for conversion with Buffer and resolving usage in non-polyfilled environments.
Operations
- Add a cron job to periodically update IC candid files and typescript bindings.
2023.11.21-1400Z
Overview
The current status of the libraries at the time of the release is as follows:
Library | Version | Status |
---|---|---|
@dfinity/ckbtc |
v2.0.0 | Enhanced 🔧 |
@dfinity/cmc |
v2.0.0 | Enhanced 🔧 |
@dfinity/ic-management |
v2.0.0 | Enhanced 🔧 |
@dfinity/ledger-icp |
v2.0.0 | Enhanced 🔧 |
@dfinity/ledger-icrc |
v2.0.0 | Enhanced 🔧 |
@dfinity/nns |
v3.0.0 | Enhanced 🔧 |
@dfinity/nns-proto |
v1.0.0 | Unchanged |
@dfinity/sns |
v2.0.0 | Enhanced 🔧 |
@dfinity/utils |
v1.1.0 | Unchanged |
Features
- Include timestamp and tags in the candid provenance record.
- Update ckbtc candid to ic commit
4de99bc27be74048f80d13200f3c75cf2a43438c
. - Include pending UTXOs in MinterNoNewUtxosError.
- Upgrade
didc
to0.3.5
that converts candid files into JS and TS.
2023.10.15-0600Z
Overview
The current status of the libraries at the time of the release is as follows:
Library | Version | Status |
---|---|---|
@dfinity/ckbtc |
v1.1.0 | Enhanced 🔧 |
@dfinity/cmc |
v1.0.0 | Unchanged |
@dfinity/ic-management |
v1.0.0 | Unchanged |
@dfinity/ledger-icp |
v1.1.0 | Enhanced 🔧 |
@dfinity/ledger-icrc |
v1.0.1 | Patched 🩹 |
@dfinity/nns |
v2.1.0 | Enhanced 🔧 |
@dfinity/nns-proto |
v1.0.0 | Unchanged |
@dfinity/sns |
v1.0.2 | Patched 🩹 |
@dfinity/utils |
v1.1.0 | Enhanced 🔧 |
Features
- add support for ICP Index canister to library
@dfinity/ledger-icp
. NewIndexCanister
functions:accountBalance
andgetTransactions
- expose few types - notably
BlockHeight
- for library@dfinity/ledger-icp
- support new fields from swap canister response types:
min_direct_participation_icp_e8s
,max_direct_participation_icp_e8s
andneurons_fund_participation
- support new fields in the
CreateServiceNervousSystem
proposal action:maximum_direct_participation_icp
,minimum_direct_participation_icp
andneurons_fund_participation
- support new filter field
omit_large_fields
inlist_proposals
- add support for
retrieve_btc_with_approval
in@dfinity/ckbtc
- new utility to convert seconds to a human-readable duration
- update
@dfinity/ledger-icrc
did files - update
@dfinity/sns
did files
2023.10.02-1515Z
Overview
The current status of the libraries at the time of the release is as follows:
Library | Version | Status |
---|---|---|
@dfinity/ckbtc |
v1.0.1 | Patched |
@dfinity/cmc |
v1.0.0 | Unchanged |
@dfinity/ic-management |
v1.0.0 | Unchanged |
@dfinity/ledger |
v1.0.0 | Deprecated ❌ |
@dfinity/ledger-icp |
v1.0.0 | New 🚀 |
@dfinity/ledger-icrc |
v1.0.0 | New 🚀 |
@dfinity/nns |
v2.0.0 | Breaking Changes |
@dfinity/nns-proto |
v1.0.0 | Unchanged |
@dfinity/sns |
v1.0.0 | Patched |
@dfinity/utils |
v1.0.0 | Unchanged |
Release
- ckbtc
v1.0.1
- ledger-icp
v1.0.0
- ledger-icrc
v1.0.0
- nns
v2.0.0
- sns
v1.0.1
Breaking Changes ⚠️
- ICP ledger-related features have been relocated from
@dfinity/nns
to a new dedicated library called@dfinity/ledger-icp
- ICRC ledger-related features have been moved as well. The library
@dfinity/ledger
has been deprecated, renamed, and replaced by@dfinity/ledger-icrc
- remove the
ICP
class, which was deprecated a long time ago, from@dfinity/nns
. Instead, utilize the token parsers from@dfinity/utils
Build
@dfinity/sns
inherits the changes and now requires@dfinity/ledger-icrc
as a peer dependency@dfinity/nns
inherits the changes and now requires@dfinity/ledger-icp
as a peer dependency
Chore
- minter params
Subaccount
declared asUint8Array
instead of inheriting a type