Enum TxCmd

pub enum TxCmd {
    Auction(AuctionCmd),
    Send {
        to: String,
        values: Vec<String>,
        source: u32,
        memo: Option<String>,
        fee_tier: FeeTier,
    },
    Delegate {
        to: String,
        amount: String,
        source: u32,
        fee_tier: FeeTier,
    },
    Undelegate {
        amount: String,
        source: u32,
        fee_tier: FeeTier,
    },
    UndelegateClaim {
        fee_tier: FeeTier,
    },
    Swap {
        input: String,
        into: String,
        source: u32,
        fee_tier: FeeTier,
    },
    Vote {
        source: u32,
        vote: VoteCmd,
        fee_tier: FeeTier,
    },
    Proposal(ProposalCmd),
    CommunityPoolDeposit {
        values: Vec<String>,
        source: u32,
        fee_tier: FeeTier,
    },
    Position(PositionCmd),
    Sweep,
    Withdraw {
        to: String,
        value: String,
        channel: u64,
        timeout_height: Option<Height>,
        timeout_timestamp: u64,
        source: u32,
        fee_tier: FeeTier,
        use_transparent_address: bool,
    },
    RegisterForwardingAccount {
        noble_node: Url,
        channel: String,
        address_or_index: String,
        ephemeral: bool,
    },
    Broadcast {
        transaction: PathBuf,
    },
}

Variants

Auction(AuctionCmd)

Auction related commands.

Send

Send funds to a Penumbra address.

Fields

to: String

The destination address to send funds to.

values: Vec<String>

The amounts to send, written as typed values 1.87penumbra, 12cubes, etc.

source: u32

Only spend funds originally received by the given account.

memo: Option<String>

Optional. Set the transaction’s memo field to the provided text.

fee_tier: FeeTier

The selected fee tier to multiply the fee amount by.

Delegate

Deposit stake into a validator’s delegation pool.

Fields

to: String

The identity key of the validator to delegate to.

amount: String

The amount of stake to delegate.

source: u32

Only spend funds originally received by the given account.

fee_tier: FeeTier

The selected fee tier to multiply the fee amount by.

Undelegate

Withdraw stake from a validator’s delegation pool.

Fields

amount: String

The amount of delegation tokens to undelegate.

source: u32

Only spend funds originally received by the given account.

fee_tier: FeeTier

The selected fee tier to multiply the fee amount by.

UndelegateClaim

Claim any undelegations that have finished unbonding.

Fields

fee_tier: FeeTier

The selected fee tier to multiply the fee amount by.

Swap

Swap tokens of one denomination for another using the DEX.

Swaps are batched and executed at the market-clearing price.

A swap generates two transactions: an initial “swap” transaction that submits the swap, and a “swap claim” transaction that privately mints the output funds once the batch has executed. The second transaction will be created and submitted automatically.

Fields

input: String

The input amount to swap, written as a typed value 1.87penumbra, 12cubes, etc.

into: String

The denomination to swap the input into, e.g. gm

source: u32

Only spend funds originally received by the given account.

fee_tier: FeeTier

The selected fee tier to multiply the fee amount by.

Vote

Vote on a governance proposal in your role as a delegator (see also: pcli validator vote).

Fields

source: u32

Only spend funds and vote with staked delegation tokens originally received by the given account.

vote: VoteCmd

fee_tier: FeeTier

The selected fee tier to multiply the fee amount by.

Proposal(ProposalCmd)

Submit or withdraw a governance proposal.

CommunityPoolDeposit

Deposit funds into the Community Pool.

Fields

values: Vec<String>

The amounts to send, written as typed values 1.87penumbra, 12cubes, etc.

source: u32

Only spend funds originally received by the given account.

fee_tier: FeeTier

The selected fee tier to multiply the fee amount by.

Position(PositionCmd)

Manage liquidity positions.

Sweep

Consolidate many small notes into a few larger notes.

Since Penumbra transactions reveal their arity (how many spends, outputs, etc), but transactions are unlinkable from each other, it is slightly preferable to sweep small notes into larger ones in an isolated “sweep” transaction, rather than at the point that they should be spent.

Currently, only zero-fee sweep transactions are implemented.

Withdraw

Perform an ICS-20 withdrawal, moving funds from the Penumbra chain to a counterparty chain.

For a withdrawal to be processed on the counterparty, IBC packets must be relayed between the two chains. Relaying is out of scope for the pcli tool.

Fields

to: String

Address on the receiving chain, e.g. cosmos1grgelyng2v6v3t8z87wu3sxgt9m5s03xvslewd. The chain_id for the counterparty chain will be discovered automatically, based on the --channel setting.

value: String

The value to withdraw, eg “1000upenumbra”

channel: u64

The IBC channel on the primary Penumbra chain to use for performing the withdrawal. This channel must already exist, as configured by a relayer client. You can search for channels via e.g. pcli query ibc channel transfer 0.

timeout_height: Option<Height>

Block height on the counterparty chain, after which the withdrawal will be considered invalid if not already relayed. Must be specified as a tuple of revision number and block height, e.g. 5-1000000 means “chain revision 5, block height of 1000000”. You must know the chain id of the counterparty chain beforehand, e.g. osmosis-testnet-5, to know the revision number.

timeout_timestamp: u64

Timestamp, specified in epoch time, after which the withdrawal will be considered invalid if not already relayed.

source: u32

Only withdraw funds from the specified wallet id within Penumbra.

fee_tier: FeeTier

The selected fee tier to multiply the fee amount by.

use_transparent_address: bool

Whether to use a transparent address (bech32, 32-byte) for the return address in the withdrawal. Required for some chains for a successful acknowledgement.

RegisterForwardingAccount

Register a Noble forwarding account.

Fields

noble_node: Url

The Noble node to submit the registration transaction to.

channel: String

The Noble IBC channel to use for forwarding.

address_or_index: String

The Penumbra address or address index to receive forwarded funds.

ephemeral: bool

Whether or not to use an ephemeral address.

Broadcast

Broadcast a saved transaction to the network

Fields

transaction: PathBuf

The transaction to be broadcast

Implementations

impl TxCmd

pub fn offline(&self) -> bool

Determine if this command requires a network sync before it executes.

pub async fn exec(&self, app: &mut App) -> Result<()>

Trait Implementations

impl Debug for TxCmd

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for TxCmd

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 Subcommand for TxCmd

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

Append to [Command] so it can instantiate Self.

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

Append to [Command] so it can update self.

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand