Enum HtlcOpts 

enum HtlcOpts {
    Create {
        amount: Amount,
        claim_pk: PublicKey,
        expiration_delta: u64,
        payment_hash: Option<Hash>,
        payment_point: Option<PublicKey>,
    },
    NewClaimKeypair {
        secret_key_file: PathBuf,
    },
    AwaitFunded {
        funding_txid: TransactionId,
        out_idx: u64,
        contract: String,
    },
    Claim {
        funding_txid: TransactionId,
        out_idx: u64,
        contract: String,
        claim_sk_file: PathBuf,
        preimage_file: PathBuf,
    },
    Forfeit {
        contract: String,
        claim_sk_file: PathBuf,
    },
    Cancel {
        funding_txid: TransactionId,
        out_idx: u64,
        contract: String,
        forfeit_signature: Signature,
    },
    Refund {
        funding_txid: TransactionId,
        out_idx: u64,
        contract: String,
    },
    AwaitResolution {
        funding_txid: TransactionId,
        out_idx: u64,
        contract: String,
    },
    AwaitSettled {
        operation_id: OperationId,
    },
}

Variants

Create

Fund an HTLC locked to the counterparty’s claim public key. Requires exactly one of –payment-hash and –payment-point.

Fields

amount: Amount

claim_pk: PublicKey

expiration_delta: u64

payment_hash: Option<Hash>

payment_point: Option<PublicKey>

NewClaimKeypair

Generate a random claim keypair to receive an HTLC with. The secret key is written as hex to a new file created with owner-only permissions and only the public key is printed.

Fields

secret_key_file: PathBuf

Path of the new file to write the secret key to. An existing file is never overwritten.

AwaitFunded

Wait until the contract is funded at the outpoint and print the number of blocks remaining until its expiration.

Fields

funding_txid: TransactionId

out_idx: u64

contract: String

Claim

Claim a funded HTLC with the preimage of its payment image.

Fields

funding_txid: TransactionId

out_idx: u64

contract: String

claim_sk_file: PathBuf

Read the hex claim secret key from a file, or ‘-’ for stdin.

preimage_file: PathBuf

Read the hex preimage from a file, or ‘-’ for stdin.

Forfeit

Create a forfeit signature to fail an HTLC locked to our claim key cooperatively.

Fields

contract: String

claim_sk_file: PathBuf

Read the hex claim secret key from a file, or ‘-’ for stdin.

Cancel

Cancel an HTLC we created before its expiration with the counterparty’s forfeit signature.

Fields

funding_txid: TransactionId

out_idx: u64

contract: String

forfeit_signature: Signature

Refund

Refund an HTLC we created after its expiration.

Fields

funding_txid: TransactionId

out_idx: u64

contract: String

AwaitResolution

Wait until an HTLC we created is claimed, printing the preimage, or expired unclaimed, printing null.

Fields

funding_txid: TransactionId

out_idx: u64

contract: String

AwaitSettled

Wait until the transaction of an HTLC operation is accepted and any ecash it issues has been minted.

Fields

operation_id: OperationId

Trait Implementations

impl Clone for HtlcOpts

fn clone(&self) -> HtlcOpts

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl FromArgMatches for HtlcOpts

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Serialize for HtlcOpts

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Subcommand for HtlcOpts

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand