Interface ConnectionEncrypter<Extension>

A libp2p connection encrypter module must be compliant to this interface to ensure all exchanged data between two peers is encrypted.

interface ConnectionEncrypter<Extension = unknown> {
    protocol: string;
    secureInbound<
        Stream extends
            Duplex<
                AsyncGenerator<
                    Uint8Array<ArrayBufferLike>
                    | Uint8ArrayList,
                    any,
                    any,
                >,
                AsyncGenerator<Uint8Array<ArrayBufferLike> | Uint8ArrayList, any, any>,
                unknown,
            > = MultiaddrConnection,
    >(
        connection: Stream,
        options?: SecureConnectionOptions,
    ): Promise<SecuredConnection<Stream, Extension>>;
    secureOutbound<
        Stream extends
            Duplex<
                AsyncGenerator<
                    Uint8Array<ArrayBufferLike>
                    | Uint8ArrayList,
                    any,
                    any,
                >,
                AsyncGenerator<Uint8Array<ArrayBufferLike> | Uint8ArrayList, any, any>,
                unknown,
            > = MultiaddrConnection,
    >(
        connection: Stream,
        options?: SecureConnectionOptions,
    ): Promise<SecuredConnection<Stream, Extension>>;
}

Type Parameters

Extension = unknown

Index

Properties

Methods

secureInbound secureOutbound

Properties

protocol

protocol: string

Methods

secureInbound

secureInbound<
    Stream extends
        Duplex<
            AsyncGenerator<Uint8Array<ArrayBufferLike> | Uint8ArrayList, any, any>,
            AsyncGenerator<Uint8Array<ArrayBufferLike> | Uint8ArrayList, any, any>,
            unknown,
        > = MultiaddrConnection,
>(
    connection: Stream,
    options?: SecureConnectionOptions,
): Promise<SecuredConnection<Stream, Extension>>
Decrypt incoming data. If the remote PeerId is known, pass it for extra verification, otherwise it will be determined during the handshake
Type Parameters
- Stream extends Duplex<
      AsyncGenerator<Uint8Array<ArrayBufferLike> | Uint8ArrayList, any, any>,
      AsyncGenerator<Uint8Array<ArrayBufferLike> | Uint8ArrayList, any, any>,
      unknown,
  > = MultiaddrConnection
Parameters
- connection: Stream
- Optionaloptions: SecureConnectionOptions
Returns Promise<SecuredConnection<Stream, Extension>>
- Defined in packages/interface/src/connection-encrypter.ts:43

secureOutbound

secureOutbound<
    Stream extends
        Duplex<
            AsyncGenerator<Uint8Array<ArrayBufferLike> | Uint8ArrayList, any, any>,
            AsyncGenerator<Uint8Array<ArrayBufferLike> | Uint8ArrayList, any, any>,
            unknown,
        > = MultiaddrConnection,
>(
    connection: Stream,
    options?: SecureConnectionOptions,
): Promise<SecuredConnection<Stream, Extension>>
Encrypt outgoing data to the remote party. If the remote PeerId is known, pass it for extra verification, otherwise it will be determined during the handshake.
Type Parameters
- Stream extends Duplex<
      AsyncGenerator<Uint8Array<ArrayBufferLike> | Uint8ArrayList, any, any>,
      AsyncGenerator<Uint8Array<ArrayBufferLike> | Uint8ArrayList, any, any>,
      unknown,
  > = MultiaddrConnection
Parameters
- connection: Stream
- Optionaloptions: SecureConnectionOptions
Returns Promise<SecuredConnection<Stream, Extension>>
- Defined in packages/interface/src/connection-encrypter.ts:36