Interface Envelope

A message with a signed payload.

interface Envelope {
    payload: Uint8Array;
    payloadType: Uint8Array<ArrayBufferLike> | Uint8ArrayList;
    publicKey: PublicKey;
    signature: Uint8Array<ArrayBufferLike> | Uint8ArrayList;
    equals(other?: Envelope): boolean;
    marshal(): Uint8Array;
    validate(domain: string): Promise<boolean>;
}

Implemented by

RecordEnvelope

Index

Properties

payload payloadType publicKey signature

Methods

equals marshal validate

Properties

payload

payload: Uint8Array

The contents of the envelope

payloadType

payloadType: Uint8Array<ArrayBufferLike> | Uint8ArrayList

How the payload should be interpreted

publicKey

publicKey: PublicKey

The public key of the keypair used to sign the payload

signature

signature: Uint8Array<ArrayBufferLike> | Uint8ArrayList

A signature that can be used to verify the payload is intact

Methods

equals

equals(other?: Envelope): boolean
Returns true if this envelope has equivalency with the passed object
Parameters
- Optionalother: Envelope
Returns boolean
- Defined in packages/interface/src/record.ts:63

marshal

marshal(): Uint8Array
Serialize the envelope to a binary format

Returns Uint8Array
- Defined in packages/interface/src/record.ts:53

validate

validate(domain: string): Promise<boolean>
Use the public key to validate that the payload is intact
Parameters
- domain: string
Returns Promise<boolean>
- Defined in packages/interface/src/record.ts:58