{"id":31745006,"url":"https://github.com/dotbithq/cctoken-merchant-tool","last_synced_at":"2025-10-09T12:28:44.384Z","repository":{"id":245293775,"uuid":"817818481","full_name":"dotbitHQ/ccToken-merchant-tool","owner":"dotbitHQ","description":null,"archived":false,"fork":false,"pushed_at":"2024-11-15T04:27:30.000Z","size":40,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-11-15T05:24:02.813Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dotbitHQ.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-20T13:58:33.000Z","updated_at":"2024-11-15T04:27:34.000Z","dependencies_parsed_at":"2024-11-15T05:32:42.390Z","dependency_job_id":null,"html_url":"https://github.com/dotbitHQ/ccToken-merchant-tool","commit_stats":null,"previous_names":["dotbithq/cctoken-mint-tool"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/dotbitHQ/ccToken-merchant-tool","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotbitHQ%2FccToken-merchant-tool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotbitHQ%2FccToken-merchant-tool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotbitHQ%2FccToken-merchant-tool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotbitHQ%2FccToken-merchant-tool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dotbitHQ","download_url":"https://codeload.github.com/dotbitHQ/ccToken-merchant-tool/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotbitHQ%2FccToken-merchant-tool/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279001445,"owners_count":26083078,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-10-09T12:28:22.878Z","updated_at":"2025-10-09T12:28:44.376Z","avatar_url":"https://github.com/dotbitHQ.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CCToken Merchant Tool\n\nThis command line tool for merchants of the [CCToken](https://www.crosschain.network/). It is a simple command line tool that allows merchants to send `request_mint/request_burn/transfer` transaction on [CKB](https://www.nervos.org/).\n\n\n## Building\n\nBecause this tool reads your private key to sign the transaction, it is recommended to build the tool from the source code. Since it is built on Node.js, it is relatively easy to do so on Mac OS or Linux. Please note that Windows compatibility has not been tested yet.\n\nAfter building it will create 3 binariesin the `build/` directory for each platform. This allows one developer to build and distribute the binary to others.\n\n### Prerequisites\n\n- Nodejs(\u003e=20) installed, and the `npm` command can work properly.\n- Good network connection to npm registry.\n\n### Building\n\n```bash\nnpm install\nnpm run build\n```\n\nYou may see a lot of warning after building, but it is safe to ignore them. They are cause by the `axios` in `node_modules/`, but the binary is built from single file in `dist/` which is bundled by webpack.\n\nThe final binaries are in the `build/` directory.\n\n\n## Usage\n\nAfter building the tool, one can use the binary in `build/` directory. The tool requires the following parameters:\n\n```bash\nUsage: index [options] [command]\n\nOptions:\n  -f, --fee \u003cfee\u003e                   The total fee of the CKB transaction (default: \"10000\")\n  -p, --private-key \u003cprivateKey\u003e    Merchant private key. Please use environment variable\n                                    MERCHANT_PRIVATE_KEY instead in production environment.\n  -a, --merchant-address \u003caddress\u003e  Merchant address\n  -u, --rpc-url \u003curl\u003e               The base url of CKB RPC.\n  -V, --verbose                     Show verbose debug messages. (default: false)\n  -h, --help                        display help for command\n\nCommands:\n  mint [options]\n  burn [options]\n  transfer [options]\n  help [command]                    display help for command\n```\n\nThere are three subcommands: `mint`, `burn`, and `transfer`. All of them have common parameters:\n\n- `--fee` is the total fee of the CKB transaction.\n- `--private-key` is the private key of the merchant.\n- `--merchant-address` is the address of the merchant.\n- `--rpc-url` is the base url of CKB RPC.\n\nSome of the common parameters can also be passed as environment variables:\n\n- `MERCHANT_PRIVATE_KEY`: Merchant private key.\n- `CKB_RPC_URL`: The CKB RPC url.\n\n**Please note that the `--value` parameter always requires a u128 type value. For example, if you wish to mint 0.1 ccBTC with 8 decimal places, you should input `10000000` (10,000,000) as the value. The `--value` cannot be negative or exceed the maximum u128 value.**\n\nEach subcommand has its own parameters. Please refer to the following sections for instructions on how to use them.\n\n### Minting\n\nTo mint 0.1 BTC token, and the private key is passed as environment variable, one can use the following command:\n\n```bash\n{your_binary_path} --rpc-url http://localhost:8114 \\\n--merchant-address ckt1... \\\nmint \\\n--coin-type BTC \\\n--tx-hash 0x... \\\n--value 10000000\n```\n\n### Transfer\n\nTo transfer 0.1 BTC token, and the private key is passed as environment variable, one can use the following command:\n\n```bash\n{your_binary_path} --rpc-url http://localhost:8114 \\\n--merchant-address ckt1... \\\ntransfer \\\n--coin-type BTC \\\n--to ckt1... \\\n--value 10000000\n```\n\n### Burning\n\nTo burn 0.1 BTC token, and the private key is passed as environment variable, one can use the following command:\n\n```bash\n{your_binary_path} --rpc-url http://localhost:8114 \\\n--merchant-address ckt1... \\\nburn \\\n--to ckt1... \\\n--coin-type BTC \\\n--receipt_addr tb1... \\\n--value 10000000\n```\n\nPlease note that the `--to` parameter represents the multisig address of custodians, so the available value may vary\ndepending on the CCToken's daily management. Therefore, **it is essential to always verify if the address has been updated**.\n\nThe current multisig address of custodians are:\n\n\u003e The multisig address of cusodians:\n\u003e\n\u003e - Mainnet: ckb1qzdcr9un5ezx8tkh03s46m9jymh22jruelq8svzr5krj2nx69dhjvqgxvm0a2jw0q85l0mf687m7ksdkyj5cejaxqqpthcud\n\u003e - Testnet: ckt1qpa0qahsffdrsxtuu97tc2u2wzwaeel3dc7fjjm3vurvtggrggqquqgx2a48py5vhs2ew4g9tsr988r9mvtz8xn8qq388fz6\n\nThe `--receipt_addr` parameter is the receipt address of the BTC, the address WILL NOT BE VERIFIED, please make sure it is in the your whitelist on the CCToken's platform.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdotbithq%2Fcctoken-merchant-tool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdotbithq%2Fcctoken-merchant-tool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdotbithq%2Fcctoken-merchant-tool/lists"}