Struct ChannelAuthorize

pub struct ChannelAuthorize<'a> {
    pub common_fields: CommonFields<'a>,
    pub channel_id: Cow<'a, str>,
    pub amount: Cow<'a, str>,
    pub secret: Option<Cow<'a, str>>,
    pub seed: Option<Cow<'a, str>>,
    pub seed_hex: Option<Cow<'a, str>>,
    pub passphrase: Option<Cow<'a, str>>,
    pub key_type: Option<CryptoAlgorithm>,
}

The channel_authorize method creates a signature that can be used to redeem a specific amount of XRP from a payment channel.

Warning: Do not send secret keys to untrusted servers or through unsecured network connections. (This includes the secret, seed, seed_hex, or passphrase fields of this request.) You should only use this method on a secure, encrypted network connection to a server you run or fully trust with your funds. Otherwise, eavesdroppers could use your secret key to sign claims and take all the money from this payment channel and anything else using the same key pair.

See Set Up Secure Signing: <https://xrpl.org/set-up-secure-signing.html>

See Channel Authorize: <https://xrpl.org/channel_authorize.html>

Fields

common_fields: CommonFields<'a>

The common fields shared by all requests.

channel_id: Cow<'a, str>

The unique ID of the payment channel to use.

amount: Cow<'a, str>

Cumulative amount of XRP, in drops, to authorize. If the destination has already received a lesser amount of XRP from this channel, the signature created by this method can be redeemed for the difference.

secret: Option<Cow<'a, str>>

The secret key to use to sign the claim. This must be the same key pair as the public key specified in the channel. Cannot be used with seed, seed_hex, or passphrase.

seed: Option<Cow<'a, str>>

The secret seed to use to sign the claim. This must be the same key pair as the public key specified in the channel. Must be in the XRP Ledger’s base58 format. If provided, you must also specify the key_type. Cannot be used with secret, seed_hex, or passphrase.

seed_hex: Option<Cow<'a, str>>

The secret seed to use to sign the claim. This must be the same key pair as the public key specified in the channel. Must be in hexadecimal format. If provided, you must also specify the key_type. Cannot be used with secret, seed, or passphrase.

passphrase: Option<Cow<'a, str>>

A string passphrase to use to sign the claim. This must be the same key pair as the public key specified in the channel. The key derived from this passphrase must match the public key specified in the channel. If provided, you must also specify the key_type. Cannot be used with secret, seed, or seed_hex.

key_type: Option<CryptoAlgorithm>

The signing algorithm of the cryptographic key pair provided. Valid types are secp256k1 or ed25519. The default is secp256k1.

Implementations

impl<'a> ChannelAuthorize<'a>

pub fn new( id: Option<Cow<'a, str>>, channel_id: Cow<'a, str>, amount: Cow<'a, str>, secret: Option<Cow<'a, str>>, seed: Option<Cow<'a, str>>, seed_hex: Option<Cow<'a, str>>, passphrase: Option<Cow<'a, str>>, key_type: Option<CryptoAlgorithm>, ) -> Self

Trait Implementations

impl<'a> ChannelAuthorizeError for ChannelAuthorize<'a>

fn _get_field_error(&self) -> XRPLModelResult<()>

impl<'a> Clone for ChannelAuthorize<'a>

fn clone(&self) -> ChannelAuthorize<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ChannelAuthorize<'a>

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

Formats the value using the given formatter.

impl<'de, 'a> Deserialize<'de> for ChannelAuthorize<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<ChannelAuthorize<'a>> for XRPLRequest<'a>

fn from(request: ChannelAuthorize<'a>) -> Self

Converts to this type from the input type.

impl<'a> Model for ChannelAuthorize<'a>

fn get_errors(&self) -> XRPLModelResult<()>

Collects a models errors and returns the first error that occurs.

fn validate(&self) -> XRPLModelResult<()>

Simply forwards the error from get_errors if there was one.

fn is_valid(&self) -> bool

Checks if the model is valid.

impl<'a> PartialEq for ChannelAuthorize<'a>

fn eq(&self, other: &ChannelAuthorize<'a>) -> 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<'a> Request<'a> for ChannelAuthorize<'a>

fn get_common_fields(&self) -> &CommonFields<'a>

fn get_common_fields_mut(&mut self) -> &mut CommonFields<'a>

impl<'a> Serialize for ChannelAuthorize<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Eq for ChannelAuthorize<'a>

impl<'a> StructuralPartialEq for ChannelAuthorize<'a>