Breaking Changes

RPC

• #4365 removes the orphan_blocks_size field in the sync_state RPC.
• #4576 adds limit to the RPC methods to get cells.
• #4583 adds tx_index to TxStatus for get_transaction RPC.

Highlights

The featured changes in the new release are:

1. Asynchronous Block Download and Verification: This enhancement improves the efficiency of block requests and verification during the initial block download (IBD) phase. It introduces asynchronous operations, changes to the sync_state RPC, and updates to the log format.

2. New spawn with scheduler: This change is only available in the next version of CKB consensus rules. It refactors the implementation of spawn and introduces a new syscall API.

3. New script verify with ckb-vm pause: This change introduces several improvements to the script verification process. It uses a job queue for pending transactions, multiple workers for verification, and changes the verification style to async. It also includes changes related to resuming/suspending the VM, removing snapshots from VM machines, and removing the "Suspend" state from cache. All transactions from remote peers will be added to the queue for verification.

Compatibility Table

See how to connect to various chains in Wiki.

Default assume valid target

• Mainnet: 0xd07c7f0fcea6e2a20a51dabbf0caae7ebff49723bcd8bac81a8b8c021a546a32
• Testnet: 0xab6f81474ccbc1cdd5f42cda7029a6f6e52fc242c3487861e8abb62b6a6ea8a9

Downloads

The .asc files are signatures. It is wise and more secure to check out for the files integrity.

Try the portable variants if the binaries complains about illegal instructions.

Changes since v0.117.0

Features

• #4365: Asynchronous Block Download and Verification (@eval-exec)

  This PR introduces several enhancements to the CKB Synchronizer to reduce synchronization time
  during the initial block download (IBD) phase. Key changes include:

  1. Asynchronous Operations: The Synchronizer sliding window movement is now decoupled from the block verification process in the ChainService, allowing asynchronous handling. This improves the efficiency of block requests and verification.
  2. Changes to sync_state RPC:
     • Added tip_hash and tip_number to represent the current chain tip.
     • Added unverified_tip_hash and unverified_tip_number to track the latest received but not yet verified blocks.
     • Removed the orphan_blocks_size field.
  3. Log Format Update: The format of CKB logs has been updated, specifically changing the prefix and content of log entries to provide clearer and more structured information.

  These updates lead to a more efficient synchronization process, reducing the overall time
  required for IBD. Note that removing the orphan_blocks_size field constitutes a BREAKING CHANGE
  in the sync_state RPC.

• #4380: New spawn with scheduler (@mohanson)

  This change is only available in the next version of CKB consensus rules.

  In this PR, we refactored the implementation of spawn. The refactored syscall API is defined as follows: https://github.com/XuJiandong/ckb-c-stdlib/blob/syscall-spawn/ckb_syscall_apis.h#L54-L68.

  Review Introduction: #4380 (comment)

  Documentation: nervosnetwork/rfcs#436

• #4291: New script verify with ckb-vm pause (@chenyukang)

  1. Use a job queue for pending transactions waiting for verifying
  2. Multiple workers trigger the verification process by picking task from queue
  3. Verification is changed to async style
  4. Use channel to resume/suspend vm
  5. No snapshot from VM machines
  6. No Suspend state from cache
  7. All transactions from remote peer will be added into queue

Bug Fixes

• #4562: Fix sync relayer collaboration (@driftluo)

• #4576: Add limit to get cells (@driftluo)

  This is a breaking change to RPC. The RPC to get cells may fail when exceeding the limit.

• #4612: Verify worker exit when signal_exit is cancelled (@chenyukang)

Improvements

• #4529: Add jsonrpc batch request limit (@chenyukang)

• #4583: Add tx_index to TxStatus for get_transaction RPC (@eval-exec)

  This is a breaking change to the RPC.

• #4591: VerifyQueue: re_notify other Worker when OnlySmallCycleTx received a large cycle tx (@eval-exec)

Compare changes in GitHub

This is an RC version to preview the changes in the next release.

See #4598 for details.

Compatibility Table

Downloads

The .asc files are signatures. It is wise and more secure to check out for the files integrity.

Try the portable variants if the binaries complains about illegal instructions.

Changes since v0.118.0-rc1

Compare changes in GitHub

This is an RC version to preview the changes in the next release.

See details in #4598

Compatibility Table

Downloads

The .asc files are signatures. It is wise and more secure to check out for the files integrity.

Try the portable variants if the binaries complains about illegal instructions.

