Skip to main content

AuthPayload

Struct AuthPayload 

Source
pub struct AuthPayload {
    pub signed_message: SignedMessage,
    pub nonce: [u8; 32],
    pub message: String,
    pub recipient: String,
    pub callback_url: Option<String>,
}
Expand description

HTTP request payload for NEP-413 authentication.

This is the typical JSON structure sent from a frontend to a backend for authentication. Use this to deserialize the HTTP request body.

§Example

use near_kit::nep413::{AuthPayload, verify_signature, DEFAULT_MAX_AGE};

// Parse JSON from HTTP request body (in a real app, from req.body)
fn handle_login(body: &str) -> bool {
    let payload: AuthPayload = serde_json::from_str(body).unwrap();
    let params = payload.to_params();
    verify_signature(&payload.signed_message, &params, DEFAULT_MAX_AGE)
}

Fields§

§signed_message: SignedMessage

The signed message from the client.

§nonce: [u8; 32]

The nonce as a hex-encoded string (64 characters for 32 bytes).

§message: String

The message that was signed (must match what the client signed).

§recipient: String

The recipient identifier (must match what the client signed).

§callback_url: Option<String>

Optional callback URL (must match what the client signed, if any).

Implementations§

Source§

impl AuthPayload

Source

pub fn to_params(&self) -> SignMessageParams

Convert to SignMessageParams for verification.

Source

pub fn from_signed( signed_message: SignedMessage, params: &SignMessageParams, ) -> Self

Create an AuthPayload from a signed message and the original parameters.

This is useful when you want to generate the same JSON format that a TypeScript client would produce, for example when testing or when a Rust client needs to authenticate to a service.

§Example
use near_kit::{Near, nep413};

let near = Near::testnet()
    .credentials("ed25519:...", "alice.testnet")?
    .build();

let params = nep413::SignMessageParams {
    message: "Sign in to My App".to_string(),
    recipient: "myapp.com".to_string(),
    nonce: nep413::generate_nonce(),
    callback_url: None,
    state: None,
};

let signed = near.sign_message(params.clone()).await?;
let payload = nep413::AuthPayload::from_signed(signed, &params);

// Serialize to JSON for HTTP request
let json = serde_json::to_string(&payload)?;
println!("POST body: {}", json);

Trait Implementations§

Source§

impl Clone for AuthPayload

Source§

fn clone(&self) -> AuthPayload

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AuthPayload

Source§

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

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

impl<'de> Deserialize<'de> for AuthPayload

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 Serialize for AuthPayload

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

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> 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: 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: 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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
Source§

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