omnilock-cli

CKB omnilock command line tool.

For more information about omnilock, please visit the RFC 42

This tool can do omnilock related operations, like create a CKB omnilock address, transfer capacity from omnilock address to any address.

ckb-cli should be used to view transaction, get capacity from an address, view block information etc.

Now the tool can only build address for pubkey-hash/multisig/ethereum, and transfer from these type of addresses.

To be supported features:

Owner lock auth content;
Administrator mode;
anyone-can-pay mode;
time-lock mode;
supply mode;

Features

    config           configuration related operations
    build-address    build omni lock address
    generate-tx      generate a transaction not signed yet, with omnilock locked cell(s) as input
    sign             Sign the transaction
    send             Send the transaction

Configuration

The configuration file points out which cell the omnilock script was deployed, the url of the ckb rpc and the ckb index url.

The default configuration file is ~/.omnilock.yaml, it can be specified with --config parameter.

Create an empty configure file.

To init an empty configure file:

omnilock-cli config init

If the file already exist, you should remove it or rename it first.

To init a differen empty configure file:

omnilock-cli -c omnilock.yaml config init

Fill the configure file with correct content

After create the empty file, modify the file, fill the correct content, so you can use the configure file in the following operation.

Check the configure file

Check the default configuration file

omnilock-cli config check

-- Check the specified configuration file:

 omnilock-cli -c ~/.omnilock.yaml config check

Build omnilock address

Build a pubkey-hash address with receiver

# build with receiver's sighash address
omnilock-cli build-address pubkey-hash --sighash-address ckt1qyqt8xpk328d89zgl928nsgh3lelch33vvvq5u3024
# or build with receiver's pubkey-hash
omnilock-cli build-address pubkey-hash --pubkey-hash 0xb398368a8ed39448f95479c1178ff3fc5e316318

The output:

{
  "lock-arg": "0x00b398368a8ed39448f95479c1178ff3fc5e31631800",
  "lock-hash": "0x6b845964aad7f568edf61a69d1c2278c68065dc91bad3c32234869aed86f7642",
  "mainnet": "ckb1qqklkz85v4xt39ws5dd2hdv8xsy4jnpe3envjzvddqecxr0mgvrksqgqkwvrdz5w6w2y372508q30rlnl30rzcccqq2pnflw",
  "testnet": "ckt1qqklkz85v4xt39ws5dd2hdv8xsy4jnpe3envjzvddqecxr0mgvrksqgqkwvrdz5w6w2y372508q30rlnl30rzcccqq3k897x"
}

Build a multisig address

omnilock-cli build-address multisig --require-first-n 0 --threshold 2 \
                                    --sighash-address ckt1qyqt8xpk328d89zgl928nsgh3lelch33vvvq5u3024 \
                                    --sighash-address ckt1qyqvsv5240xeh85wvnau2eky8pwrhh4jr8ts8vyj37 \
                                    --sighash-address ckt1qyqywrwdchjyqeysjegpzw38fvandtktdhrs0zaxl4

The output:

{
  "lock-arg": "0x065d7d0128eeaa6f9656a229b42aadd0b177d387eb00",
  "lock-hash": "0xd93312782194cdb1a23dd73128795fd6a71ceb067ea9fd10546b95853d45f08e",
  "mainnet": "ckb1qqklkz85v4xt39ws5dd2hdv8xsy4jnpe3envjzvddqecxr0mgvrksqgxt47sz28w4fhev44z9x6z4twsk9ma8pltqqad8v6p",
  "testnet": "ckt1qqklkz85v4xt39ws5dd2hdv8xsy4jnpe3envjzvddqecxr0mgvrksqgxt47sz28w4fhev44z9x6z4twsk9ma8pltqqx6nqmf"
}

Build an ethereum address

Build with receiver's private key:

omnilock-cli build-address ethereum --ethereum-privkey 0x63d86723e08f0f813a36ce6aa123bb2289d90680ae1e99d4de8cdb334553f24d
# or build with ethereum public key
omnilock-cli build-address ethereum --ethereum-pubkey 0x038d3cfceea4f9c2e76c5c4f5e99aec74c26d6ac894648b5700a0b71f91f9b5c2a
# or build with ethereum addr
omnilock-cli build-address ethereum --ethereum-address 0xcf2485c76aff1f2b4464edf04a1c8045068cf7e0

The output:

{
  "lock-arg": "0x01cf2485c76aff1f2b4464edf04a1c8045068cf7e000",
  "lock-hash": "0x04b791304bbd6287218acc9e4b0971789ea1ef52b758317481245913511c6159",
  "mainnet": "ckb1qqklkz85v4xt39ws5dd2hdv8xsy4jnpe3envjzvddqecxr0mgvrksqgpeujgt3m2lu0jk3ryahcy58yqg5rgealqqq5yzrqv",
  "testnet": "ckt1qqklkz85v4xt39ws5dd2hdv8xsy4jnpe3envjzvddqecxr0mgvrksqgpeujgt3m2lu0jk3ryahcy58yqg5rgealqqq0nk0py"
}

