Struct Ics20Withdrawal

pub struct Ics20Withdrawal {
    pub amount: Option<Amount>,
    pub denom: Option<Denom>,
    pub destination_chain_address: String,
    pub return_address: Option<Address>,
    pub timeout_height: Option<Height>,
    pub timeout_time: u64,
    pub source_channel: String,
    pub use_compat_address: bool,
    pub ics20_memo: String,
    pub use_transparent_address: bool,
}

A Penumbra transaction action requesting an ICS20 transfer.

Fields

amount: Option<Amount>

denom: Option<Denom>

destination_chain_address: String

the address on the destination chain to send the transfer to

return_address: Option<Address>

a “sender” penumbra address to use to return funds from this withdrawal. this should be an ephemeral address

timeout_height: Option<Height>

The height on the counterparty chain at which this transfer expires, and funds are sent back to the return address.

timeout_time: u64

The timestamp, in epoch time, after which this transfer will be considered invalid. Clients must quantize this value to the nearest minute, to preserve privacy. IBC withdrawals that do not quantize timestamps will be rejected.

source_channel: String

The source channel used for the withdrawal

use_compat_address: bool

👎Deprecated

Whether to use a “compat” (bech32, non-m) address for the return address in the withdrawal, for compatability with chains that expect to be able to parse the return address as bech32.

ics20_memo: String

Arbitrary string data to be included in the memo field of the ICS-20 FungibleTokenPacketData for this withdrawal. Commonly used for packet forwarding support, or other protocols that may support usage of the memo field.

use_transparent_address: bool

Whether to use a transparent address (bech32, 32-byte) for the return address in the withdrawal.

Trait Implementations

impl Clone for Ics20Withdrawal

fn clone(&self) -> Ics20Withdrawal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ics20Withdrawal

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

Formats the value using the given formatter.

impl Default for Ics20Withdrawal

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Ics20Withdrawal

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for Ics20Withdrawal

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Name for Ics20Withdrawal

const NAME: &'static str = "Ics20Withdrawal"

Simple name for this Message. This name is the same as it appears in the source .proto file, e.g. FooBar.

const PACKAGE: &'static str = "penumbra.core.component.ibc.v1"

Package name this message type is contained in. They are domain-like and delimited by ., e.g. google.protobuf.

fn full_name() -> String

Fully-qualified unique name for this Message. It’s prefixed with the package name and names of any parent messages, e.g. google.rpc.BadRequest.FieldViolation. By default, this is the package name followed by the message name. Fully-qualified names must be unique within a domain of Type URLs.

fn type_url() -> String

Type URL for this Message, which by default is the full name with a leading slash, but may also include a leading domain name, e.g. type.googleapis.com/google.profile.Person. This can be used when serializing with the [Any] type.

impl PartialEq for Ics20Withdrawal

fn eq(&self, other: &Ics20Withdrawal) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Ics20Withdrawal

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Ics20Withdrawal