@offckb/cli 0.3.0-canary-0e33d0a.0 → 0.3.0-canary-119a74a.0

package/README.md

@@ -32,6 +32,10 @@ Start building on CKB blockchain, right now, right away!
   - [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)
@@ -48,7 +52,7 @@ Start building on CKB blockchain, right now, right away!
 npm install -g @offckb/cli
 ```
 
-_We recommand using [LTS](https://nodejs.org/en/download/package-manager) version of Node to run `offckb`_
+_We recommend using [LTS](https://nodejs.org/en/download/package-manager) version of Node to run `offckb`_
 
 ## Usage
 
@@ -80,6 +84,7 @@ Commands:
   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
 ```
 
@@ -308,6 +313,70 @@ If you have multiple `.mol` files, you can use a folder as the input and specify
 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

package/dist/cli.js

@@ -54,6 +54,7 @@ const proxy_rpc_1 = require("./cmd/proxy-rpc");
 const mol_1 = require("./cmd/mol");
 const fs = __importStar(require("fs"));
 const transfer_all_1 = require("./cmd/transfer-all");
+const repl_1 = require("./cmd/repl");
 const version = require('../package.json').version;
 const description = require('../package.json').description;
 // fix windows terminal encoding of simplified chinese text
@@ -186,6 +187,12 @@ program
     }
     return (0, mol_1.molSingleFile)(option.schema, option.output, option.lang);
 }));
+program
+    .command('repl')
+    .description('A custom Nodejs REPL environment bundle for CKB.')
+    .option('--network <network>', 'Specify the network to deploy to', 'devnet')
+    .option('-r, --proxy-rpc', 'Use Proxy RPC to connect to blockchain')
+    .action(repl_1.repl);
 program.parse(process.argv);
 // If no command is specified, display help
 if (!process.argv.slice(2).length) {

package/dist/cmd/repl.d.ts

@@ -0,0 +1,11 @@
+import { ccc } from '@ckb-ccc/core';
+import { Network, NetworkOption } from '../type/base';
+export interface ReplProp extends NetworkOption {
+    proxyRpc?: boolean;
+}
+export declare function repl({ network, proxyRpc }: ReplProp): void;
+export declare function initGlobalClientBuilder(): {
+    new: (network: Network) => ccc.ClientPublicTestnet | ccc.ClientPublicMainnet;
+    fromUrl: (rpcUrl: string, network: Network) => ccc.ClientPublicTestnet | ccc.ClientPublicMainnet;
+};
+export declare function printHelpText(): void;

package/dist/cmd/repl.js

@@ -0,0 +1,75 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.printHelpText = exports.initGlobalClientBuilder = exports.repl = void 0;
+const repl_1 = require("repl");
+const core_1 = require("@ckb-ccc/core");
+const advanced_1 = require("@ckb-ccc/core/advanced");
+const network_1 = require("../sdk/network");
+const base_1 = require("../type/base");
+const private_1 = require("../scripts/private");
+const account_json_1 = __importDefault(require("../../account/account.json"));
+const validator_1 = require("../util/validator");
+function repl({ network = base_1.Network.devnet, proxyRpc = false }) {
+    (0, validator_1.validateNetworkOpt)(network);
+    console.log(
+    // Note remember update the CCC version since require CCC's package.json not work
+    `Welcome to OffCKB REPL!\n[[ Default Network: ${network}, enableProxyRPC: ${proxyRpc}, CCC SDK: 0.0.16-alpha.3 ]]\nType 'help()' to learn how to use.`);
+    const context = (0, repl_1.start)({
+        prompt: 'OffCKB > ',
+        ignoreUndefined: true,
+        useColors: true,
+    }).context;
+    context.ccc = core_1.ccc;
+    context.cccA = advanced_1.cccA;
+    context.networks = network_1.networks;
+    context.Client = initGlobalClientBuilder();
+    context.client = initGlobalClientBuilder().new(network);
+    context.accounts = account_json_1.default;
+    context.help = printHelpText;
+}
+exports.repl = repl;
+function initGlobalClientBuilder() {
+    return {
+        new: (network) => {
+            return network === 'mainnet'
+                ? new core_1.ccc.ClientPublicMainnet()
+                : network === 'testnet'
+                    ? new core_1.ccc.ClientPublicTestnet()
+                    : new core_1.ccc.ClientPublicTestnet({
+                        url: network_1.networks.devnet.rpc_url,
+                        scripts: (0, private_1.buildCCCDevnetKnownScripts)(),
+                    });
+        },
+        fromUrl: (rpcUrl, network) => {
+            return network === 'mainnet'
+                ? new core_1.ccc.ClientPublicMainnet({ url: rpcUrl })
+                : network === 'testnet'
+                    ? new core_1.ccc.ClientPublicTestnet({ url: rpcUrl })
+                    : new core_1.ccc.ClientPublicTestnet({
+                        url: rpcUrl,
+                        scripts: (0, private_1.buildCCCDevnetKnownScripts)(),
+                    });
+        },
+    };
+}
+exports.initGlobalClientBuilder = initGlobalClientBuilder;
+function printHelpText() {
+    return console.log(`
+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
+`);
+}
+exports.printHelpText = printHelpText;

package/dist/template/option.js

@@ -1,11 +1,23 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadBareTemplateOpts = void 0;
-const option_json_1 = __importDefault(require("./option.json"));
+const templates = [
+    {
+        name: 'Remix-Vite Bare Templates',
+        value: 'remix-vite-template',
+        description: 'A full-stack template with Remix-vite and ckb-script-templates',
+        tag: ['remix', 'vite', 'tailwindcss', 'ckb-script-templates', 'typescript', 'rust'],
+        author: 'retric@cryptape.com',
+    },
+    {
+        name: 'Next.js Bare Templates',
+        value: 'next-js-template',
+        description: 'A full-stack template with Next.js framework and ckb-script-templates',
+        tag: ['next.js', 'tailwindcss', 'ckb-script-templates', 'typescript', 'rust'],
+        author: 'retric@cryptape.com',
+    },
+];
 function loadBareTemplateOpts() {
-    return option_json_1.default;
+    return templates;
 }
 exports.loadBareTemplateOpts = loadBareTemplateOpts;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@offckb/cli",
-  "version": "0.3.0-canary-0e33d0a.0",
+  "version": "0.3.0-canary-119a74a.0",
   "description": "ckb development network for your first try",
   "author": "CKB EcoFund",
   "license": "MIT",

package/dist/template/option.json

@@ -1,16 +0,0 @@
-[
-    {
-        "name": "Remix-Vite Bare Templates",
-        "value": "remix-vite-template",
-        "description": "A full-stack template with Remix-vite and ckb-script-templates",
-        "tag": ["remix", "vite", "tailwindcss", "ckb-script-templates", "typescript", "rust"],
-        "author": "retric@cryptape.com"
-    },
-    {
-        "name": "Next.js Bare Templates",
-        "value": "next-js-template",
-        "description": "A full-stack template with Next.js framework and ckb-script-templates",
-        "tag": ["next.js", "tailwindcss", "ckb-script-templates", "typescript", "rust"],
-        "author": "retric@cryptape.com"
-    }
-]