Build with the compressed public key

omnilock-cli build-address ethereum --ethereum-pubkey 038d3cfceea4f9c2e76c5c4f5e99aec74c26d6ac894648b5700a0b71f91f9b5c2a

Build with the uncompressed public key

omnilock-cli build-address ethereum --ethereum-pubkey 048d3cfceea4f9c2e76c5c4f5e99aec74c26d6ac894648b5700a0b71f91f9b5c2a26b16aac1d5753e56849ea83bf795eb8b06f0b6f4e5ed7b8caca720595458039

Simple transfer capacity from an omnilock cell

This kind of transaction is suitable of unlock value of the cell.

Simple transfer from pubkey hash omnilock cell.

Build the address.

omnilock-cli build-address pubkey-hash --sighash-address ckt1qyqt8xpk328d89zgl928nsgh3lelch33vvvq5u3024

Transfer capacity to this address, if the address have enough capacity, you can skip this step. Be careful about the --skip-check-to-address parameter, please double check the receiver's address by yourself.

 ckb-cli wallet transfer --from-account 0xc8328aabcd9b9e8e64fbc566c4385c3bdeb219d7 \
  --to-address ckt1qqklkz85v4xt39ws5dd2hdv8xsy4jnpe3envjzvddqecxr0mgvrksqgqkwvrdz5w6w2y372508q30rlnl30rzcccqq3k897x \
  --capacity 99 --skip-check-to-address

Get live cells of the address

ckb-cli wallet get-live-cells --address ckt1qqklkz85v4xt39ws5dd2hdv8xsy4jnpe3envjzvddqecxr0mgvrksqgqkwvrdz5w6w2y372508q30rlnl30rzcccqq3k897x

Generate transaction

# 0xb398368a8ed39448f95479c1178ff3fc5e316318 is pubkey hash of address ckt1qyqt8xpk328d89zgl928nsgh3lelch33vvvq5u3024
omnilock-cli generate-tx pubkey-hash --pubkey-hash 0xb398368a8ed39448f95479c1178ff3fc5e316318 --capacity 98.99999588 --receiver ckt1qyqy68e02pll7qd9m603pqkdr29vw396h6dq50reug --tx-file tx.json

Sign the transaction

sign with according private key

omnilock-cli sign pubkey-hash --tx-file tx.json --sender-key 8dadf1939b89919ca74b58fef41c0d4ec70cd6a7b093a0c8ca5b268f93b8181f

Sign the with according account

omnilock-cli sign pubkey-hash --tx-file tx.json --from-account b398368a8ed39448f95479c1178ff3fc5e316318

Send the transaction

omnilock-cli send --tx-file tx.json
# >>> tx ac2cce746764cf9ecad7eefb82d24f8bcf5eb4708c65dde562bf96c86bbad831 sent! <<<

Simple transfer from multisig omnilock cell.

Build the address.

omnilock-cli build-address multisig --require-first-n 0 --threshold 2 \
                                    --sighash-address ckt1qyqt8xpk328d89zgl928nsgh3lelch33vvvq5u3024 \
                                    --sighash-address ckt1qyqvsv5240xeh85wvnau2eky8pwrhh4jr8ts8vyj37 \
                                    --sighash-address ckt1qyqywrwdchjyqeysjegpzw38fvandtktdhrs0zaxl4

result:

{
  "lock-arg": "0x065d7d0128eeaa6f9656a229b42aadd0b177d387eb00",
  "lock-hash": "0xd93312782194cdb1a23dd73128795fd6a71ceb067ea9fd10546b95853d45f08e",
  "mainnet": "ckb1qqklkz85v4xt39ws5dd2hdv8xsy4jnpe3envjzvddqecxr0mgvrksqgxt47sz28w4fhev44z9x6z4twsk9ma8pltqqad8v6p",
  "testnet": "ckt1qqklkz85v4xt39ws5dd2hdv8xsy4jnpe3envjzvddqecxr0mgvrksqgxt47sz28w4fhev44z9x6z4twsk9ma8pltqqx6nqmf"
}

Transfer capacity to this address, if the address have enough capacity, you can skip this step. Be careful about the --skip-check-to-address parameter, please double check the receiver's address by yourself.

 ckb-cli wallet transfer --from-account 0xc8328aabcd9b9e8e64fbc566c4385c3bdeb219d7 \
  --to-address ckt1qqklkz85v4xt39ws5dd2hdv8xsy4jnpe3envjzvddqecxr0mgvrksqgxt47sz28w4fhev44z9x6z4twsk9ma8pltqqx6nqmf \
  --capacity 99 --skip-check-to-address

Get live cells of the address

