@offckb/cli 0.3.4 → 0.4.0-canary-113bf31.0

package/README.md

@@ -8,45 +8,14 @@
 
 CKB local development network for your first try.
 
-- One-line command to start a devnet
-- No docker required
+- One-line command to start a devnet, no docker required
 - Pre-funded test accounts
 - Built-in scripts like [Omnilock](https://github.com/cryptape/omnilock) and [Spore-contract](https://github.com/sporeprotocol/spore-contract)
-- Multiple minimal dApp templates to learn and get your hands dirty
-
-**Migrate from v0.2.x to v0.3.x:**
-
-There are BREAKING CHANGES between v0.2.x and v0.3.x, make sure to read the [migration guide](/docs/migration.md) before upgrading.
-
-## Table of Contents
-
-- [OffCKB](#offckb)
-- [Table of Contents](#table-of-contents)
-- [Install](#install)
-- [Usage](#usage)
-- [Get started](#get-started)
-  - [Running CKB](#running-ckb)
-  - [List scripts info](#list-scripts-info)
-  - [Tweak Devnet Config](#tweak-devnet-config)
-  - [Create a full-stack Project](#create-a-full-stack-project)
-  - [Create a script-only Project](#create-a-script-only-project)
-  - [Build and Deploy a script](#build-and-deploy-a-script)
-  - [Start the frontend project](#start-the-frontend-project)
-  - [Debug a transaction](#debug-a-transaction)
-  - [Generate Moleculec bindings](#generate-moleculec-bindings)
-- [REPL Mode](#repl-mode)
-  - [Start the OffCKB REPL](#start-the-offckb-repl)
-  - [Build CKB transaction in REPL](#build-ckb-transaction-in-repl)
-  - [Get balance in REPL](#get-balance-in-repl)
-- [Config Setting](#config-setting)
-  - [List All Settings](#list-all-settings)
-  - [Set CKB version](#set-ckb-version)
-  - [Set Network Proxy](#set-network-proxy)
-- [Built-in scripts](#built-in-scripts)
-- [Accounts](#accounts)
-- [About CCC](#about-ccc)
-- [FAQ](#faq)
-- [Contributing](#contributing)
+- Create boilerplate project to build your CKB dApp
+
+**Migrate from v0.3.x to v0.4.x:**
+
+There are BREAKING CHANGES between v0.3.x and v0.4.x, make sure to read the [migration guide](/docs/migration.md) before upgrading.
 
 ## Install
 
@@ -74,12 +43,10 @@ Options:
   -h, --help                                    display help for command
 
 Commands:
-  create [options] [your-project-name]          Create a new dApp from bare templates
   node [options] [CKB-Version]                  Use the CKB to start devnet
-  proxy-rpc [options]                           Start the rpc proxy server
+  create [options] [your-project-name]          Create a new dApp from bare templates
   clean                                         Clean the devnet data, need to stop running the chain first
   accounts                                      Print account list info
-  list-hashes [CKB-Version]                     Use the CKB to list blockchain scripts hashes
   inject-config                                 Add offckb.config.ts to your frontend workspace
   sync-scripts                                  Sync scripts json files in your frontend workspace
   deposit [options] [toAddress] [amountInCKB]   Deposit CKB tokens to address, only devnet and testnet
@@ -91,8 +58,6 @@ Commands:
   config <action> [item] [value]                do a configuration action
   debug [options]                               CKB Debugger for development
   system-scripts [options]                      Output system scripts of the local devnet
-  mol [options]                                 Generate CKB Moleculec binding code for development
-  repl [options]                                A custom Nodejs REPL environment bundle for CKB.
   help [command]                                display help for command
 ```
 
@@ -121,19 +86,7 @@ offckb config set ckb-version 0.117.0
 offckb node
 ```
 
-Once you start the devnet, there is a RPC server running at `http://localhost:8114`. There is also a RPC proxy server running at `http://localhost:9000` which will proxy all the requests to the RPC server. The meaning of using a proxy RPC server is to record request and automatically dump failed transactions so you can debug them easily later.
-
-The proxy server is optional, you can use the RPC server directly if you don't need a proxy:
-
-```sh
-offckb node --no-proxy
-```
-
-Or start the proxy server in a standalone terminal to better monitor the logs:
-
-```sh
-offckb proxy-rpc --ckb-rpc http://localhost:8114 --port 9000 --network devnet
-```
+Once you start the devnet, there is a RPC server running at `http://localhost:8114`. There is also a RPC proxy server running at `http://localhost:28114` which will proxy all the requests to the RPC server. The meaning of using a proxy RPC server is to record request and automatically dump failed transactions so you can debug them easily later.
 
 ### List scripts info
 
@@ -206,7 +159,15 @@ You can create a new script project without a frontend. This is useful when you
 offckb create <your-project-name> --script
 ```
 
-Note: you need to have rust/cargo/cargo-generate/clang 16+ installed in your environment to use this command. offckb doesn't do anything really, it just call [ckb-script-template](https://github.com/cryptape/ckb-script-templates) to do all the magic.
+Note: you need to have pnpm installed in your environment to use this command. offckb doesn't do anything really, it just call [create-js-vm-app](https://github.com/nervosnetwork/ckb-js-vm/tree/main/packages/create-app) to do all the magic.
+
+### Create a dApp-only Project
+
+You can create a new dApp project without the script(CKB Smart Contract). This is useful when you don't need to create your own on-chain script logic.
+
+```sh
+offckb create <your-project-name> --dapp # or -d
+```
 
 ### Build and Deploy a script
 
@@ -309,88 +270,6 @@ offckb debug <transaction-hash> --single-script <single-cell-script-option> --bi
 
 All the debug utils are borrowed from [ckb-debugger](https://github.com/nervosnetwork/ckb-standalone-debugger/tree/develop/ckb-debugger).
 
-### Generate Moleculec bindings
-
-[Moleculec](https://github.com/nervosnetwork/molecule) is the official Serialization/Deserialization system for CKB smart contracts.
-
-You will define your data structure in `.mol` file(schema), and generate the bindings for different programming languages to use in your development.
-
-```sh
-offckb mol --schema <path/to/mol/file> --output <path/to/output/file> --lang <lang>
-```
-
-The `lang` could be `ts`, `js`, `c`, `rs` and `go`.
-
-If you have multiple `.mol` files, you can use a folder as the input and specify an output folder:
-
-```sh
-offckb mol --schema <path/to/mol/folder> --output-folder <path/to/output/folder> --lang <lang>
-```
-
-## REPL Mode
-
-OffCKB pack a custom Nodejs REPL with built-in variables and functions to help you develop CKB right in the terminal with minimal effort. This is suitable for simple script testing task when you don't want to write long and serious codes.
-
-### Start the OffCKB REPL
-
-```sh
-offckb repl --network <devnet/testnet/mainnet, default: devnet>
-
-Welcome to OffCKB REPL!
-[[ Default Network: devnet, enableProxyRPC: false ]]
-Type 'help()' to learn how to use.
-OffCKB > 
-```
-
-Type `help()` to learn about the built-in variables and functions:
-
-```sh
-OffCKB > help()
-
-OffCKB Repl, a Nodejs REPL with CKB bundles.
-
-Global Variables to use:
-  - ccc, cccA, imported from CKB Javascript SDK CCC
-  - client, a CCC client instance bundle with current network
-  - Client, a Wrap of CCC client class, you can build new client with
-     const myClient = Client.new('devnet' | 'testnet' | 'mainnet');
-     // or
-     const myClient = Client.fromUrl('<your rpc url>', 'devnet' | 'testnet' | 'mainnet');
-  - accounts, test accounts array from OffCKB
-  - networks, network information configs
-  - help, print this help message
-```
-
-### Build CKB transaction in REPL
-
-```sh
-OffCKB > let amountInCKB = ccc.fixedPointFrom(63);
-OffCKB > let tx = ccc.Transaction.from({
-...   outputs: [
-...     {
-...       capacity: ccc.fixedPointFrom(amountInCKB),
-...       lock: accounts[0].lockScript,
-...     },
-...   ],
-... });
-OffCKB > let signer = new ccc.SignerCkbPrivateKey(client, accounts[0].privkey);
-OffCKB > await tx.completeInputsByCapacity(signer);
-2
-OffCKB > await tx.completeFeeBy(signer, 1000);
-[ 0, true ]
-OffCKB > await mySigner.sendTransaction(tx)
-'0x50fbfa8c47907d6842a325e85e48d5da6917e16ca7e2253ec3bd5bcdf8da99ce'
-```
-
-### Get balance in REPL
-
-```sh
-OffCKB > let myClient = Client.fromUrl(networks.testnet.rpc_url, 'testnet');
-OffCKB > await myClient.getBalanceSingle(accounts[0].lockScript);
-60838485293944n
-OffCKB > 
-```
-
 ## Config Setting
 
 ### List All Settings