Changes since v0.117.0

Features

• #4365: Asynchronous Block Download and Verification (@eval-exec)

  This PR introduces several enhancements to the CKB Synchronizer to reduce synchronization time
  during the initial block download (IBD) phase. Key changes include:

  1. Asynchronous Operations: The Synchronizer sliding window movement is now decoupled from the block verification process in the ChainService, allowing asynchronous handling. This improves the efficiency of block requests and verification.
  2. Changes to sync_state RPC:
     • Added tip_hash and tip_number to represent the current chain tip.
     • Added unverified_tip_hash and unverified_tip_number to track the latest received but not yet verified blocks.
     • Removed the orphan_blocks_size field.
  3. Log Format Update: The format of CKB logs has been updated, specifically changing the prefix and content of log entries to provide clearer and more structured information.

  These updates lead to a more efficient synchronization process, reducing the overall time
  required for IBD. Note that removing the orphan_blocks_size field constitutes a BREAKING CHANGE
  in the sync_state RPC.

• #4380: New spawn with scheduler (@mohanson)

  This change is only available in the next version of CKB consensus rules.

  In this PR, we refactored the implementation of spawn. The refactored syscall API is defined as follows: https://github.com/XuJiandong/ckb-c-stdlib/blob/syscall-spawn/ckb_syscall_apis.h#L54-L68.

  Review Introduction: #4380 (comment)

  Documentation: nervosnetwork/rfcs#436

• #4291: New script verify with ckb-vm pause (@chenyukang)

  1. Use a job queue for pending transactions waiting for verifying
  2. Multiple workers trigger the verification process by picking task from queue
  3. Verification is changed to async style
  4. Use channel to resume/suspend vm
  5. No snapshot from VM machines
  6. No Suspend state from cache
  7. All transactions from remote peer will be added into queue

Bug Fixes

• #4562: Fix sync relayer collaboration (@driftluo)

• #4576: Add limit to get cells (@driftluo)

  This is a breaking change to RPC. The RPC to get cells may fail when exceeding the limit.

Improvements

• #4529: Add jsonrpc batch request limit (@chenyukang)

• #4583: Add tx_index to TxStatus for get_transaction RPC (@eval-exec)

  This is a breaking change to the RPC.

• #4591: VerifyQueue: re_notify other Worker when OnlySmallCycleTx received a large cycle tx (@eval-exec)

Highlights

There are two improvements applied for the RPC:

• #4454: Add include_tx_pool: Option<bool> param to ChainRpcImpl::get_live_cell' (@eval-exec)
• #4486: Add assume_valid_target_reached: bool to NetRpc::sync_state (@eval-exec)

Please note that these changes are considered breaking changes and may cause compatibility issues with older versions of RPC clients.

Compatibility Table

See how to connect to various chains in Wiki.

Default assume valid target

• Mainnet: 0x84ef5fe7cbf4242bdcac76326aa33f15b9cc41958e9d891157b8a6066dad0f31
• Testnet: 0xc39d482e1c9cba7bdef254ff13e430f42cb5407e15464c029284cd5811e4c8df

Downloads

The .asc files are signatures. It is wise and more secure to check out for the files integrity.

Try the portable variants if the binaries complains about illegal instructions.

Changes since v0.116.1

Features

• #4454: Add include_tx_pool: Option<bool> param to ChainRpcImpl::get_live_cell' (@eval-exec)

  This is a breaking change to the RPC.

• #4486: Add assume_valid_target_reached: bool to NetRpc::sync_state (@eval-exec)

  This is a breaking change to the RPC.

Bug Fixes

• #4484: Fix rich indexer partial query by args performance issue (@EthanYuan)
• #4505: Fix websocket subscription performance issue (@chenyukang)

Improvements

• #4487: tweak max_ancestors_count (@zhangsoledad)
• #4459: Use standalone runtime for RPC service (@chenyukang)
• #4511: Modify the record scope of tx-pool reject record and fix rule for orphan tx. (@zhangsoledad)
• #4531: Early return process_fetch_cmd if ckb received exit signal (@eval-exec)

This is an RC version to preview the changes in the next release.

Compatibility Table

Downloads

The .asc files are signatures. It is wise and more secure to check out for the files integrity.

Try the portable variants if the binaries complains about illegal instructions.

Changes since v0.117.0-rc4

Improvements

• #4531: Backport #4527 Early return process_fetch_cmd if ckb received exit signal (@eval-exec)

