mirror of
https://github.com/alexgo-io/stacks.js.git
synced 2026-01-12 22:52:34 +08:00
chore: surround examples in code blocks ``...``
This commit is contained in:
Diwaker Gupta
@@ -160,7 +160,7 @@ export const CLI_ARGS = {
|
||||
'network will process it once the transaction reaches 7 confirmations.\n' +
|
||||
'\n' +
|
||||
'Examples:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ # Tip: You can obtain the owner key with the get_owner_keys command\n' +
|
||||
' $ export OWNER_KEY="136ff26efa5db6f06b28f9c8c7a0216a1a52598045162abfe435d13036154a1b01"\n' +
|
||||
' $ stx announce 737c631c7c5d911c6617993c21fba731363f1cfe "$OWNER_KEY"\n' +
|
||||
@@ -169,6 +169,7 @@ export const CLI_ARGS = {
|
||||
' $ export OWNER_KEY="2,136ff26efa5db6f06b28f9c8c7a0216a1a52598045162abfe435d13036154a1b01,1885cba486a42960499d1f137ef3a475725ceb11f45d74631f9928280196f67401,2418981c7f3a91d4467a65a518e14fafa30e07e6879c11fab7106ea72b49a7cb01"\n' +
|
||||
' $ stx announce 737c631c7c5d911c6617993c21fba731363f1cfe "$OWNER_KEY"\n' +
|
||||
' 8136a1114098893b28a693e8d84451abf99ee37ef8766f4bc59808eed76968c9\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Peer Services',
|
||||
},
|
||||
@@ -211,14 +212,15 @@ export const CLI_ARGS = {
|
||||
'then you will be prompted for your password before any authentication takes place.\n' +
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ export BACKUP_PHRASE="oak indicate inside poet please share dinner monitor glow hire source perfect"\n' +
|
||||
' $ export APP_GAIA_HUB="https://1.2.3.4"\n' +
|
||||
' $ export PROFILE_GAIA_HUB="https://hub.blockstack.org"\n' +
|
||||
' $ stx authenticator "$APP_GAIA_HUB" "$BACKUP_PHRASE" "$PROFILE_GAIA_HUB" 8888\n' +
|
||||
' Press Ctrl+C to exit\n' +
|
||||
' Authentication server started on 8888\n',
|
||||
group: 'Authentication',
|
||||
' Authentication server started on 8888\n' +
|
||||
'```\n',
|
||||
group: 'Authentication',
|
||||
},
|
||||
balance: {
|
||||
type: 'array',
|
||||
@@ -238,7 +240,7 @@ export const CLI_ARGS = {
|
||||
'token (i.e. satoshis for BTC, microStacks for Stacks, etc.).\n' +
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ stx balance 16pm276FpJYpm7Dv3GEaRqTVvGPTdceoY4\n' +
|
||||
' {\n' +
|
||||
' "BTC": "123456"\n' +
|
||||
@@ -248,8 +250,9 @@ export const CLI_ARGS = {
|
||||
' {\n' +
|
||||
' "BTC": "123456"\n' +
|
||||
' "STACKS": "123456"\n' +
|
||||
' }\n',
|
||||
group: 'Account Management',
|
||||
' }' +
|
||||
'```\n',
|
||||
group: 'Account Management',
|
||||
},
|
||||
can_stack: {
|
||||
type: 'array',
|
||||
@@ -285,11 +288,12 @@ export const CLI_ARGS = {
|
||||
'Check if specified account can stack a number of Stacks tokens for given number of cycles.\n' +
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ stx can_stack 10000000 20 16pm276FpJYpm7Dv3GEaRqTVvGPTdceoY4 SPZY1V53Z4TVRHHW9Z7SFG8CZNRAG7BD8WJ6SXD0\n' +
|
||||
' {\n' +
|
||||
' "eligible": true\n' +
|
||||
' }\n',
|
||||
' }\n' +
|
||||
'```\n',
|
||||
group: 'Account Management',
|
||||
},
|
||||
call_contract_func: {
|
||||
@@ -340,6 +344,7 @@ export const CLI_ARGS = {
|
||||
'If the command succeeds, it prints out a transaction ID.' +
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'```\n' +
|
||||
' $ export PAYMENT="bfeffdf57f29b0cc1fab9ea197bb1413da2561fe4b83e962c7f02fbbe2b1cd5401"\n' +
|
||||
' $ stx call_contract_func SPBMRFRPPGCDE3F384WCJPK8PQJGZ8K9QKK7F59X contract_name' +
|
||||
' contract_function 1 0 "$PAYMENT"\n' +
|
||||
@@ -347,6 +352,7 @@ export const CLI_ARGS = {
|
||||
" txid: '0x2e33ad647a9cedacb718ce247967dc705bc0c878db899fdba5eae2437c6fa1e1'," +
|
||||
" transaction: 'https://explorer.hiro.so/txid/0x2e33ad647a9cedacb718ce247967dc705bc0c878db899fdba5eae2437c6fa1e1'" +
|
||||
' }\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Account Management',
|
||||
},
|
||||
@@ -386,12 +392,14 @@ export const CLI_ARGS = {
|
||||
'If the command succeeds, it prints out a Clarity value.' +
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'```\n' +
|
||||
' $ stx call_read_only_contract_func SPBMRFRPPGCDE3F384WCJPK8PQJGZ8K9QKK7F59X contract_name' +
|
||||
' contract_function SPBMRFRPPGCDE3F384WCJPK8PQJGZ8K9QKK7F59X\n' +
|
||||
' {\n' +
|
||||
" txid: '0x2e33ad647a9cedacb718ce247967dc705bc0c878db899fdba5eae2437c6fa1e1'," +
|
||||
" transaction: 'https://explorer.hiro.so/txid/0x2e33ad647a9cedacb718ce247967dc705bc0c878db899fdba5eae2437c6fa1e1'" +
|
||||
' }\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Account Management',
|
||||
},
|
||||
@@ -418,12 +426,14 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ stx decode_cv 0x050011deadbeef11ababffff11deadbeef11ababffff\n' +
|
||||
' S08XXBDYXW8TQAZZZW8XXBDYXW8TQAZZZZ88551S\n' +
|
||||
' $ stx decode_cv --format json SPA2MZWV9N67TBYVWTE0PSSKMJ2F6YXW7CBE6YPW\n' +
|
||||
' {"type":"principal","value":"S08XXBDYXW8TQAZZZW8XXBDYXW8TQAZZZZ88551S"}\n' +
|
||||
' $ echo 0x050011deadbeef11ababffff11deadbeef11ababffff | stx decode_cv -\n' +
|
||||
' S08XXBDYXW8TQAZZZW8XXBDYXW8TQAZZZZ88551S\n',
|
||||
' S08XXBDYXW8TQAZZZW8XXBDYXW8TQAZZZZ88551S\n' +
|
||||
'```\n',
|
||||
group: 'Utilities',
|
||||
},
|
||||
convert_address: {
|
||||
@@ -443,6 +453,7 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ stx convert_address 12qdRgXxgNBNPnDeEChy3fYTbSHQ8nfZfD\n' +
|
||||
' {\n' +
|
||||
' "mainnet": {\n' +
|
||||
@@ -478,7 +489,8 @@ export const CLI_ARGS = {
|
||||
' "STACKS": "STA2MZWV9N67TBYVWTE0PSSKMJ2F6YXW7DX96QAM",\n' +
|
||||
' "BTC": "mhMaijcwVPcdAthFwmgLsaknTRt72GqQYo"\n' +
|
||||
' }\n' +
|
||||
' }\n',
|
||||
' }\n' +
|
||||
'```\n',
|
||||
group: 'Account Management',
|
||||
},
|
||||
decrypt_keychain: {
|
||||
@@ -505,10 +517,12 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ # password is "asdf"\n' +
|
||||
' $ stx decrypt_keychain "bfMDtOucUGcJXjZo6vkrZWgEzue9fzPsZ7A6Pl4LQuxLI1xsVF0VPgBkMsnSLCmYS5YHh7R3mNtMmX45Bq9sNGPfPsseQMR0fD9XaHi+tBg=\n' +
|
||||
' Enter password:\n' +
|
||||
' section amount spend resemble spray verify night immune tattoo best emotion parrot',
|
||||
' section amount spend resemble spray verify night immune tattoo best emotion parrot\n' +
|
||||
'```\n' +
|
||||
group: 'Key Management',
|
||||
},
|
||||
deploy_contract: {
|
||||
@@ -553,12 +567,14 @@ export const CLI_ARGS = {
|
||||
'If the command succeeds, it prints out a transaction ID.' +
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'```\n' +
|
||||
' $ export PAYMENT="bfeffdf57f29b0cc1fab9ea197bb1413da2561fe4b83e962c7f02fbbe2b1cd5401"\n' +
|
||||
' $ stx deploy_contract ./my_contract.clar my_contract 1 0 "$PAYMENT"\n' +
|
||||
' {\n' +
|
||||
" txid: '0x2e33ad647a9cedacb718ce247967dc705bc0c878db899fdba5eae2437c6fa1e1'," +
|
||||
" transaction: 'https://explorer.hiro.so/txid/0x2e33ad647a9cedacb718ce247967dc705bc0c878db899fdba5eae2437c6fa1e1'" +
|
||||
' }\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Account Management',
|
||||
},
|
||||
@@ -601,11 +617,13 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ # password is "asdf"\n' +
|
||||
' $ stx encrypt_keychain "section amount spend resemble spray verify night immune tattoo best emotion parrot"\n' +
|
||||
' Enter password:\n' +
|
||||
' Enter password again:\n' +
|
||||
' M+DnBHYb1fgw4N3oZ+5uTEAua5bAWkgTW/SjmmBhGGbJtjOtqVV+RrLJEJOgT35hBon4WKdGWye2vTdgqDo7+HIobwJwkQtN2YF9g3zPsKk=',
|
||||
' M+DnBHYb1fgw4N3oZ+5uTEAua5bAWkgTW/SjmmBhGGbJtjOtqVV+RrLJEJOgT35hBon4WKdGWye2vTdgqDo7+HIobwJwkQtN2YF9g3zPsKk=' +
|
||||
'```\n',
|
||||
group: 'Key Management',
|
||||
},
|
||||
faucet: {
|
||||
@@ -626,11 +644,13 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ # password is "asdf"\n' +
|
||||
' $ blockstack-cli encrypt_keychain "section amount spend resemble spray verify night immune tattoo best emotion parrot"\n' +
|
||||
' Enter password:\n' +
|
||||
' Enter password again:\n' +
|
||||
' M+DnBHYb1fgw4N3oZ+5uTEAua5bAWkgTW/SjmmBhGGbJtjOtqVV+RrLJEJOgT35hBon4WKdGWye2vTdgqDo7+HIobwJwkQtN2YF9g3zPsKk=',
|
||||
' M+DnBHYb1fgw4N3oZ+5uTEAua5bAWkgTW/SjmmBhGGbJtjOtqVV+RrLJEJOgT35hBon4WKdGWye2vTdgqDo7+HIobwJwkQtN2YF9g3zPsKk=' +
|
||||
'```\n',
|
||||
group: 'Key Management',
|
||||
},
|
||||
gaia_dump_bucket: {
|
||||
@@ -675,13 +695,15 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ export BACKUP_PHRASE="section amount spend resemble spray verify night immune tattoo best emotion parrot\n' +
|
||||
' $ stx gaia_dump_bucket hello.id.blockstack https://sample.app https://hub.blockstack.org "$BACKUP_PHRASE" ./backups\n' +
|
||||
' Download 3 files...\n' +
|
||||
' Download hello_world to ./backups/hello_world\n' +
|
||||
' Download dir/format to ./backups/dir\\x2fformat\n' +
|
||||
' Download /.dotfile to ./backups/\\x2f.dotfile\n' +
|
||||
' 3\n',
|
||||
' 3\n' +
|
||||
'```\n',
|
||||
group: 'Gaia',
|
||||
},
|
||||
gaia_getfile: {
|
||||
@@ -742,6 +764,7 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example without encryption:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ # Get an unencrypted, unsigned file\n' +
|
||||
' $ stx gaia_getfile ryan.id http://public.ykliao.com statuses.json\n' +
|
||||
' [{"id":0,"text":"Hello, Blockstack!","created_at":1515786983492}]\n' +
|
||||
@@ -754,7 +777,8 @@ export const CLI_ARGS = {
|
||||
' $ # Get an encrypted file, and decrypt it\n' +
|
||||
' $ # Tip: You can obtain the app key with the get_app_keys command\n' +
|
||||
' $ export APP_KEY="3ac770e8c3d88b1003bf4a0a148ceb920a6172bdade8e0325a1ed1480ab4fb19"\n' +
|
||||
' $ stx gaia_getfile ryan.id https://app.graphitedocs.com documentscollection.json "$APP_KEY" 1 0\n',
|
||||
' $ stx gaia_getfile ryan.id https://app.graphitedocs.com documentscollection.json "$APP_KEY" 1 0\n' +
|
||||
'```\n',
|
||||
group: 'Gaia',
|
||||
},
|
||||
gaia_putfile: {
|
||||
@@ -812,6 +836,7 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ # Store 4 versions of a file: plaintext, encrypted, signed, and encrypted+signed\n' +
|
||||
' $ # Tip: You can obtain the app key with the get_app_keys command.\n' +
|
||||
' $ export APP_KEY="3ac770e8c3d88b1003bf4a0a148ceb920a6172bdade8e0325a1ed1480ab4fb19"\n' +
|
||||
@@ -830,7 +855,8 @@ export const CLI_ARGS = {
|
||||
' $ stx gaia_putfile https://hub.blockstack.org "$APP_KEY" /path/to/file.txt file-encrypted-signed.txt 1 1\n' +
|
||||
' {\n' +
|
||||
' "urls": "https://gaia.blockstack.org/hub/19KAzYp4kSKozeAGMUsnuqkEGdgQQLEvwo/file-encrypted-signed.txt"\n' +
|
||||
' }\n',
|
||||
' }\n' +
|
||||
'```\n',
|
||||
group: 'Gaia',
|
||||
},
|
||||
gaia_deletefile: {
|
||||
@@ -868,10 +894,12 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ # Tip: You can obtain the app key with the get_app_keys command.\n' +
|
||||
' $ export APP_KEY="3ac770e8c3d88b1003bf4a0a148ceb920a6172bdade8e0325a1ed1480ab4fb19"\n' +
|
||||
' $ stx gaia_deletefile https://hub.blockstack.org "$APP_KEY" file.txt false\n' +
|
||||
' ok',
|
||||
' ok' +
|
||||
'```\n',
|
||||
group: 'Gaia',
|
||||
},
|
||||
gaia_listfiles: {
|
||||
@@ -899,13 +927,15 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ # Tip: You can obtain the app key with the get_app_keys command.\n' +
|
||||
' $ export APP_KEY="3ac770e8c3d88b1003bf4a0a148ceb920a6172bdade8e0325a1ed1480ab4fb19"\n' +
|
||||
' $ stx gaia_listfiles "https://hub.blockstack.org" "$APP_KEY"\n' +
|
||||
' hello_world\n' +
|
||||
' dir/format\n' +
|
||||
' /.dotfile\n' +
|
||||
' 3\n',
|
||||
' 3\n' +
|
||||
'```\n',
|
||||
group: 'Gaia',
|
||||
},
|
||||
gaia_restore_bucket: {
|
||||
@@ -951,12 +981,14 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ export BACKUP_PHRASE="section amount spend resemble spray verify night immune tattoo best emotion parrot"\n' +
|
||||
' $ stx gaia_restore_bucket hello.id.blockstack https://sample.app https://new.gaia.hub "$BACKUP_PHRASE" ./backups\n' +
|
||||
' Uploaded ./backups/hello_world to https://new.gaia.hub/hub/1Lr8ggSgdmfcb4764woYutUfFqQMjEoKHc/hello_world\n' +
|
||||
' Uploaded ./backups/dir\\x2fformat to https://new.gaia.hub/hub/1Lr8ggSgdmfcb4764woYutUfFqQMjEoKHc/dir/format\n' +
|
||||
' Uploaded ./backups/\\x2f.dotfile to https://new.gaia.hub/hub/1Lr8ggSgdmfcb4764woYutUfFqQMjEoKHc//.dotfile\n' +
|
||||
' 3\n',
|
||||
' 3\n' +
|
||||
'```\n',
|
||||
group: 'Gaia',
|
||||
},
|
||||
gaia_sethub: {
|
||||
@@ -1006,6 +1038,7 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ export BACKUP_PHRASE="soap fog wealth upon actual blossom neither timber phone exile monkey vocal"\n' +
|
||||
' $ stx gaia_sethub hello_world.id https://hub.blockstack.org https://my.cool.app https://my.app.gaia.hub "$BACKUP_PHRASE"\n' +
|
||||
' {\n' +
|
||||
@@ -1022,6 +1055,7 @@ export const CLI_ARGS = {
|
||||
' {\n' +
|
||||
' "https://my.cool.app": "https://my.app.gaia.hub/hub/1EqzyQLJ15KG1WQmi5cf1HtmSeqS1Wb8tY/"\n' +
|
||||
' }\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Gaia',
|
||||
},
|
||||
@@ -1050,6 +1084,7 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ stx get_account_history SP2H7VMY13ESQDAD5808QEY1EMGESMHZWBJRTN2YA 0\n' +
|
||||
' [\n' +
|
||||
' {\n' +
|
||||
@@ -1093,6 +1128,7 @@ export const CLI_ARGS = {
|
||||
' "vtxindex": 3\n' +
|
||||
' }\n' +
|
||||
' ]\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Account Management',
|
||||
},
|
||||
@@ -1120,6 +1156,7 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ stx -t get_account_at SP2NTAQFECYGSTE1W47P71FG21H8F00KZZWFGEVKQ 56789\n' +
|
||||
' [\n' +
|
||||
' {\n' +
|
||||
@@ -1133,6 +1170,7 @@ export const CLI_ARGS = {
|
||||
' "vtxindex": 0\n' +
|
||||
' }\n' +
|
||||
' ]\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Account Management',
|
||||
},
|
||||
@@ -1153,6 +1191,7 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ stx get_address f5185b9ca93bdcb5753fded3b097dab8547a8b47d2be578412d0687a9a0184cb01\n' +
|
||||
' {\n' +
|
||||
' "BTC": "1JFhWyVPpZQjbPcXFtpGtTmU22u4fhBVmq",\n' +
|
||||
@@ -1162,7 +1201,8 @@ export const CLI_ARGS = {
|
||||
' {\n' +
|
||||
' "BTC": "363pKBhc5ipDws1k5181KFf6RSxhBZ7e3p",\n' +
|
||||
' "STACKS": "SMQWZ30EXVG6XEC1K4QTDP16C1CAWSK1JSWMS0QN"\n' +
|
||||
' }',
|
||||
' }\n' +
|
||||
'```\n',
|
||||
group: 'Key Management',
|
||||
},
|
||||
get_blockchain_record: {
|
||||
@@ -1223,11 +1263,13 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ stx get_confirmations e41ce043ab64fd5a5fd382fba21acba8c1f46cbb1d7c08771ada858ce7d29eea\n' +
|
||||
' {\n' +
|
||||
' "blockHeight": 567890,\n' +
|
||||
' "confirmations": 7,\n' +
|
||||
' }\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Peer Services',
|
||||
},
|
||||
@@ -1279,6 +1321,7 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ export BACKUP_PHRASE="one race buffalo dynamic icon drip width lake extra forest fee kit"\n' +
|
||||
' $ stx get_app_keys "$BACKUP_PHRASE" 1 https://my.cool.dapp\n' +
|
||||
' {\n' +
|
||||
@@ -1286,7 +1329,8 @@ export const CLI_ARGS = {
|
||||
' "privateKey": "TODO",\n' +
|
||||
' "address": "TODO"\n' +
|
||||
' },\n' +
|
||||
' }',
|
||||
' }\n' +
|
||||
'```\n',
|
||||
group: 'Key Management',
|
||||
},
|
||||
get_owner_keys: {
|
||||
@@ -1314,6 +1358,7 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ # get the first 3 owner keys and addresses for a backup phrase\n' +
|
||||
' $ export BACKUP_PHRASE="soap fog wealth upon actual blossom neither timber phone exile monkey vocal"\n' +
|
||||
' $ stx get_owner_keys "$BACKUP_PHRASE" 3\n' +
|
||||
@@ -1337,6 +1382,7 @@ export const CLI_ARGS = {
|
||||
' "idAddress": "ID-1Gx4s7ggkjENw3wSY6bNd1CwoQKk857AqN"\n' +
|
||||
' }\n' +
|
||||
' ]\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Key Management',
|
||||
},
|
||||
@@ -1358,6 +1404,7 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ stx get_payment_key "soap fog wealth upon actual blossom neither timber phone exile monkey vocal"\n' +
|
||||
' [\n' +
|
||||
' {\n' +
|
||||
@@ -1369,6 +1416,7 @@ export const CLI_ARGS = {
|
||||
' "index": 0\n' +
|
||||
' }\n' +
|
||||
' ]\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Key Management',
|
||||
},
|
||||
@@ -1395,6 +1443,7 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ stx get_stacks_wallet_key "toast canal educate tissue express melody produce later gospel victory meadow outdoor hollow catch liberty annual gasp hat hello april equip thank neck cruise"\n' +
|
||||
' [\n' +
|
||||
' {\n' +
|
||||
@@ -1406,6 +1455,7 @@ export const CLI_ARGS = {
|
||||
' "index": 0\n' +
|
||||
' }\n' +
|
||||
' ]\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Key Management',
|
||||
},
|
||||
@@ -1449,7 +1499,9 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ stx migrate_subdomains "toast canal educate tissue express melody produce later gospel victory meadow outdoor hollow catch liberty annual gasp hat hello april equip thank neck cruise" https://registrar.stacks.co\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Blockstack ID Management',
|
||||
},
|
||||
@@ -1470,10 +1522,12 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ stx get_zonefile ee77ad484b7b229f09461e4c2b6d3bd3e152ba95\n' +
|
||||
' $ORIGIN ryanshea.id\n' +
|
||||
' $TTL 3600\n' +
|
||||
' _http._tcp URI 10 1 "https://gaia.blockstack.org/hub/15BcxePn59Y6mYD2fRLCLCaaHScefqW2No/1/profile.json"\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Peer Services',
|
||||
},
|
||||
@@ -1508,7 +1562,9 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ stx lookup example.id\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Querying Blockstack IDs',
|
||||
},
|
||||
@@ -1529,7 +1585,9 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ stx names ID-1FpBChfzHG3TdQQRKWAipbLragCUArueG9\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Querying Blockstack IDs',
|
||||
},
|
||||
@@ -1556,6 +1614,7 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ stx make_keychain\n' +
|
||||
' {\n' +
|
||||
' "mnemonic": "apart spin rich leader siren foil dish sausage fee pipe ethics bundle",\n' +
|
||||
@@ -1567,6 +1626,7 @@ export const CLI_ARGS = {
|
||||
' "index": 0,\n' +
|
||||
' }\n' +
|
||||
' }\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Key Management',
|
||||
},
|
||||
@@ -1611,10 +1671,12 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ stx make_zonefile example.id ID-1ArdkA2oLaKnbNbLccBaFhEV4pYju8hJ82 https://my.gaia.hub/hub\n' +
|
||||
' $ORIGIN example.id\n' +
|
||||
' $TTL 3600\n' +
|
||||
' _http._tcp IN URI 10 1 "https://my.gaia.hub/hub/1ArdkA2oLaKnbNbLccBaFhEV4pYju8hJ82/profile.json"\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Peer Services',
|
||||
},
|
||||
@@ -1685,10 +1747,12 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ export REVEAL_KEY="bfeffdf57f29b0cc1fab9ea197bb1413da2561fe4b83e962c7f02fbbe2b1cd5401"\n' +
|
||||
' $ export ID_ADDRESS="ID-18e1bqU7B5qUPY3zJgMLxDnexyStTeSnvV"\n' +
|
||||
' $ stx name_import example.id "$ID_ADDRESS" https://gaia.blockstack.org/hub "$REVEAL_KEY"\n' +
|
||||
' f726309cea7a9db364307466dc0e0e759d5c0d6bad1405e2fd970740adc7dc45\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Namespace Operations',
|
||||
},
|
||||
@@ -1841,11 +1905,13 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ stx price example.id\n' +
|
||||
' {\n' +
|
||||
' "units": "BTC",\n' +
|
||||
' "amount": "5500"\n' +
|
||||
' }\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Querying Blockstack IDs',
|
||||
},
|
||||
@@ -1866,12 +1932,14 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ # get the price of the .hello namespace\n' +
|
||||
' $ stx price_namespace hello\n' +
|
||||
' {\n' +
|
||||
' "units": "BTC",\n' +
|
||||
' "amount": "40000000"\n' +
|
||||
' }\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Namespace Operations',
|
||||
},
|
||||
@@ -1897,8 +1965,10 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ # Tip: you can get the owner key from your 12-word backup phrase using the get_owner_keys command\n' +
|
||||
' $ stx profile_sign /path/to/profile.json 0ffd299af9c257173be8486ef54a4dd1373407d0629ca25ca68ff24a76be09fb01\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Profiles',
|
||||
},
|
||||
@@ -1959,10 +2029,12 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ # get the raw profile JWT\n' +
|
||||
' $ curl -sL https://raw.githubusercontent.com/jcnelson/profile/master/judecn.id > /tmp/judecn.id.jwt\n' +
|
||||
' $ # Tip: you can get the ID-address for a name with the "whois" command\n' +
|
||||
' $ stx profile_verify /tmp/judecn.id.jwt ID-16EMaNw3pkn3v6f2BgnSSs53zAKH4Q8YJg\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Profiles',
|
||||
},
|
||||
@@ -2020,6 +2092,7 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ # Tip: you can get your owner key from your backup phrase with "get_owner_keys".\n' +
|
||||
' $ # Tip: you can get your payment key from your backup phrase with "get_payment_key".\n' +
|
||||
' $ export OWNER="136ff26efa5db6f06b28f9c8c7a0216a1a52598045162abfe435d13036154a1b01"\n' +
|
||||
@@ -2047,6 +2120,7 @@ export const CLI_ARGS = {
|
||||
' [\n' +
|
||||
' "https://stacks-node-api.stacks.co"\n' +
|
||||
' ]\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Blockstack ID Management',
|
||||
},
|
||||
@@ -2105,8 +2179,10 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ export OWNER="136ff26efa5db6f06b28f9c8c7a0216a1a52598045162abfe435d13036154a1b01"\n' +
|
||||
' $ stx register example.id "$OWNER" salt zonfile' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Blockstack ID Management',
|
||||
},
|
||||
@@ -2175,9 +2251,11 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ export ID_ADDRESS="ID-18e1bqU7B5qUPY3zJgMLxDnexyStTeSnvV"\n' +
|
||||
' $ export PAYMENT="bfeffdf57f29b0cc1fab9ea197bb1413da2561fe4b83e962c7f02fbbe2b1cd5401"\n' +
|
||||
' $ stx register_addr example.id "$ID_ADDRESS" "$PAYMENT" https://gaia.blockstack.org/hub',
|
||||
' $ stx register_addr example.id "$ID_ADDRESS" "$PAYMENT" https://gaia.blockstack.org/hub\n' +
|
||||
'```\n',
|
||||
group: 'Blockstack ID Management',
|
||||
},
|
||||
// todo: implement register_subdomain
|
||||
@@ -2265,11 +2343,13 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ # Tip: you can get your owner and payment keys from your 12-word backup phrase using the get_owner_keys and get_payment_key commands.\n' +
|
||||
' $ export OWNER="6e50431b955fe73f079469b24f06480aee44e4519282686433195b3c4b5336ef01"\n' +
|
||||
' $ export PAYMENT="bfeffdf57f29b0cc1fab9ea197bb1413da2561fe4b83e962c7f02fbbe2b1cd5401"\n' +
|
||||
' $ stx revoke example.id "$OWNER" "$PAYMENT"\n' +
|
||||
' 233b559c97891affa010567bd582110508d0236b4e3f88d3b1d0731629e030b0\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Blockstack ID Management',
|
||||
},
|
||||
@@ -2311,9 +2391,11 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ export PAYMENT="bfeffdf57f29b0cc1fab9ea197bb1413da2561fe4b83e962c7f02fbbe2b1cd5401"\n' +
|
||||
' $ stx send_btc 18qTSE5PPQmypwKKej7QX5Db2XAttgYeA1 123456 "$PAYMENT"\n' +
|
||||
' c7e239fd24da30e36e011e6bc7db153574a5b40a3a8dc3b727adb54ad038acc5\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Account Management',
|
||||
},
|
||||
@@ -2369,6 +2451,7 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ # check balances of sender and recipient before sending.\n' +
|
||||
' $ # address of the key below is SP2SC16ASH76GX549PT7J5WQZA4GHMFBKYMBQFF9V\n' +
|
||||
' $ export PAYMENT="bfeffdf57f29b0cc1fab9ea197bb1413da2561fe4b83e962c7f02fbbe2b1cd5401"\n' +
|
||||
@@ -2399,6 +2482,7 @@ export const CLI_ARGS = {
|
||||
' {\n' +
|
||||
' "STACKS": "12345"\n' +
|
||||
' }\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Account Management',
|
||||
},
|
||||
@@ -2449,11 +2533,13 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ stx stack 10000000 20 16pm276FpJYpm7Dv3GEaRqTVvGPTdceoY4 136ff26efa5db6f06b28f9c8c7a0216a1a52598045162abfe435d13036154a1b01\n' +
|
||||
' {\n' +
|
||||
" txid: '0x2e33ad647a9cedacb718ce247967dc705bc0c878db899fdba5eae2437c6fa1e1'," +
|
||||
" transaction: 'https://explorer.hiro.so/txid/0x2e33ad647a9cedacb718ce247967dc705bc0c878db899fdba5eae2437c6fa1e1'" +
|
||||
' }\n',
|
||||
' }\n' +
|
||||
'```\n',
|
||||
group: 'Account Management',
|
||||
},
|
||||
stacking_status: {
|
||||
@@ -2473,7 +2559,9 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
' $ stx stacking_status SPZY1V53Z4TVRHHW9Z7SFG8CZNRAG7BD8WJ6SXD0\n',
|
||||
'```\n' +
|
||||
' $ stx stacking_status SPZY1V53Z4TVRHHW9Z7SFG8CZNRAG7BD8WJ6SXD0\n' +
|
||||
'```\n',
|
||||
group: 'Account Management',
|
||||
},
|
||||
transfer: {
|
||||
@@ -2526,12 +2614,14 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ # Tip: you can get your owner key from your backup phrase with "get_owner_keys".\n' +
|
||||
' $ # Tip: you can get your payment key from your backup phrase with "get_payment_key".\n' +
|
||||
' $ export OWNER="136ff26efa5db6f06b28f9c8c7a0216a1a52598045162abfe435d13036154a1b01"\n' +
|
||||
' $ export PAYMENT="bfeffdf57f29b0cc1fab9ea197bb1413da2561fe4b83e962c7f02fbbe2b1cd5401"\n' +
|
||||
' $ stx transfer example.id ID-1HJA1AJvWef21XbQVL2AcTv71b6JHGPfDX true "$OWNER" "$PAYMENT"\n' +
|
||||
' e09dc158e586d0c09dbcdcba917ec394e6c6ac2b9c91c4b55f32f5973e4f08fc\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Blockstack ID Management',
|
||||
},
|
||||
@@ -2574,8 +2664,10 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ export PAYMENT="136ff26efa5db6f06b28f9c8c7a0216a1a52598045162abfe435d13036154a1b01"\n' +
|
||||
' $ stx tx_preorder example.id "$PAYMENT" salt 1000' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Blockstack ID Management',
|
||||
},
|
||||
@@ -2676,6 +2768,7 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ # Tip: you can get your owner and payment keys from your 12-word backup phrase using the get_owner_keys and get_payment_key commands.\n' +
|
||||
' $ export OWNER="6e50431b955fe73f079469b24f06480aee44e4519282686433195b3c4b5336ef01"\n' +
|
||||
' $ export PAYMENT="bfeffdf57f29b0cc1fab9ea197bb1413da2561fe4b83e962c7f02fbbe2b1cd5401"\n' +
|
||||
@@ -2698,6 +2791,7 @@ export const CLI_ARGS = {
|
||||
' [\n' +
|
||||
' "https://stacks-node-api.stacks.co"\n' +
|
||||
' ]\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Blockstack ID Management',
|
||||
},
|
||||
@@ -2718,6 +2812,7 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ stx whois example.id\n' +
|
||||
' {\n' +
|
||||
' "address": "1ArdkA2oLaKnbNbLccBaFhEV4pYju8hJ82",\n' +
|
||||
@@ -2734,6 +2829,7 @@ export const CLI_ARGS = {
|
||||
' "zonefile": "$ORIGIN example.id\\n$TTL 3600\\n_http._tcp URI 10 1 \\"https://gaia.blockstack.org/hub/1ArdkA2oLaKnbNbLccBaFhEV4pYju8hJ82/profile.json\\"\\n",\n' +
|
||||
' "zonefile_hash": "ae4ee8e7f30aa890468164e667e2c203266f726e"\n' +
|
||||
' }\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Querying Blockstack IDs',
|
||||
},
|
||||
@@ -2755,10 +2851,12 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ stx -H https://stacks-node-api.stacks.co zonefile_push /path/to/zonefile.txt\n' +
|
||||
' [\n' +
|
||||
' "https://stacks-node-api.stacks.co"\n' +
|
||||
' ]\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'Peer Services',
|
||||
},
|
||||
@@ -2793,6 +2891,7 @@ export const CLI_ARGS = {
|
||||
'\n' +
|
||||
'Example:\n' +
|
||||
'\n' +
|
||||
'```\n' +
|
||||
' $ # Tip: you can get your owner keys from your 12-word backup phrase using the get_owner_keys command.\n' +
|
||||
' $ export PRIVATE_OWNER_KEY="6e50431b955fe73f079469b24f06480aee44e4519282686433195b3c4b5336ef01"\n' +
|
||||
' $ stx get_did_configuration public_profile_for_testing.id.blockstack helloblockstack.com PRIVATE_OWNER_KEY\n' +
|
||||
@@ -2817,6 +2916,7 @@ export const CLI_ARGS = {
|
||||
' },\n' +
|
||||
' "signature": "NDY7ISzgAHKcZDvbxzTxQdVnf6xWMZ46w5vHcDpNx_1Fsyip0M6E6GMq_2YZ-gUcwmwlo8Ag9jgnfOkaBIFpoQ"\n' +
|
||||
' }\n' +
|
||||
'```\n' +
|
||||
'\n',
|
||||
group: 'DID',
|
||||
},
|
||||
|
||||
Reference in New Issue
Block a user