Class RecordEnvelope

Hierarchy

RecordEnvelope

Implements

Envelope

Index

Constructors

Properties

marshaled? payload payloadType peerId signature

Methods

equals marshal validate createFromProtobuf openAndCertify seal

Constructors

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
- Defined in envelope/index.ts:85

Properties

`Optional` marshaled

marshaled?: Uint8Array

payload

payload: Uint8Array

payloadType

payloadType: Uint8Array

peerId

peerId: PeerId

signature

signature: Uint8Array

Methods

equals

equals(other: Envelope): boolean
Verifies if the other Envelope is identical to this one
Parameters
- other: Envelope
Returns boolean
Implementation of Envelope.equals
- Defined in envelope/index.ts:117

marshal

marshal(): Uint8Array
Marshal the envelope content

Returns Uint8Array
Implementation of Envelope.marshal
- Defined in envelope/index.ts:97

validate

validate(domain: string): Promise<boolean>
Validate envelope data signature for the given domain
Parameters
- domain: string
Returns Promise<boolean>
Implementation of Envelope.validate
- Defined in envelope/index.ts:124

`Static` createFromProtobuf

createFromProtobuf(data: Uint8Array | Uint8ArrayList): Promise<RecordEnvelope>
Unmarshal a serialized Envelope protobuf message
Parameters
- data: Uint8Array | Uint8ArrayList
Returns Promise<RecordEnvelope>
- Defined in envelope/index.ts:24

`Static` openAndCertify

openAndCertify(data: Uint8Array | Uint8ArrayList, domain: string): Promise<RecordEnvelope>
Open and certify a given marshalled envelope. Data is unmarshalled and the signature validated for the given domain.
Parameters
- data: Uint8Array | Uint8ArrayList
- domain: string
Returns Promise<RecordEnvelope>
- Defined in envelope/index.ts:64

`Static` seal

seal(record: Record, peerId: PeerId): 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
- peerId: PeerId
Returns Promise<RecordEnvelope>
- Defined in envelope/index.ts:40