@libp2p/interface-connection-encrypter/dist/src/index.d.ts

Connection Encrypter interface for libp2p

import type { PeerId } from '@libp2p/interface-peer-id';
import type { Duplex, Source } from 'it-stream-types';
/**
 * A libp2p connection encrypter module must be compliant to this interface
 * to ensure all exchanged data between two peers is encrypted.
 */
export interface ConnectionEncrypter<Extension = unknown> {
    protocol: string;
    /**
     * 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.
     */
    secureOutbound: (localPeer: PeerId, connection: Duplex<AsyncGenerator<Uint8Array>, Source<Uint8Array>, Promise<void>>, remotePeer?: PeerId) => Promise<SecuredConnection<Extension>>;
    /**
     * Decrypt incoming data. If the remote PeerId is known,
     * pass it for extra verification, otherwise it will be determined during
     * the handshake
     */
    secureInbound: (localPeer: PeerId, connection: Duplex<AsyncGenerator<Uint8Array>, Source<Uint8Array>, Promise<void>>, remotePeer?: PeerId) => Promise<SecuredConnection<Extension>>;
}
export interface SecuredConnection<Extension = unknown> {
    conn: Duplex<AsyncGenerator<Uint8Array>, Source<Uint8Array>, Promise<void>>;
    remoteExtensions?: Extension;
    remotePeer: PeerId;
}
//# sourceMappingURL=index.d.ts.map