Command Line Interface (CLI)¶
After you have installed, type shuttle
to verify that it worked:
$ shuttle
Usage: shuttle [OPTIONS] COMMAND [ARGS]...
Options:
-v, --version Show Shuttle version and exit.
-h, --help Show this message and exit.
Commands:
bitcoin Select Bitcoin provider.
bytom Select Bytom provider.
shuttle¶
shuttle [OPTIONS] COMMAND [ARGS]...
Options
-
-v
,
--version
¶
Show Shuttle version and exit.
bitcoin¶
Select Bitcoin provider.
shuttle bitcoin [OPTIONS] COMMAND [ARGS]...
claim¶
Select Bitcoin claim transaction builder.
shuttle bitcoin claim [OPTIONS]
Options
-
-t
,
--transaction
<transaction>
¶ Required Set Bitcoin fund transaction id.
-
-ra
,
--recipient-address
<recipient_address>
¶ Required Set Bitcoin recipient address.
-
-a
,
--amount
<amount>
¶ Required Set Bitcoin amount to claim.
-
-v
,
--version
<version>
¶ Set Bitcoin transaction version.
-
-n
,
--network
<network>
¶ Set Bitcoin network.
decode¶
Select Bitcoin transaction raw decoder.
shuttle bitcoin decode [OPTIONS]
Options
-
-r
,
--raw
<raw>
¶ Required Set Bitcoin transaction raw.
fund¶
Select Bitcoin fund transaction builder.
shuttle bitcoin fund [OPTIONS]
Options
-
-sa
,
--sender-address
<sender_address>
¶ Required Set Bitcoin sender address.
-
-a
,
--amount
<amount>
¶ Required Set Bitcoin amount to fund on HTLC.
-
-b
,
--bytecode
<bytecode>
¶ Required Set Bitcoin HTLC bytecode.
-
-v
,
--version
<version>
¶ Set Bitcoin transaction version.
-
-n
,
--network
<network>
¶ Set Bitcoin network.
htlc¶
Select Bitcoin Hash Time Lock Contract (HTLC) builder.
shuttle bitcoin htlc [OPTIONS]
Options
-
-sh
,
--secret-hash
<secret_hash>
¶ Required Set secret 256 hash.
-
-ra
,
--recipient-address
<recipient_address>
¶ Required Set Bitcoin recipient address.
-
-sa
,
--sender-address
<sender_address>
¶ Required Set Bitcoin sender address.
-
-sq
,
--sequence
<sequence>
¶ Set Bitcoin sequence/expiration block.
-
-n
,
--network
<network>
¶ Set Bitcoin network.
refund¶
Select Bitcoin refund transaction builder.
shuttle bitcoin refund [OPTIONS]
Options
-
-t
,
--transaction
<transaction>
¶ Required Set Bitcoin fund transaction id.
-
-sa
,
--sender-address
<sender_address>
¶ Required Set Bitcoin sender address.
-
-a
,
--amount
<amount>
¶ Required Set Bitcoin amount to refund.
-
-v
,
--version
<version>
¶ Set Bitcoin transaction version.
-
-n
,
--network
<network>
¶ Set Bitcoin network.
sign¶
Select Bitcoin transaction raw signer.
shuttle bitcoin sign [OPTIONS]
Options
-
-p
,
--private
<private>
¶ Required Set Bitcoin private key.
-
-r
,
--raw
<raw>
¶ Required Set Bitcoin unsigned transaction raw.
-
-b
,
--bytecode
<bytecode>
¶ Set Bitcoin witness HTLC bytecode.
-
-s
,
--secret
<secret>
¶ Set secret key.
-
-sq
,
--sequence
<sequence>
¶ Set Bitcoin sequence/expiration block.
-
-v
,
--version
<version>
¶ Set Bitcoin transaction version.
- Default
2
bytom¶
Select Bytom provider.
shuttle bytom [OPTIONS] COMMAND [ARGS]...
claim¶
Select Bytom claim transaction builder.
shuttle bytom claim [OPTIONS]
Options
-
-t
,
--transaction
<transaction>
¶ Required Set Bytom fund transaction id.
-
-rg
,
--recipient-guid
<recipient_guid>
¶ Required Set Bytom recipient GUID.
-
-a
,
--amount
<amount>
¶ Required Set Bytom amount to claim.
-
-as
,
--asset
<asset>
¶ Required Set Bytom asset id.
-
-n
,
--network
<network>
¶ Set Bytom network.
decode¶
Select Bytom transaction raw decoder.
shuttle bytom decode [OPTIONS]
Options
-
-r
,
--raw
<raw>
¶ Required Set Bytom transaction raw.
fund¶
Select Bytom unsigned transaction builder.
shuttle bytom fund [OPTIONS]
Options
-
-sg
,
--sender-guid
<sender_guid>
¶ Required Set Bytom sender GUID.
-
-a
,
--amount
<amount>
¶ Required Set Bytom amount to fund on HTLC.
-
-as
,
--asset
<asset>
¶ Required Set Bytom asset id.
-
-b
,
--bytecode
<bytecode>
¶ Required Set Bytom HTLC bytecode.
-
-n
,
--network
<network>
¶ Set Bytom network.
htlc¶
Select Bytom Hash Time Lock Contract (HTLC) builder.
shuttle bytom htlc [OPTIONS]
Options
-
-sh
,
--secret-hash
<secret_hash>
¶ Required Set secret 256 hash.
-
-rp
,
--recipient-public
<recipient_public>
¶ Required Set Bytom recipient public key.
-
-sp
,
--sender-public
<sender_public>
¶ Required Set Bytom sender public key.
-
-sq
,
--sequence
<sequence>
¶ Set Bytom sequence/expiration block.
-
-n
,
--network
<network>
¶ Set Bytom network.
refund¶
Select Bytom refund transaction builder.
shuttle bytom refund [OPTIONS]
Options
-
-t
,
--transaction
<transaction>
¶ Required Set Bytom fund transaction id.
-
-sg
,
--sender-guid
<sender_guid>
¶ Required Set Bytom sender GUID.
-
-a
,
--amount
<amount>
¶ Required Set Bytom amount to refund.
-
-as
,
--asset
<asset>
¶ Required Set Bytom asset id.
-
-n
,
--network
<network>
¶ Set Bytom network.
sign¶
Select Bytom transaction raw signer.
shuttle bytom sign [OPTIONS]
Options
-
-xp
,
--xprivate
<xprivate>
¶ Required Set Bytom xprivate key.
-
-r
,
--raw
<raw>
¶ Required Set Bytom unsigned transaction raw.
-
-ac
,
--account
<account>
¶ Set Bytom derivation from account.
- Default
1
-
-c
,
--change
<change>
¶ Set Bytom derivation from change.
- Default
False
-
-ad
,
--address
<address>
¶ Set Bytom derivation from address.
- Default
1
-
-b
,
--bytecode
<bytecode>
¶ Set Bytom witness HTLC bytecode.
-
-s
,
--secret
<secret>
¶ Set secret key.
-
-p
,
--path
<path>
¶ Set Bytom derivation from path.
-
-i
,
--indexes
<indexes>
¶ Set Bytom derivation from indexes.