Class PrivateInternetGatewayChannel

constructor

• new PrivateInternetGatewayChannel(node, peer, deliveryAuthPath, keyStores, cryptoOptions?): PrivateInternetGatewayChannel

• Parameters

  • node: Node<GatewayPayload, string>

  • peer: Peer<string>

  • deliveryAuthPath: CertificationPath

  • keyStores: KeyStoreSet

  • cryptoOptions: Partial<NodeCryptoOptions> = {}

  Returns PrivateInternetGatewayChannel

cryptoOptions

Readonly deliveryAuthPath

Readonly keyStores

Readonly node

Readonly peer

generateCargoes

• generateCargoes(messages): AsyncIterable<Buffer>

• Parameters

  • messages: CargoMessageStream

  Returns AsyncIterable<Buffer>

getCDAIssuers

• getCDAIssuers(): Promise<readonly Certificate[]>

• Get all CDA issuers in the channel.

  Returns Promise<readonly Certificate[]>

getOrCreateCDAIssuer

• getOrCreateCDAIssuer(): Promise<Certificate>

• Returns Promise<Certificate>

getOutboundRAMFRecipient

• getOutboundRAMFRecipient(): Recipient

• Returns Recipient

makeMessage

• makeMessage(payload, messageConstructor, options?): Promise<ArrayBuffer>

• Generate and serialise a message with the given payload.

  Parameters

  • payload: ArrayBuffer | GatewayPayload

    The payload to encrypt and encapsulate

  • messageConstructor: RAMFMessageConstructor<GatewayPayload>

    The message class constructor

  • options: Partial<Omit<MessageOptions, "senderCaCertificateChain">> = {}

  Returns Promise<ArrayBuffer>