ckb-cli wallet get-live-cells --address ckt1qqklkz85v4xt39ws5dd2hdv8xsy4jnpe3envjzvddqecxr0mgvrksqgxt47sz28w4fhev44z9x6z4twsk9ma8pltqqx6nqmf

Generate transaction

 omnilock-cli generate-tx multisig --threshold 2 \
  --require-first-n 0 \
  --receiver ckt1qyqy68e02pll7qd9m603pqkdr29vw396h6dq50reug \
  --capacity 99.98 \
  --sighash-address ckt1qyqt8xpk328d89zgl928nsgh3lelch33vvvq5u3024 \
  --sighash-address ckt1qyqvsv5240xeh85wvnau2eky8pwrhh4jr8ts8vyj37 \
  --sighash-address ckt1qyqywrwdchjyqeysjegpzw38fvandtktdhrs0zaxl4 \
  --tx-file tx.json

Sign the transaction

Sign with according first private key

omnilock-cli sign multisig --sender-key 8dadf1939b89919ca74b58fef41c0d4ec70cd6a7b093a0c8ca5b268f93b8181f --tx-file tx.json

Sign with the second according private key

omnilock-cli sign multisig --sender-key d00c06bfd800d27397002dca6fb0993d5ba6399b4238b2f29ee9deb97593d2bc --tx-file tx.json

Send the transaction

omnilock-cli send --tx-file tx.json
# >>> tx 1a4e1f8bfa22abf5f1851f894a0873f5553d3396a3794caa015b5c276345f630 sent! <<<

Simple transfer from ethereum omnilock cell.

build the address.

omnilock-cli build-address ethereum --ethereum-privkey 0x63d86723e08f0f813a36ce6aa123bb2289d90680ae1e99d4de8cdb334553f24d
# or build with ethereum public key
omnilock-cli build-address ethereum --ethereum-pubkey 0x038d3cfceea4f9c2e76c5c4f5e99aec74c26d6ac894648b5700a0b71f91f9b5c2a
# or build with ethereum addr
omnilock-cli build-address ethereum --ethereum-address 0xcf2485c76aff1f2b4464edf04a1c8045068cf7e0

result:

{
  "lock-arg": "0x01cf2485c76aff1f2b4464edf04a1c8045068cf7e000",
  "lock-hash": "0x04b791304bbd6287218acc9e4b0971789ea1ef52b758317481245913511c6159",
  "mainnet": "ckb1qqklkz85v4xt39ws5dd2hdv8xsy4jnpe3envjzvddqecxr0mgvrksqgpeujgt3m2lu0jk3ryahcy58yqg5rgealqqq5yzrqv",
  "testnet": "ckt1qqklkz85v4xt39ws5dd2hdv8xsy4jnpe3envjzvddqecxr0mgvrksqgpeujgt3m2lu0jk3ryahcy58yqg5rgealqqq0nk0py"
}

Transfer capacity to this address, if the address have enough capacity, you can skip this step. Be careful about the --skip-check-to-address parameter, please double check the receiver's address by yourself.

 ckb-cli wallet transfer --from-account 0xc8328aabcd9b9e8e64fbc566c4385c3bdeb219d7 \
  --to-address ckt1qqklkz85v4xt39ws5dd2hdv8xsy4jnpe3envjzvddqecxr0mgvrksqgpeujgt3m2lu0jk3ryahcy58yqg5rgealqqq0nk0py \
  --capacity 99 --skip-check-to-address

Get live cells of the address

ckb-cli wallet get-live-cells --address ckt1qqklkz85v4xt39ws5dd2hdv8xsy4jnpe3envjzvddqecxr0mgvrksqgpeujgt3m2lu0jk3ryahcy58yqg5rgealqqq0nk0py

Generate transaction

omnilock-cli generate-tx ethereum  --sender-address 0xcf2485c76aff1f2b4464edf04a1c8045068cf7e0 \
                                   --receiver ckt1qyqy68e02pll7qd9m603pqkdr29vw396h6dq50reug \
                                   --capacity 99.0000849 \
                                   --tx-file tx.json

Sign the transaction

omnilock-cli sign ethereum --sender-key  63d86723e08f0f813a36ce6aa123bb2289d90680ae1e99d4de8cdb334553f24d \
                                 --tx-file tx.json

Send the transaction

omnilock-cli send --tx-file tx.json
# >>> tx 1688385f41c791f2ddae49c00064c7fcc260ba504558e7487d67ea86405fe582 sent! <<<

liuck8080/omnilock-cli

omnilock-cli

Features

Configuration

Create an empty configure file.

Fill the configure file with correct content

Check the configure file

Build omnilock address

Build a pubkey-hash address with receiver

Build a multisig address

Build an ethereum address

Simple transfer capacity from an omnilock cell

Simple transfer from pubkey hash omnilock cell.

Simple transfer from multisig omnilock cell.

Simple transfer from ethereum omnilock cell.

Manual transfer(todo)

Init empty transaction

Add input

Add output

Sign transaction

Send transaction