Skip to main content

Permit2AllowancePayload

Struct Permit2AllowancePayload 

Source
pub struct Permit2AllowancePayload {
    pub data: Eip712Message,
    pub payload_id: String,
    pub type_: Permit2AllowancePayloadType,
}
Expand description

A Permit2 PermitSingle (AllowanceTransfer) typed-data payload. It grants the spender a reusable allowance through the canonical Permit2 contract, so it can back repeated charges rather than a single transfer. The payer must pass data to eth_signTypedData_v4 and return the resulting signature. A one-time ERC-20 approval of the Permit2 contract (an erc20_approval payload) is required first if the wallet has not yet approved Permit2 for this asset.

JSON schema
{
 "title": "Permit2 Allowance Payload",
 "description": "A Permit2 `PermitSingle` (AllowanceTransfer) typed-data payload. It grants the spender a reusable allowance through the canonical Permit2 contract, so it can back repeated charges rather than a single transfer. The payer must pass `data` to `eth_signTypedData_v4` and return the resulting signature. A one-time ERC-20 approval of the Permit2 contract (an `erc20_approval` payload) is required first if the wallet has not yet approved Permit2 for this asset.",
 "examples": [
   {
     "data": {
       "domain": {
         "chainId": 8453,
         "name": "Permit2",
         "verifyingContract": "0x000000000022D473030F116dDEE9F6B43aC78BA3"
       },
       "message": {
         "details": {
           "amount": "1461501637330902918203684832716283019655932542975",
           "expiration": "1798761600",
           "nonce": "0",
           "token": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"
         },
         "sigDeadline": "1798761600",
         "spender": "0x9Fb909eA400c2b8D99Be292DADf07e63B814527c"
       },
       "primaryType": "PermitSingle",
       "types": {
         "EIP712Domain": [
           {
             "name": "name",
             "type": "string"
           },
           {
             "name": "chainId",
             "type": "uint256"
           },
           {
             "name": "verifyingContract",
             "type": "address"
           }
         ],
         "PermitDetails": [
           {
             "name": "token",
             "type": "address"
           },
           {
             "name": "amount",
             "type": "uint160"
           },
           {
             "name": "expiration",
             "type": "uint48"
           },
           {
             "name": "nonce",
             "type": "uint48"
           }
         ],
         "PermitSingle": [
           {
             "name": "details",
             "type": "PermitDetails"
           },
           {
             "name": "spender",
             "type": "address"
           },
           {
             "name": "sigDeadline",
             "type": "uint256"
           }
         ]
       }
     },
     "payloadId": "payload_cg4059d2-b068-6ih9-dha1-eee44f157336",
     "type": "permit2"
   }
 ],
 "type": "object",
 "required": [
   "data",
   "payloadId",
   "type"
 ],
 "properties": {
   "data": {
     "description": "EIP-712 typed data for a Permit2 `PermitSingle`. Pass to `eth_signTypedData_v4`.",
     "examples": [
       {
         "domain": {
           "chainId": 8453,
           "name": "Permit2",
           "verifyingContract": "0x000000000022D473030F116dDEE9F6B43aC78BA3"
         },
         "message": {
           "details": {
             "amount": "1461501637330902918203684832716283019655932542975",
             "expiration": "1798761600",
             "nonce": "0",
             "token": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"
           },
           "sigDeadline": "1798761600",
           "spender": "0x9Fb909eA400c2b8D99Be292DADf07e63B814527c"
         },
         "primaryType": "PermitSingle",
         "types": {
           "EIP712Domain": [
             {
               "name": "name",
               "type": "string"
             },
             {
               "name": "chainId",
               "type": "uint256"
             },
             {
               "name": "verifyingContract",
               "type": "address"
             }
           ],
           "PermitDetails": [
             {
               "name": "token",
               "type": "address"
             },
             {
               "name": "amount",
               "type": "uint160"
             },
             {
               "name": "expiration",
               "type": "uint48"
             },
             {
               "name": "nonce",
               "type": "uint48"
             }
           ],
           "PermitSingle": [
             {
               "name": "details",
               "type": "PermitDetails"
             },
             {
               "name": "spender",
               "type": "address"
             },
             {
               "name": "sigDeadline",
               "type": "uint256"
             }
           ]
         }
       }
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/EIP712Message"
       }
     ]
   },
   "payloadId": {
     "description": "The unique identifier of the payload.",
     "examples": [
       "payload_cg4059d2-b068-6ih9-dha1-eee44f157336"
     ],
     "type": "string"
   },
   "type": {
     "description": "The payload type.",
     "examples": [
       "permit2"
     ],
     "type": "string",
     "enum": [
       "permit2"
     ]
   }
 }
}

Fields§

§data: Eip712Message

EIP-712 typed data for a Permit2 PermitSingle. Pass to eth_signTypedData_v4.

§payload_id: String

The unique identifier of the payload.

§type_: Permit2AllowancePayloadType

The payload type.

Implementations§

Trait Implementations§

Source§

impl Clone for Permit2AllowancePayload

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Permit2AllowancePayload

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Permit2AllowancePayload

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<&Permit2AllowancePayload> for Permit2AllowancePayload

Source§

fn from(value: &Permit2AllowancePayload) -> Self

Converts to this type from the input type.
Source§

impl From<Permit2AllowancePayload> for ApprovalPayload

Source§

fn from(value: Permit2AllowancePayload) -> Self

Converts to this type from the input type.
Source§

impl From<Permit2AllowancePayload> for RevocationPayload

Source§

fn from(value: Permit2AllowancePayload) -> Self

Converts to this type from the input type.
Source§

impl From<Permit2AllowancePayload> for Permit2AllowancePayload

Source§

fn from(value: Permit2AllowancePayload) -> Self

Converts to this type from the input type.
Source§

impl Serialize for Permit2AllowancePayload

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl TryFrom<Permit2AllowancePayload> for Permit2AllowancePayload

Source§

type Error = ConversionError

The type returned in the event of a conversion error.
Source§

fn try_from(value: Permit2AllowancePayload) -> Result<Self, ConversionError>

Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more