Class RecordEnvelope

constructor

• new RecordEnvelope(init: RecordEnvelopeInit): RecordEnvelope

  The Envelope is responsible for keeping an arbitrary signed record by a libp2p peer.

  Parameters

  • init: RecordEnvelopeInit

  Returns RecordEnvelope

Optionalmarshaled

payload

payloadType

publicKey

signature

equals

• equals(other?: Envelope): boolean

  Verifies if the other Envelope is identical to this one

  Parameters

  • Optionalother: Envelope

  Returns boolean

marshal

• marshal(): Uint8Array

  Marshal the envelope content

  Returns Uint8Array

validate

• validate(domain: string, options?: AbortOptions): Promise<boolean>

  Validate envelope data signature for the given domain

  Parameters

  • domain: string
  • Optionaloptions: AbortOptions

  Returns Promise<boolean>

StaticcreateFromProtobuf

• createFromProtobuf(
      data: Uint8Array<ArrayBufferLike> | Uint8ArrayList,
  ): RecordEnvelope

  Unmarshal a serialized Envelope protobuf message

  Parameters

  • data: Uint8Array<ArrayBufferLike> | Uint8ArrayList

  Returns RecordEnvelope

StaticopenAndCertify

• openAndCertify(
      data: Uint8Array<ArrayBufferLike> | Uint8ArrayList,
      domain: string,
      options?: AbortOptions,
  ): Promise<RecordEnvelope>

  Open and certify a given marshaled envelope. Data is unmarshaled and the signature validated for the given domain.

  Parameters

  • data: Uint8Array<ArrayBufferLike> | Uint8ArrayList
  • domain: string
  • Optionaloptions: AbortOptions

  Returns Promise<RecordEnvelope>

Staticseal

• seal(
      record: Record,
      privateKey: PrivateKey,
      options?: AbortOptions,
  ): Promise<RecordEnvelope>

  Seal marshals the given Record, places the marshaled bytes inside an Envelope and signs it with the given peerId's private key

  Parameters

  • record: Record
  • privateKey: PrivateKey
  • Optionaloptions: AbortOptions

  Returns Promise<RecordEnvelope>