Skip to content

Latest commit

 

History

History
49 lines (37 loc) · 2.47 KB

migration.md

File metadata and controls

49 lines (37 loc) · 2.47 KB

Migration from v0.3.x to v0.4.x

⚠️ Important: All migrations require a local chain clean. You should run offckb clean before upgrading to new breaking-change version.

BREAKING CHANGES

  1. The Node engine is required at least v20.0.0, Node version below v20 is not expected to work.
  2. More built-in scripts added, including ckb-js-vm, nostr-lock, pw-lock, multisig-v2 and type_id script.
  3. The chain information of the devnet has changed due to the No.1 changes, meaning you need to re-generate the system-scripts.json file in your project if you're upgrading from v0.3.x to v0.4.x.
  4. The default log level in CKB devnet Node is changed to warn,ckb-script=debug from info to display the script debug output
  5. The devnet RPC proxy sever is now default running, and proxy port is changed to 28114 from 9000. You need to update the devnet proxy port in your local config file if you have used v3 offckb before.
  6. The offckb node command now accepts a network option, when passing --network testnet or --network mainnet, it will start a proxy RPC for the public network instead of starting a local devnet.
  7. The create command is now focusing on creating a CKB Smart Contract project in JavaScript, instead of a full dApp project.
  8. offckb.config.ts file is removed, and the deploy command now requires --target and --output options to specify the contract binary file or folder path and the output folder path.
  9. system-scripts command has a new option called -o, --output to specify the output json file path for the system scripts.
  10. The CLI build system is changed from npm-shrinkwrap.json to ncc toolchain.
  11. The CLI now requires no ckb-debugger installed to run offckb debug command, it will use the WASM debugger built-in.

Removed commands

  • proxy-rpc
  • mol
  • repl
  • list-hashes
  • my-scripts
  • sync-scripts
  • inject-config

Add new commands

  • debugger: a port of the rust CKB Standalone Debugger, you can use offckb debugger <...params> just like using ckb-debugger <...params> with no installation required.

Migration from v0.2.x to v0.3.x

BREAKING CHANGES

  1. Rename Devnet chain name in dev.toml config from offckb to standard ckb_dev
  2. Rename sync-config to sync-scripts
  3. Rename deployed-scripts to my-scripts
  4. Templates offckb.config.ts file are refactored with NEW structure

Add new commands

  1. proxy-rpc
  2. system-scripts
  3. debug
  4. mol
  5. transfer-all
  6. repl