Deposit & Withdraw CKB on Godwoken
For deposit and withdrawal operations on Godwoken, two options are available:
- Using a UI deposit or withdrawal provided by yokaiswap to perform the relevant actions.
- Using
gw-toolsdeposit or withdrawal to perform the relevant actions, and the unlocking operation so as to complete the withdrawal process.
Using GW-tools to Deposit
To deposit CKBs onto Layer 2, user need to execute the gw-tools deposit command in the command line. If the user applied the quick mode with godwoken-kicker, which already has a deposit function, the user can carry out the deposit operation directly on http://localhost:6100/ .
Use --help to view the available commands, and replace the variables with the values matching one's own account and information.
cargo run --bin gw-tools -- deposit-ckb --help
Click to view detailed output
gw-tools-deposit-ckb
Deposit CKB to godwoken
USAGE:
gw-tools deposit-ckb [OPTIONS] --capacity <capacity> --config-path <config-path> --privkey-path <privkey-path> --scripts-deployment-path <scripts-deployment-path>
FLAGS:
-h, --help Prints help informaiton
-V, --version Prints version information
OPTIONS:
-c, --capacity <capacity> CKB capacity to deposit
--ckb-rpc <ckb-rpc-url> CKB jsonrpc rpc server URL [default: http://127.0.0.1:8114]
-o, --config-path <config-path> The config.homl file path
-e, --eth-address <eth-address> Target eth address, calculated by private key in default
-f, --fee <fee> Transaction fee, default to 0.0001 CKB [default: 0.0001]
-g, --godwoken-rpc-url <godwoken-rpc-url>
Godwoken jsonrpc rpc sever URL [default: http://127.0.0.1:8119]
-k, --privkey-path <privkey-path> The private key file path
--scripts-deployment-path <scripts-deployment-path>
The scripts deployment results json file path
For more information on the CKB RPC, refer to CKB Wiki
gw-tool deposit Subcommands
| command | description |
|---|---|
| capacity | The amount of CKB to deposit (Unit is CKB). |
| ckb-rpc | CKB node URL, defaults to http://127.0.0.1:8114/ |
| config-path | The config.toml file required for godwoken to run |
| eth-address | Target eth address to deposit |
| fee | The transaction fee, this is a CKB transaction and the default rate is 0.0001 CKB. |
| godwoken-rpc-url | The RPC address of Godwoken, by default http://127.0.0.1:8119/ |
| privkey-path | A file written with the private key (hex string) which is used to pay the deposit fee. |
| scripts-deployment-path | The JSON file path of the script's deployment results. |
Using GW-tools to Withdraw
There are two steps to withdraw assets from layer 2 to layer 1 on Godwoken, the first step is to make a withdrawal request. In comparison to deposits, withdrawals require more time. When a withdrawal is made to layer 1, the withdrawal depends on layer 2, but layer 2 has a lower level of security and for this reason, more confirmations will be required to ensure that security remains reliable. From the time the withdrawal is made, it takes approximately 5 days until the amount of funds is actually released at layer 1.
To withdraw funds from layer 2 to layer 1, execute the following gw-tools withdraw command, replace the variables with the values needed:
Use --help to view the available commands.
cargo run --bin gw-tools -- withdraw --help
Click to view detailed output
gw-tools-withdraw
withdraw CKB / sUDT from godwoken
USAGE:
gw-tools withdraw [OPTIONS] --capacity <capacity> --config-path <config-path> --owner-ckb-address <owner-ckb-address> --privkey-path <privkey-path> --scripts-deployment-path <scripts-deployment-path>
FLAGS:
-h, --help Prints help informaiton
-V, --version Prints version information
OPTIONS:
-m, --amount <amount> sUDT amount to withdrawal [default: 0]
-c, --capacity <capacity> CKB capacity to withdrawal
-o, --config-path <config-path> The config.homl file path
-g, --godwoken-rpc-url <godwoken-rpc-url>
Godwoken jsonrpc rpc sever URL [default: http://127.0.0.1:8119]
-a, --owner-ckb-address <owner-ckb-address> owner ckb address (to)
-k, --privkey-path <privkey-path> The private key file path
--scripts-deployment-path <scripts-deployment-path>
The scripts deployment results json file path
-sudt-script-hash <sudt-script-hash> l1 sudt script hash, default for withdrawal CKB [default: 0x0000000000000000000000000000000000000000000000000000000000000000]
For more information on Godwoken RPC, refer to Godwoken Public Network.
gw-tool withdraw Subcommands
| command | description |
|---|---|
| amount | The amount of sUDT |
| capacity | The amount of CKB to withdraw, the unit is CKB. |
| config-path | The config.toml file required for godwoken to run. |
| godwoken-rpc-url | The RPC address of Godwoken, by default http://127.0.0.1:8119/ |
| owner-ckb-address | The CKB address of the recipient. |
| privkey-path | A file written with the private key (hex string) which is used to pay the deposit fee. |
| scripts-deployment-path | The JSON file path of the script's deployment results |
| sudt-script-hash | The script hash of sUDT on layer 1, defaults to 0x0000000000000000000000000000000000000000000000000000, indicating only CKB is redeemed (amount left unfilled or filled with 0). |
Unlocking the Funds to Complete Withdrawal Process
Withdrawing funds from Godwoken is a two-step process. Step one initiates the withdrawal and step two releases the funds. Godwoken uses an optimistic rollup architecture that permits only one honest node in the network. All this provides a very secure foundation for Layer 2, but comes at the cost of a 5-day 'challenge period' when exiting from Layer 2. This is a period where the Layer 2 network operator gets time to examine and flag up any potential problems with malicious transactions and roll back if necessary. The five-day challenge period will begin once the withdrawal process has commenced. The five-day time interval is a bit long but necessary.
To unlock the withdrawal cells to normal ckb cells and to perform common Layer2 actions, the account-cli tool will be applied.
Execute the account-cli tool unlock command:
Use --help to view the available commands.
# devnet
export LUMOS_CONFIG_FILE=./kicker-lumos-config.json node ./packages/tools/lib/account-cli.js unlock --help
# testnet
export LUMOS_CONFIG_NAME="AGGRON4" node ./packages/tools/lib/account-cli.js unlock --help
# mainnet
export LUMOS_CONFIG_NAME="LINA" node ./packages/tools/lib/account-cli.js unlock --help
Click to view detailed output
LUMOS_CONFIG_FILE=./kicker-lumos-config.json node ./packages/tools/lib/account-cli.js unlock --help
Usage: account-cli unlock [options]
unlock withdrawal CKB / sUDT from godwoken
Options:
-p, --private-key <privatekey> private key to use
-s, --sudt-script-args <l1 sudt script args> only for unlock sudt
-r, --rpc <rpc> ckb rpc path (default: "http://127.0.0.1:8114")
-d, --indexer-path <path> indexer path (default: "./indexer-data-path/<ckb genesis hash>")
-h, --help display help for command
Note: The private key you pass to unlock command needs to be the same as the one that corresponds with the Layer 1 address that was previously used with the withdraw and deposit.
account-cli unlock Subcommands
| command | description |
|---|---|
| LUMOS_CONFIG_FILE | The environment variable, filled with the lumos config json file path, or simply the name if it is on the testnet / mainnet |
| private-key | The private key |
| sudt-script-args | Layer1 sudt script args, or sudt token |
| rpc | The rpc address of CKB, with a default value |
| indexer-path | The path of Lumos indexer, with a default value, no need to fill in generally |
For more information on Lumos, please refer to https://github.com/nervosnetwork/lumos .
Code Example
For developers who need additional code details, refer to gw-demos for more detailed examples.