Skip to main content

DiscoveryRecordV1

Struct DiscoveryRecordV1 

Source
pub struct DiscoveryRecordV1 {
    pub v: u8,
    pub username: Username,
    pub address: Address,
    pub pubkey: Vec<u8>,
    pub nostr_author: Vec<u8>,
    pub issued_at_ms: i64,
    pub sig: Vec<u8>,
}
Expand description

A signed claim that a username points at an address.

Serialized as JSON inside a sealed relay record. The byte-level contract is Self::signing_payload, not this struct’s JSON: two implementations must agree on the signed bytes, and may disagree on JSON key order.

Fields§

§v: u8

Format version. Always DISCOVERY_VERSION in this build.

§username: Username

The claimed name, in normalized form.

Typed, so a record naming an unnormalized username fails to deserialize rather than being compared against a queried name it can never equal.

§address: Address

The address the claim points at.

§pubkey: Vec<u8>

The Ed25519 identity key. derive_address(pubkey) must equal address.

§nostr_author: Vec<u8>

The x-only Nostr key this record is valid when published under.

See the module docs: this is what stops a third party from keeping a retracted claim alive.

§issued_at_ms: i64

Signing time, in milliseconds since the Unix epoch.

Advisory only. See verify_discovery_record.

§sig: Vec<u8>

Ed25519 signature by pubkey over Self::signing_payload.

Implementations§

Source§

impl DiscoveryRecordV1

Source

pub fn signing_payload( username: &Username, address: &Address, pubkey: &[u8], nostr_author: &[u8], issued_at_ms: i64, ) -> Result<Vec<u8>>

Builds the payload the signature is taken over.

domain ‖ u32be‖bytes over [v, username, address, pubkey, nostr_author, issued_at_ms], in that fixed order. issued_at_ms is encoded as its 8-byte big-endian form, not as a decimal string, so two implementations cannot disagree about leading zeroes or a sign.

Source

pub fn unsigned( username: Username, address: Address, pubkey: Vec<u8>, nostr_author: Vec<u8>, issued_at_ms: i64, ) -> Self

Builds an unsigned record, ready for Self::sign_with.

Source

pub fn sign_with<F>(self, signer: F) -> Result<Self>
where F: FnOnce(&[u8]) -> Result<Vec<u8>>,

Signs the record with signer, which must be the private half of self.pubkey.

Taking a closure keeps the private key where it lives (the engine’s MLS manager) rather than passing key material into this module.

Trait Implementations§

Source§

impl Clone for DiscoveryRecordV1

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 DiscoveryRecordV1

Source§

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

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

impl<'de> Deserialize<'de> for DiscoveryRecordV1

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 Eq for DiscoveryRecordV1

Source§

impl PartialEq for DiscoveryRecordV1

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for DiscoveryRecordV1

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 StructuralPartialEq for DiscoveryRecordV1

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> Classify for T

Source§

type Classified = T

Source§

fn classify(self) -> T

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> Declassify for T

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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