CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

0.109.3 (2024-08-01)

Bug Fixes

• commonjs support (#639) (b229d4e)

0.109.2 (2024-07-19)

Features

• enable es module (be3e757)
• export signWitnesses and calculateTransactionFee (13c6b3d)

0.109.2-alpha.1 (2024-07-18)

Features

• export signWitnesses and calculateTransactionFee (13c6b3d)

0.109.2-alpha.0 (2024-07-16)

Features

• enable es module (#635 & be3e757)

0.109.1 (2024-03-13)

Bug Fixes

• return empty array if payload of batch request is an empty array (#616) (f649fa6)

Features

• add data2 to script hash_type (e887c7a)
• support data2 in address transform (4c61674)

0.109.1 (2024-03-13)

• add data2 to script.hashType (#629)

0.109.0 (2023-04-26)

Note: Version bump only for package ckb-sdk-js

0.107.0 (2023-04-03)

Features

• Sign support multisig. (#593) (3ad7abd)
• add rpc of "get_fee_rate_statics" (#608)

0.103.1 (2022-05-31)

Bug Fixes

• add address format type validation in utils.toAddressPayload (8cf043c)
• fix default code hash/code hash index in toAddressPayload (e72a29d)
• reinforce restriction of address format type and bech32(m) (816e8ea)

0.103.0 (2022-05-09)

Bug Fixes

• fix default code hash/code hash index in toAddressPayload (e72a29d)

0.102.3 (2022-03-24)

Note: Version bump only for package ckb-sdk-js

0.102.2 (2022-03-02)

• core: add calculateDaoMaximumWithdraw to calculate maximum withdraw capacity based on withdrawing block hash or withdrawing cell outpoint(#578)
• utils: add extractDAOData to deserialize DAO field in block header (#578)
• utils: add calculateMaximumWithdraw to calculate maximum withdraw capacity offline (#578)

0.102.1 (2022-02-17)

Note: Version bump only for package ckb-sdk-js

0.102.0 (2022-02-16)

Note: Version bump only for package ckb-sdk-js

0.101.0 (2021-10-25)

Features

• extends hash_type to 'data' | 'type' | 'data1' (#555) (30c49e8)
• rpc: a new field 'extension' is added to the block body (285a829)
• rpc: add a new field 'hardforkFeatures' in response of getConsensus (133fe26)
• rpc: rename 'uncles_hash' to 'extra_hash' in block header (58c055c)

BREAKING CHANGES

• rpc: Add a new field 'hardforkFeatures' in response of getConsensus

ref nervosnetwork/ckb#2879

• rpc: A new field 'extension' is added to the block body

ref nervosnetwork/rfcs#224

• rpc: The field 'uncles_hash' in block header is renamed to 'extra_hash'

ref: nervosnetwork/rfcs#224

0.43.0 (2021-06-29)

Note: Version bump only for package ckb-sdk-js

0.41.1 (2021-05-08)

Note: Version bump only for package ckb-sdk-js

0.41.0 (2021-05-06)

Note: Version bump only for package ckb-sdk-js

0.40.0 (2021-03-08)

Features

• rpc: remove indexer from RPC module (b3ba942)

BREAKING CHANGES

• rpc: Remove the entire indexer from the RPC module

0.39.0 (2021-01-13)

Features

• rpc: add rpc#getRawTxPool, rpc#getConsensus and deprecate rpc#getCellbaseOutputCapacityDetails, rpc#getPeersState (#528)

0.38.2 (2020-11-30)

Bug Fixes

• core: fix the type declaration of changeLockScript (23ad1db)

0.38.1 (2020-11-27)

Features

• core: upgrade @ckb-lumos/indexer and add the example of sudt transaction (c10ec0b)
• utils: update acp lock script (6d9a85f)

0.38.0 (2020-11-20)

Bug Fixes

• core: use change lock script instead of change public key hash (b16bfc8)

BREAKING CHANGES

• core: changePublicKeyHash in generateRawTransaction is replaced with changeLockScript

0.37.0 (2020-10-25)

Features

• core: prune cached cells according to data returned from lumos indexer (5d09d61)
• rpc: add rpc#pingPeers, rpc#getTransactionProof, rpc#verifyTransactionProof and rpc#clearBannedAddresses (#506) (61efe5e)
• rpc: remove rpc#getCellsByLockHash (#504) (2071308)
• utils: remove support of [email protected] (b94d318)

Performance Improvements

• bump deps (43c71b8)

BREAKING CHANGES

• utils: Remove explicit support of [email protected]

0.36.2 (2020-10-20)

Bug Fixes

• core: fix type declaration of RawTransactionParams (f9ba7bf)

0.36.1 (2020-09-26)

Features

• utils: disable blake2b-wasm when the host is iOS 11 (4c70554)
• utils: add a method to reconcile transactions (1ae64cd)

0.36.0 (2020-09-21)

Code Refactoring

• utils: remove redundant default options in the address module (d74caac)

Features

• core: parse scripts from addresses on generating transactions (#488) (9536f08)
• utils: add system scripts (567f15a)
• utils: add the utils#addressToScript (a78340a)

BREAKING CHANGES

• utils: Remove the utils#defaultAddressOptions

0.35.0 (2020-08-24)

Bug Fixes

• rpc: fix init parameter type of batch request (2b80f59)

Features

• rpc: remove an RPC (98eb935)
• rpc: update RPCs (#477)
  • separate basic RPC by group
  • update teh API of rpc#localNodeInfo, rpc#txPoolInfo, and rpc#getPeers
  • add new RPCs: rpc#syncState, rpc#clearTxPool, rpc#setNetworkActive, rpc#addNode and rpc#removeNode
• utils: add epoch module (8d6478a)
• utils: set the default address prefix 'ckb' (3134eda)
• utils: use strict validation on address (bb23ce9)
• utils: utils#calculateSerializedTxSizeInBlock is renamed to utils#getTransactionSize (8fbc43a)
• utils: remove utils#toHexInLittleEndian which is deprecated (a028887)
• utils: remove methods related to utf8 string (f9cf9cc)

BREAKING CHANGES

• rpc: remove rpc#getPeersState
• rpc: rpc#getPeers returns connectedDuration, lastPingDuration, protocols, syncState
• rpc: rpc#localNodeInfo returns active, connections, protocols
• utils: utils#calculateSerializedTxSizeInBlock is renamed to utils#getTransactionSize
• utils: Set the default address prefix 'ckb' instead of 'ckt'
• utils: The arg field in params of utils#fullPayloadToAddress is renamed to args
• utils: Remove utils#toHexInLittleEndian which is deprecated
• utils: Remove methods related to utf8 string

0.34.0 (2020-07-21)

Bug Fixes

• utils: rename the arg field in params of utils#fullPayloadToAddress to args (08dcc0d)

Features

• core: combine core#loadSecp256k1Dep and core#loadDaoDep into core#loadDep (762441e)
• core: enhance ckb#loadCells to load cells from lumos collector (3152a3c)
• core: remove experimental rpc (32c7a0c)
• rpc: enable batch request (#449) (9517cae)
• rpc: remove the estimateFeeRate RPC method (819d33f)
• utils: add epoch module (8d6478a)
• utils: set the default address prefix 'ckb' (3134eda)
• utils: use strict validation on address (bb23ce9)
• utils: utils#calculateSerializedTxSizeInBlock is renamed to utils#getTransactionSize (8fbc43a)

BREAKING CHANGES

• rpc: Remove the estimateFeeRate RPC method
• utils: utils#calculateSerializedTxSizeInBlock is renamed to utils#getTransactionSize
• utils: Set the default address prefix 'ckb' instead of 'ckt'
• core: core#loadSecp256k1Dep and core#loadDaoDep are removed, use core#loadDeps instead
• core: computeTransactionHash and computeScriptHash are removed from the rpc list
• utils: The arg field in params of utils#fullPayloadToAddress is renamed to args

0.33.0 (2020-06-22)

Note: Version bump only for package ckb-sdk-js

0.32.0 (2020-05-26)

Features

• utils: add convertors of uint-to-le (16b6d80)
• use signature provider in signWitnesses & signWitnessGroup (#434) (34d62bb)

0.31.0 (2020-04-21)

Note: Version bump only for package ckb-sdk-js

0.30.0 (2020-03-23)

Features

• rpc: add a new field in the tx pool info (c1cbac9)
• rpc: add the new RPC getBlockEconomicState (0c9e248)

0.29.1 (2020-02-28)

Bug Fixes

• core: fix the calculation of epoch locks in nervos dao operation (d914007)

0.29.0 (2020-02-28)

Features

• rpc: update the action of outputs validator when it is null (4932c47)

BREAKING CHANGES

• rpc: null outputs validator is equivalent to the passthrough one

0.28.0 (2020-02-07)

Note: Version bump only for package ckb-sdk-js

0.27.1 (2020-02-01)

Features

• rpc: add the second paramter outputsValidator in the sendTransaction RPC method (0c7b7b1)

BREAKING CHANGES

• rpc: Default outputsValidator on sending transactions requires the lock of outputs to be the default lock script

0.27.0 (2020-01-11)

Note: Version bump only for package ckb-sdk-js

0.26.4 (2020-01-02)

Features

• rpc: add the new rpc method of get_capacity_by_lock_hash (9628084)

0.26.3 (2019-12-23)

Note: Version bump only for package ckb-sdk-js

0.26.2 (2019-12-16)

Note: Version bump only for package ckb-sdk-js

0.26.1 (2019-12-16)

Note: Version bump only for package ckb-sdk-js

0.26.0 (2019-12-16)

Bug Fixes

• rpc: add missing types in rpc type def (8427341)
• rpc: fix the type def of ScriptHashType (217a579)

Features

• enable JSBI for compatibility (bfce1e5)
• core: support multiple private keys in generating and signing a… (#403) (8bac66b)
• type: update the return type of rpc.getCellsByLockHash (30aa494)

BREAKING CHANGES

• utils.toHexInLittleEndian will not accept parameters in number

0.25.0 (2019-11-16)

Note: Version bump only for package ckb-sdk-js

0.25.0-alpha.1 (2019-11-13)

Bug Fixes

• core: fix the minimal epoch composition in generateDaoWithdrawTx method (c87fb6a)

0.25.0-alpha.0 (2019-11-12)

Features

• core: add generateDaoDepositTx method (27a31f6)
• core: add the method of generateDaoWithdrawStartTx (ff2163f)
• core: add the method of generateDaoWithdrawTransaction (a375abd)
• core: add the method to load dao deps (75e5ca7)
• core: allow cell capacity threshold in generateRawTransaction method (ebbe448)
• rpc: add an rpc method of calculateDaoMaximumWithdraw (f4cd7e7)
• utils: add address and address payload validators (d44effb)
• utils: add assertToBeHexStringOrBigint method for validation (6b16507)
• utils: add parseEpoch method (c29aca6)

0.24.2 (2019-11-08)

Bug Fixes

• core: serialize the witnesses after it's signed (6d4bcdc)

0.24.1 (2019-11-07)

Bug Fixes

• utils: fix the precision-lost in toHexInLittleEndian (9658a76)

0.24.0 (2019-11-02)

Features

• core: include fee in generateTransaction method (03153f6)
• rpc: add a rpc method (928aaf9)
• core: sign inputs in group (294f59c)

BREAKING CHANGES

• core: sign inputs in group

0.23.1 (2019-10-22)

Features

• utils add methods for calculating transaction fee (1dd82a4)
  1. add utils.serializeTransaction method to serialize a full transaction;
  2. add utils.calculateTrasnactionSize to get the size of a full transaction

0.23.0 (2019-10-19)

Features

• address: add support to addresses in full version format (a385821)
• core: add transaction builder for signing transactions with multiple private keys (d5d69c0)
• core: remove address module (#369) (e467427)

BREAKING CHANGES

• core: remove address module and add key pair module

  • ci: add codecov config for a tolerant threshold
  • feat(utils): add some util methods for getting public keys and addresses from private keys
    • add a method of core.utils.privateKeytoPublicKey
    • add a method of core.utils.privateKeyToAddress

• core: KeyPair from the core module

  • fix(core): fix the lock script in the sending transactions example

• address: rename an parameter in bech32Address method from codeHash to codeHashOrCodeHashIndex

0.22.1 (2019-10-12)

Bug Fixes

• rpc: update the signatures of rpc methods (7eb6726), closes #365

BREAKING CHANGES

• rpc: use bigint instead of number in signatures of rpc methods

0.22.0 (2019-10-05)

Features

• address: enable address to load cells and generate signed transactions (2e5803c)
• cli: deprive this repo of the ckb-cli (2befcff)
• core: move the address module into the core module (10dd017)
• rpc: update rpc signatures (201901d)
• rpc: use bigint instead of number in the interfaces of rpc methods (c8d994b)
• type: update the fields of BlockHeader (55de626)
• type: update the result of getCellsByLockHash method (31eb97e)
• type: update the structure of Epoch (76770f4)
• type: update the type of args (09d649a)
• type: update the type of witness (71f53b0)
• utils: update the interface of utils.parseAddress (90feb91)

BREAKING CHANGES

• type: replace difficulty with compactTarget in Epoch
• type:
  1. remove unclesCount
  2. merge witnessesRoot and transactionRoot
  3. replace difficulty with compactTarget
• type: change the type of args from string[] to string
• type: change the type of witnes from { data: string[] } to string
• rpc: use bigint instead of number in the interfaces of rpc methods
• utils: remove the prefix from the parameter list of utils.parseAddress
• core: move the address module into the core module
• type: update the result of getCellsByLockHash method

0.21.1 (2019-09-24)

Bug Fixes

• rpc: add a parser for optional parameters (274268e)
• rpc: update the returned cell type of getLiveCell from cell to liveCell (4a69d85)

0.21.0 (2019-09-21)

Code Refactoring

• address rename public key identifier to publicKeyHash (b33c096)

Features

• rpc: format the outputs of the params formatter (740b403)
• rpc: update the interface of getLiveCell (0280d7f)
• utils: format the outputs of the utils module (a30071c)

BREAKING CHANGES

• rpc: update the interface of getLiveCell
• address rename public key identifier to publicKeyHash
• rpc: hexilize the outputs of the params formatter
• utils: hexilize the outputs of the utils module

0.20.0 (2019-09-07)

Features

• utils: add the serializeScript method in the utils module (85dffcb)
• utils: update the scriptToHash method in the utils module with a new serialization method (abeabf4)

BREAKING CHANGES

• utils: update the scriptToHash method in the utils module with a new serialization method

0.19.1 (2019-08-28)

Features

• rpc: enable custom http agent and https agent (34fca52)

0.19.0 (2019-08-27)

Features

• core: add the RPC of computeScriptHash (705f51e)
• core: use secp256k1 dep group instead of secp256k1 cell (578eb43)
• core: use the secp256k1 type script hash as the code hash of the secp256k1 dep (617487e)
• type: block header structure changes (ce48faf)
• type: CellOutput and Epoch structures change (8346ae4)
• type: Input structure changes (ba16d1b)
• type: OutPoint structure changes (38ba007)
• type: rename is_dep_group to dep_type (06c324a)
• type: set the value of hash_type to "data" and "type" (36a5512)
• type: Transaction structure changes (30c84bb)
• type: Transaction structure changes (71625fa)
• type: Transaction structure changes (df65152)
• utils: rename the method of lockScriptToHash to scriptToHash (40cdbaa)

BREAKING CHANGES

• type: set the value of hash_type to "data" and "type"
• type: rename is_dep_group to dep_type
• type: block header structure changes
• utils: rename the method of lockScriptToHash to scriptToHash
• core: use secp256k1 dep group instead of secp256k1 cell
• type: CellOutput and Epoch structures change
• type: Transaction structure chagnes
• type: OutPoint structure changes
• type: Input structure chagnes

0.18.0 (2019-08-10)

Features

• rpc: add get_cellbase_output_capacity_details rpc (fa3aea3)
• rpc: add get_header rpc (d2a6bbb)
• rpc: add get_header_by_number rpc (54f9d19)
• rpc: add new rpc of set ban (416e7fd)
• rpc: add rpc of get banned addresses (323b8ac)

0.17.1 (2019-07-29)

Bug Fixes

• types: remove the hash_type field from the type of cell_out_point (58c019f)

BREAKING CHANGES

• types: the type of cell out point changes

0.17.0 (2019-07-27)

Features

• types: add a new field named 'hash_type' in types of script and cell output (2692c0a)
• utils: update the address format (74a5ad8)

BREAKING CHANGES

• types: types of script and cell output changed
• utils: update the address format

0.16.0 (2019-07-13)

Note: Version bump only for package ckb-sdk-js

0.15.1 (2019-07-12)

Bug Fixes

• rpc: fix the return type of get_transaction api (a1a5cf4)

Features

• utils: remove toAddressIdentifier method (ab1e356)

BREAKING CHANGES

• utils: remove toAddressIdentifier method

0.15.0 (2019-06-29)

Bug Fixes

• rpc: binding the node of method instances to the one of rpc instance. (f0b486a)

Features

• cli: add dashboard mode of ckb-cli (9accdeb)
• rpc: add index related rpc (cf8931b)
• rpc: add index related rpc (2a7d403)
• rpc: update get blockchain info rpc (7382458)
• rpc: update the type of epoch (509a79b)
• utils: add signRecoverable method to the ECPair class (3c1f334)

BREAKING CHANGES

• rpc: update the type of epoch, remove block_reward, last_block_hash_in_previous_epoch, remainder_reward fields, add epoch_reward field.
• rpc: replace warnings field with alerts field in the response of get blockchain info rpc
• utils: use signRecoverable instead of sign method to sign the transactions.

0.14.0 (2019-06-15)

Features

• types: remove the args field in cell input type (d07f253)
• core: add signWitnesses and signTransaction methods in the core module (c20d36c)

BREAKING CHANGES

• types: the type of cell input changes, its args field is removed.

0.13.0 (2019-06-01)

Features

• address: add blake160-ed public key as address identifier (b7bee1c)
• rpc: add total_tx_cycles and total_tx_size in tx_pool_info (5db06fa)

0.12.0 (2019-05-18)

Bug Fixes

• rpc: fix get live cell rpc (dffcc55)
• rpc: fix the return type of getCellsByLockHash from cellByLockHash to cellIncludingOutPoint (f648f56)

Features

• core: add _compute_transaction_hash rpc (9f81f28)
• core: add address module into core module (d5d75ec)
• core: add load system cell method (94af040)
• core: remove wallet module (551f5a2)
• rpc: add get epoch by number rpc (d1141dd)
• rpc: add get peers rpc (f67eee6)
• rpc: add get tx pool info rpc (203dcde)
• rpc: add one new rpc and remove two rpc (21c4ac4)
• rpc: add rpc of get blockchain info and get peers state (9f7d20c)
• rpc: add rpc of getCurrentEpoch (9e631db)
• rpc: export formatter as helpers in rpc module (160aa1c)
• rpc: generalize outpoint (2a41797)
• rpc: update staging in tx pool info to proposed (a4f4192)
• types: rename the proposals_root field in block header to proposals_hash (b2db527)

BREAKING CHANGES

• types: update type of outpoint
• types: rename the proposals_root field in block header to proposals_hash
• wallet: remove wallet module

0.11.0 (2019-05-14)

Features

• types: update basic types in CKB (71d4e5)
• types: add shannon as a new capacity unit (910cc5)
• feat: remove always success wallet (febb5d)
• rpc: update rpc interface formatter according to new api (c0a631)
• feat: add address module (c5b532)

BREAKING CHANGES

• feat: remove always success wallet
• types: update basic types according to ckb-types update

0.10.0 (2019-05-06)

Bug Fixes

• utils: fix typo of seperator to separator (b336968)

Features

• types: add field of validSince in cell input of a transaction (54770fc)
• types: remove cellbase id from block header, remove cellbase from uncle block (96a1f53)
• types: update ckb-types (e6af3b5)
• utils: add blake160, bech32, blake160PubkeyToAddress, pubkeyToAddress (82121b3)
• utils: parseAddress returns bytes or hex string instead of words (aaad9c9)

BREAKING CHANGES

• types: replace type of u64 with type of string in ckb-types, remove version field from script interface
• types: rpc interface updated, add field of validSince in cell input of a transaction
• types: block header and uncle block in rpc updated

0.9.1 (2019-04-24)

Bug Fixes

• types: set the type of arg in script to string (7ea3ad2)

0.9.0 (2019-04-22)

Features

• rpc: add segrated witnesses (bc8339f)
• types: update types of script, cell input, cell output (ee405bb)
• types: remove cellbase id from block header, remove cellbase from uncle block (de9f50d)
• utils: add blake160, bech32, blake160PubkeyToAddress, pubkeyToAddress (79cb24f)
• utils: parseAddress returns bytes or hex string instead of words (2028a6c)
• wallet: remove udt account (7e3cf6d)

BREAKING CHANGES

• types: block header and uncle block in rpc updated
• types: script model updated

0.8.0 (2019-04-08)

0.7.0 (2019-03-25)

Features

• account: remove all udt scripts (9b0f54b)
• utils: add type definition of blake2b-wasm (f2cd199)
• utils: repalce-sha3-with-blake2b (93bddd1)
• utils: update blake2b personal to 'ckb-default-hash' and add tests (5c3bab3)
• wallet: remove unlock.rb, use c script instead (3520208)

BREAKING CHANGES

• utils: update default signature method