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>¶: Set Bitcoin fund transaction id. [required]

-ra, --recipient-address <recipient_address>¶: Set Bitcoin recipient address. [required]

-a, --amount <amount>¶: Set Bitcoin amount to claim. [required]

-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>¶: Set Bitcoin transaction raw. [required]

fund¶

Select Bitcoin fund transaction builder.

shuttle bitcoin fund [OPTIONS]

Options

-sa, --sender-address <sender_address>¶: Set Bitcoin sender address. [required]

-a, --amount <amount>¶: Set Bitcoin amount to fund on HTLC. [required]

-b, --bytecode <bytecode>¶: Set Bitcoin HTLC bytecode. [required]

-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>¶: Set secret 256 hash. [required]

-ra, --recipient-address <recipient_address>¶: Set Bitcoin recipient address. [required]

-sa, --sender-address <sender_address>¶: Set Bitcoin sender address. [required]

-s, --sequence <sequence>¶: Set Bitcoin expiration block (sequence).

-n, --network <network>¶: Set Bitcoin network.

refund¶

Select Bitcoin refund transaction builder.

shuttle bitcoin refund [OPTIONS]

Options

-t, --transaction <transaction>¶: Set Bitcoin fund transaction id. [required]

-ra, --recipient-address <recipient_address>¶: Set Bitcoin recipient address. [required]

-a, --amount <amount>¶: Set Bitcoin amount to refund. [required]

-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>¶: Set Bitcoin private key. [required]

-r, --raw <raw>¶: Set Bitcoin unsigned transaction raw. [required]

-s, --secret <secret>¶: Set secret key.

-v, --version <version>¶: Set Bitcoin transaction version. [default: 2]

submit¶

Select Bitcoin transaction raw submitter.

shuttle bitcoin submit [OPTIONS]

Options

-r, --raw <raw>¶: Set signed Bitcoin transaction raw. [required]

bytom¶

Select Bytom provider.

shuttle bytom [OPTIONS] COMMAND [ARGS]...

claim¶

Select Bytom claim transaction builder.

shuttle bytom claim [OPTIONS]

Options

-t, --transaction <transaction>¶: Set Bytom fund transaction id. [required]

-rg, --recipient-guid <recipient_guid>¶: Set Bytom recipient GUID. [required]

-rp, --recipient-public <recipient_public>¶: Set Bytom recipient public key. [required]

-a, --amount <amount>¶: Set Bytom amount to claim. [required]

-as, --asset <asset>¶: Set Bytom asset id. [required]

-n, --network <network>¶: Set Bytom network.

decode¶

Select Bytom transaction raw decoder.

shuttle bytom decode [OPTIONS]

Options

-r, --raw <raw>¶: Set Bytom transaction raw. [required]

fund¶

Select Bytom unsigned transaction builder.

shuttle bytom fund [OPTIONS]

Options

-sg, --sender-guid <sender_guid>¶: Set Bytom sender GUID. [required]

-a, --amount <amount>¶: Set Bytom amount to fund on HTLC. [required]

-as, --asset <asset>¶: Set Bytom asset id. [required]

-b, --bytecode <bytecode>¶: Set Bytom HTLC bytecode. [required]

-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>¶: Set secret 256 hash. [required]

-rp, --recipient-public <recipient_public>¶: Set Bytom recipient public key. [required]

-sp, --sender-public <sender_public>¶: Set Bytom sender public key. [required]

-s, --sequence <sequence>¶: Set Bytom expiration block (sequence).

-n, --network <network>¶: Set Bytom network.

refund¶

Select Bytom refund transaction builder.

shuttle bytom refund [OPTIONS]

Options

-t, --transaction <transaction>¶: Set Bytom fund transaction id. [required]

-sg, --sender-guid <sender_guid>¶: Set Bytom sender GUID. [required]

-sp, --sender-public <sender_public>¶: Set Bytom sender public key. [required]

-a, --amount <amount>¶: Set Bytom amount to refund. [required]

-as, --asset <asset>¶: Set Bytom asset id. [required]

-n, --network <network>¶: Set Bytom network.

sign¶

Select Bytom transaction raw signer.

shuttle bytom sign [OPTIONS]

Options

-xp, --xprivate <xprivate>¶: Set Bytom xprivate key. [required]

-r, --raw <raw>¶: Set Bytom unsigned transaction raw. [required]

-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]

-s, --secret <secret>¶: Set secret key.

-p, --path <path>¶: Set Bytom derivation from path.

-i, --indexes <indexes>¶: Set Bytom derivation from indexes.

submit¶

Select Bytom transaction raw submitter.

shuttle bytom submit [OPTIONS]

Options

-r, --raw <raw>¶: Set signed Bytom transaction raw. [required]