This is an RC version to preview the changes in the next release.

Compatibility Table

Downloads

The .asc files are signatures. It is wise and more secure to check out for the files integrity.

Try the portable variants if the binaries complains about illegal instructions.

Changes since v0.117.0-rc3

Features

• #4454: Add include_tx_pool: Option<bool> param to ChainRpcImpl::get_live_cell' (@eval-exec)

  This is a breaking change: b:rpc

• #4486: Add assume_valid_target_reached: bool to NetRpc::sync_state (@eval-exec)

  This is a breaking change: b:rpc

Bug Fixes

• #4484: Fix rich indexer partial query by args performance issue (@EthanYuan)
• #4505: Fix websocket subscription performance issue (@chenyukang)
• #4507: Fix websocket subscription performance issue (@chenyukang)

Improvements

• #4459: Use standalone runtime for RPC service (@chenyukang)
• #4511: Modify the record scope of tx-pool reject record and fix rule for orphan tx. (@zhangsoledad)

This is an RC version to preview the changes in the next release.

Compatibility Table

Downloads

The .asc files are signatures. It is wise and more secure to check out for the files integrity.

Try the portable variants if the binaries complains about illegal instructions.

Changes since v0.117.0-rc1

• #4487
• #4479

Full Changelog: v0.117.0-rc1...v0.117.0-rc3

This is an RC version to preview the changes in the next release.

Assume Valid Target:

• MainNet: the 60 days ago block is: 12623864 0x84ef5fe7cbf4242bdcac76326aa33f15b9cc41958e9d891157b8a6066dad0f31 in Thu Apr 4 02:32:20 AM UTC 2024
  you can view this block in https://explorer.nervos.org/block/0x84ef5fe7cbf4242bdcac76326aa33f15b9cc41958e9d891157b8a6066dad0f31
• TestNet: the 60 days ago block is: 12811906 0xc39d482e1c9cba7bdef254ff13e430f42cb5407e15464c029284cd5811e4c8df in Thu Apr 4 02:32:39 AM UTC 2024
  you can view this block in https://pudge.explorer.nervos.org/block/0xc39d482e1c9cba7bdef254ff13e430f42cb5407e15464c029284cd5811e4c8df

Compatibility Table

Downloads

The .asc files are signatures. It is wise and more secure to check out for the files integrity.

Try the portable variants if the binaries complains about illegal instructions.

Changes since v0.116.1

Trivial improvements and bug fixings

Highlights

Compatibility Table

See how to connect to various chains in Wiki.

Default assume valid target

• Mainnet: 0x9264d3b444e765d2801d13e800adb520865523a09cd9895bdaeae2c87403fd7f
• Testnet: 0x40e4479ef397e98f226b469ae1fd3d0a064433100f610fb409f0ebc49ccc284e

Downloads

The .asc files are signatures. It is wise and more secure to check out for the files integrity.

Try the portable variants if the binaries complains about illegal instructions.

Changes since v0.115.0

Features

• #4433: Add PoolRpc::test_tx_pool_accept, check if the transaction can be accepted by TxPool (@eval-exec)

Bug Fixes

• #4405: Fix default ckb.toml's [notifier] to [notify] (@eval-exec)

  This is a breaking change in the config file format.

Improvements

• #4254: Hardcoding a Default assume_valid_target to Reduce the Timecost of Block Synchronization in IBD mode (@eval-exec)
• #4390: Limit txpool size when inserting an Entry (@chenyukang)
• #4418: Set ChainService process_block channel size to zero (@eval-exec)
• #4417: Add tokio-trace feature for tokio-console debug tool (@eval-exec)
• #4366: Adjusting the default dev chain epoch parameter (@EthanYuan)

This is an RC version to preview the changes in the next release.

Compatibility Table

Downloads

The .asc files are signatures. It is wise and more secure to check out for the files integrity.

Try the portable variants if the binaries complains about illegal instructions.

Changes since v0.116.0-rc1

• Fix windows integration test compile error by @eval-exec in #4424
• Disable PoolPersisted on windows CI by @eval-exec in #4431
• chore: fix some typos in comments by @racequite in #4423
• chore: bury rfc0044 deploy by @zhangsoledad in #4430
• Add PoolRpc::test_tx_pool_accept, check if the transaction can be accepted by TxPool by @eval-exec in #4433

Full Changelog: v0.116.0-rc1...v0.116.0-rc2