@tezos-x/octez.connect-core 0.9.0 → 4.8.1

package/dist/cjs/src/transports/Transport.js

@@ -0,0 +1,171 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Transport = void 0;
+const Logger_1 = require("../utils/Logger");
+const octez_connect_types_1 = require("@tezos-x/octez.connect-types");
+const logger = new Logger_1.Logger('Transport');
+/**
+ * @internalapi
+ *
+ *
+ */
+class Transport {
+    setEventHandler(event, fun) {
+        this.client.eventHandlers.set(event, fun);
+    }
+    /**
+     * Return the status of the connection
+     */
+    get connectionStatus() {
+        return this._isConnected;
+    }
+    constructor(name, client, peerManager) {
+        /**
+         * The type of the transport
+         */
+        this.type = octez_connect_types_1.TransportType.POST_MESSAGE;
+        /**
+         * The status of the transport
+         */
+        this._isConnected = octez_connect_types_1.TransportStatus.NOT_CONNECTED;
+        /**
+         * The listeners that will be notified when new messages are coming in
+         */
+        this.listeners = [];
+        this.name = name;
+        this.client = client;
+        this.peerManager = peerManager;
+    }
+    /**
+     * Returns a promise that resolves to true if the transport is available, false if it is not
+     */
+    static isAvailable() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return Promise.resolve(false);
+        });
+    }
+    /**
+     * Connect the transport
+     */
+    connect() {
+        return __awaiter(this, void 0, void 0, function* () {
+            logger.log('connect');
+            this._isConnected = octez_connect_types_1.TransportStatus.CONNECTED;
+            return;
+        });
+    }
+    /**
+     * Disconnect the transport
+     */
+    disconnect() {
+        return __awaiter(this, void 0, void 0, function* () {
+            logger.log('disconnect');
+            this._isConnected = octez_connect_types_1.TransportStatus.NOT_CONNECTED;
+            return;
+        });
+    }
+    /**
+     * Send a message through the transport
+     *
+     * @param message The message to send
+     * @param recipient The recipient of the message
+     */
+    send(message, peer) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (peer) {
+                return this.client.sendMessage(message, peer);
+            }
+            else {
+                const knownPeers = yield this.getPeers();
+                // A broadcast request has to be sent everywhere.
+                const promises = knownPeers.map((peerEl) => this.client.sendMessage(message, peerEl));
+                return (yield Promise.all(promises))[0];
+            }
+        });
+    }
+    /**
+     * Add a listener to be called when a new message is received
+     *
+     * @param listener The listener that will be registered
+     */
+    addListener(listener) {
+        return __awaiter(this, void 0, void 0, function* () {
+            logger.debug('addListener');
+            this.listeners.push(listener);
+            return;
+        });
+    }
+    /**
+     * Remove a listener
+     *
+     * @param listener
+     */
+    removeListener(listener) {
+        return __awaiter(this, void 0, void 0, function* () {
+            logger.log('removeListener');
+            this.listeners = this.listeners.filter((element) => element !== listener);
+            return;
+        });
+    }
+    getPeers() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.peerManager.getPeers(); // TODO: Fix type
+        });
+    }
+    addPeer(newPeer_1) {
+        return __awaiter(this, arguments, void 0, function* (newPeer, _sendPairingResponse = true) {
+            logger.log('addPeer', 'adding peer', newPeer);
+            yield this.peerManager.addPeer(newPeer); // TODO: Fix type
+            yield this.listen(newPeer.publicKey);
+        });
+    }
+    removePeer(peerToBeRemoved) {
+        return __awaiter(this, void 0, void 0, function* () {
+            logger.log('removePeer', 'removing peer', peerToBeRemoved);
+            yield this.peerManager.removePeer(peerToBeRemoved.publicKey);
+            if (this.client) {
+                yield this.client.unsubscribeFromEncryptedMessage(peerToBeRemoved.publicKey);
+            }
+        });
+    }
+    removeAllPeers() {
+        return __awaiter(this, void 0, void 0, function* () {
+            logger.log('removeAllPeers');
+            yield this.peerManager.removeAllPeers();
+            if (this.client) {
+                yield this.client.unsubscribeFromEncryptedMessages();
+            }
+        });
+    }
+    /**
+     * Notify the listeners when a new message comes in
+     *
+     * @param message Message
+     * @param connectionInfo Context info about the connection
+     */
+    notifyListeners(message, connectionInfo) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.listeners.length === 0) {
+                logger.warn('notifyListeners', '0 listeners notified!', this);
+            }
+            else {
+                logger.log('notifyListeners', `Notifying ${this.listeners.length} listeners`, this);
+            }
+            this.listeners.forEach((listener) => {
+                listener(message, connectionInfo);
+            });
+            return;
+        });
+    }
+}
+exports.Transport = Transport;
+//# sourceMappingURL=Transport.js.map

package/dist/cjs/src/transports/Transport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Transport.js","sourceRoot":"","sources":["../../../../src/transports/Transport.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4CAAwC;AACxC,sEAOqC;AAMrC,MAAM,MAAM,GAAG,IAAI,eAAM,CAAC,WAAW,CAAC,CAAA;AAEtC;;;;GAIG;AACH,MAAsB,SAAS;IAqC7B,eAAe,CAAC,KAAmB,EAAE,GAAa;QAChD,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;IAC3C,CAAC;IAOD;;OAEG;IACH,IAAW,gBAAgB;QACzB,OAAO,IAAI,CAAC,YAAY,CAAA;IAC1B,CAAC;IAED,YAAY,IAAY,EAAE,MAAS,EAAE,WAA2B;QA3ChE;;WAEG;QACa,SAAI,GAAkB,mCAAa,CAAC,YAAY,CAAA;QAOhE;;WAEG;QACO,iBAAY,GAAoB,qCAAe,CAAC,aAAa,CAAA;QAkBvE;;WAEG;QACK,cAAS,GAAsE,EAAE,CAAA;QAUvF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;IAChC,CAAC;IAED;;OAEG;IACI,MAAM,CAAO,WAAW;;YAC7B,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAC/B,CAAC;KAAA;IAED;;OAEG;IACU,OAAO;;YAClB,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;YACrB,IAAI,CAAC,YAAY,GAAG,qCAAe,CAAC,SAAS,CAAA;YAE7C,OAAM;QACR,CAAC;KAAA;IAED;;OAEG;IACU,UAAU;;YACrB,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;YACxB,IAAI,CAAC,YAAY,GAAG,qCAAe,CAAC,aAAa,CAAA;YAEjD,OAAM;QACR,CAAC;KAAA;IAED;;;;;OAKG;IACU,IAAI,CAAC,OAAe,EAAE,IAAe;;YAChD,IAAI,IAAI,EAAE,CAAC;gBACT,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;YAC/C,CAAC;iBAAM,CAAC;gBACN,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAA;gBACxC,iDAAiD;gBACjD,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAA;gBAErF,OAAO,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YACzC,CAAC;QACH,CAAC;KAAA;IAED;;;;OAIG;IACU,WAAW,CACtB,QAAuE;;YAEvE,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAA;YAE3B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YAE7B,OAAM;QACR,CAAC;KAAA;IAED;;;;OAIG;IACU,cAAc,CACzB,QAAsE;;YAEtE,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAA;YAE5B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAA;YAEzE,OAAM;QACR,CAAC;KAAA;IAEY,QAAQ;;YACnB,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAS,CAAA,CAAC,iBAAiB;QAC7D,CAAC;KAAA;IAEY,OAAO;6DAAC,OAAU,EAAE,uBAAgC,IAAI;YACnE,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,aAAa,EAAE,OAAO,CAAC,CAAA;YAC7C,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,OAA6C,CAAC,CAAA,CAAC,iBAAiB;YAC/F,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;QACtC,CAAC;KAAA;IAEY,UAAU,CAAC,eAAkB;;YACxC,MAAM,CAAC,GAAG,CAAC,YAAY,EAAE,eAAe,EAAE,eAAe,CAAC,CAAA;YAC1D,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,eAAe,CAAC,SAAS,CAAC,CAAA;YAC5D,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBAChB,MAAM,IAAI,CAAC,MAAM,CAAC,+BAA+B,CAAC,eAAe,CAAC,SAAS,CAAC,CAAA;YAC9E,CAAC;QACH,CAAC;KAAA;IAEY,cAAc;;YACzB,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAA;YAC5B,MAAM,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE,CAAA;YACvC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBAChB,MAAM,IAAI,CAAC,MAAM,CAAC,gCAAgC,EAAE,CAAA;YACtD,CAAC;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACa,eAAe,CAC7B,OAAgB,EAChB,cAAiC;;YAEjC,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAChC,MAAM,CAAC,IAAI,CAAC,iBAAiB,EAAE,uBAAuB,EAAE,IAAI,CAAC,CAAA;YAC/D,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,GAAG,CAAC,iBAAiB,EAAE,aAAa,IAAI,CAAC,SAAS,CAAC,MAAM,YAAY,EAAE,IAAI,CAAC,CAAA;YACrF,CAAC;YAED,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;gBAClC,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC,CAAA;YACnC,CAAC,CAAC,CAAA;YAEF,OAAM;QACR,CAAC;KAAA;CAGF;AAxLD,8BAwLC"}

package/dist/cjs/src/transports/clients/ClientEvents.d.ts

@@ -0,0 +1,6 @@
+export declare const enum ClientEvents {
+    CLOSE_ALERT = "CLOSE_ALERT",
+    RESET_STATE = "RESET_STATE",
+    WC_ACK_NOTIFICATION = "WC_ACK_NOTIFICATION",
+    ON_RELAYER_ERROR = "ON_RELAYER_ERROR"
+}

package/dist/cjs/src/transports/clients/ClientEvents.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ClientEvents.js.map

package/dist/cjs/src/transports/clients/ClientEvents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ClientEvents.js","sourceRoot":"","sources":["../../../../../src/transports/clients/ClientEvents.ts"],"names":[],"mappings":""}

package/dist/cjs/src/transports/clients/CommunicationClient.d.ts

@@ -0,0 +1,47 @@
+import { PeerInfoType } from '@tezos-x/octez.connect-types';
+import { KeyPair } from '@stablelib/ed25519';
+import { SessionKeys } from '@stablelib/x25519-session';
+import { ClientEvents } from './ClientEvents';
+/**
+ * @internalapi
+ *
+ *
+ */
+export declare abstract class CommunicationClient {
+    protected keyPair?: KeyPair | undefined;
+    constructor(keyPair?: KeyPair | undefined);
+    eventHandlers: Map<ClientEvents, Function>;
+    protected isMobileOS: () => boolean;
+    /**
+     * Get the public key
+     */
+    getPublicKey(): Promise<string>;
+    /**
+     * get the public key hash
+     */
+    getPublicKeyHash(): Promise<string>;
+    /**
+     * Create a cryptobox server
+     *
+     * @param otherPublicKey
+     * @param selfKeypair
+     */
+    protected createCryptoBoxServer(otherPublicKey: string, selfKeypair: KeyPair): Promise<SessionKeys>;
+    /**
+     * Create a cryptobox client
+     *
+     * @param otherPublicKey
+     * @param selfKeypair
+     */
+    protected createCryptoBoxClient(otherPublicKey: string, selfKeypair: KeyPair): Promise<SessionKeys>;
+    /**
+     * Encrypt a message for a specific publicKey (receiver, asymmetric)
+     *
+     * @param recipientPublicKey
+     * @param message
+     */
+    protected encryptMessageAsymmetric(recipientPublicKey: string, message: string): Promise<string>;
+    abstract unsubscribeFromEncryptedMessages(): Promise<void>;
+    abstract unsubscribeFromEncryptedMessage(senderPublicKey: string): Promise<void>;
+    abstract sendMessage(message: string, peer?: PeerInfoType): Promise<void>;
+}

package/dist/cjs/src/transports/clients/CommunicationClient.js

@@ -0,0 +1,86 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommunicationClient = void 0;
+const octez_connect_utils_1 = require("@tezos-x/octez.connect-utils");
+const ed25519_1 = require("@stablelib/ed25519");
+const x25519_session_1 = require("@stablelib/x25519-session");
+/**
+ * @internalapi
+ *
+ *
+ */
+class CommunicationClient {
+    constructor(keyPair) {
+        this.keyPair = keyPair;
+        this.eventHandlers = new Map();
+        // todo move OS
+        this.isMobileOS = () => /(Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini|Mobile|Tablet|Windows Phone|SymbianOS|Kindle)/i.test(navigator.userAgent);
+    }
+    /**
+     * Get the public key
+     */
+    getPublicKey() {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            return (0, octez_connect_utils_1.toHex)((_a = this.keyPair) === null || _a === void 0 ? void 0 : _a.publicKey);
+        });
+    }
+    /**
+     * get the public key hash
+     */
+    getPublicKeyHash() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (0, octez_connect_utils_1.getHexHash)(this.keyPair.publicKey);
+        });
+    }
+    /**
+     * Create a cryptobox server
+     *
+     * @param otherPublicKey
+     * @param selfKeypair
+     */
+    createCryptoBoxServer(otherPublicKey, selfKeypair) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (0, x25519_session_1.serverSessionKeys)({
+                publicKey: (0, ed25519_1.convertPublicKeyToX25519)(selfKeypair.publicKey),
+                secretKey: (0, ed25519_1.convertSecretKeyToX25519)(selfKeypair.secretKey)
+            }, (0, ed25519_1.convertPublicKeyToX25519)(Buffer.from(otherPublicKey, 'hex')));
+        });
+    }
+    /**
+     * Create a cryptobox client
+     *
+     * @param otherPublicKey
+     * @param selfKeypair
+     */
+    createCryptoBoxClient(otherPublicKey, selfKeypair) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (0, x25519_session_1.clientSessionKeys)({
+                publicKey: (0, ed25519_1.convertPublicKeyToX25519)(selfKeypair.publicKey),
+                secretKey: (0, ed25519_1.convertSecretKeyToX25519)(selfKeypair.secretKey)
+            }, (0, ed25519_1.convertPublicKeyToX25519)(Buffer.from(otherPublicKey, 'hex')));
+        });
+    }
+    /**
+     * Encrypt a message for a specific publicKey (receiver, asymmetric)
+     *
+     * @param recipientPublicKey
+     * @param message
+     */
+    encryptMessageAsymmetric(recipientPublicKey, message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (0, octez_connect_utils_1.sealCryptobox)(message, Buffer.from(recipientPublicKey, 'hex'));
+        });
+    }
+}
+exports.CommunicationClient = CommunicationClient;
+//# sourceMappingURL=CommunicationClient.js.map

package/dist/cjs/src/transports/clients/CommunicationClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommunicationClient.js","sourceRoot":"","sources":["../../../../../src/transports/clients/CommunicationClient.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,sEAA+E;AAC/E,gDAAgG;AAChG,8DAA6F;AAE7F;;;;GAIG;AACH,MAAsB,mBAAmB;IACvC,YAAsB,OAAiB;QAAjB,YAAO,GAAP,OAAO,CAAU;QAEhC,kBAAa,GAAgC,IAAI,GAAG,EAAE,CAAA;QAE7D,eAAe;QACL,eAAU,GAAG,GAAY,EAAE,CACnC,+GAA+G,CAAC,IAAI,CAClH,SAAS,CAAC,SAAS,CACpB,CAAA;IARuC,CAAC;IAU3C;;OAEG;IACU,YAAY;;;YACvB,OAAO,IAAA,2BAAK,EAAC,MAAA,IAAI,CAAC,OAAO,0CAAE,SAAS,CAAC,CAAA;QACvC,CAAC;KAAA;IAED;;OAEG;IACU,gBAAgB;;YAC3B,OAAO,IAAA,gCAAU,EAAC,IAAI,CAAC,OAAQ,CAAC,SAAS,CAAC,CAAA;QAC5C,CAAC;KAAA;IAED;;;;;OAKG;IACa,qBAAqB,CACnC,cAAsB,EACtB,WAAoB;;YAEpB,OAAO,IAAA,kCAAiB,EACtB;gBACE,SAAS,EAAE,IAAA,kCAAwB,EAAC,WAAW,CAAC,SAAS,CAAC;gBAC1D,SAAS,EAAE,IAAA,kCAAwB,EAAC,WAAW,CAAC,SAAS,CAAC;aAC3D,EACD,IAAA,kCAAwB,EAAC,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC,CAC7D,CAAA;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACa,qBAAqB,CACnC,cAAsB,EACtB,WAAoB;;YAEpB,OAAO,IAAA,kCAAiB,EACtB;gBACE,SAAS,EAAE,IAAA,kCAAwB,EAAC,WAAW,CAAC,SAAS,CAAC;gBAC1D,SAAS,EAAE,IAAA,kCAAwB,EAAC,WAAW,CAAC,SAAS,CAAC;aAC3D,EACD,IAAA,kCAAwB,EAAC,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC,CAC7D,CAAA;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACa,wBAAwB,CACtC,kBAA0B,EAC1B,OAAe;;YAEf,OAAO,IAAA,mCAAa,EAAC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,kBAAkB,EAAE,KAAK,CAAC,CAAC,CAAA;QACvE,CAAC;KAAA;CAMF;AAhFD,kDAgFC"}

package/dist/cjs/src/transports/clients/MessageBasedClient.d.ts

@@ -0,0 +1,56 @@
+import { CommunicationClient } from './CommunicationClient';
+import { PostMessagePairingRequest, PostMessagePairingResponse } from '@tezos-x/octez.connect-types';
+import { KeyPair } from '@stablelib/ed25519';
+/**
+ * @internalapi
+ *
+ *
+ */
+export declare abstract class MessageBasedClient extends CommunicationClient {
+    protected readonly name: string;
+    /**
+     * The listeners that will be notified of new messages
+     */
+    protected abstract readonly activeListeners: Map<string, unknown>;
+    constructor(name: string, keyPair: KeyPair);
+    /**
+     * start the client and make sure all dependencies are ready
+     */
+    start(): Promise<void>;
+    /**
+     * Get the pairing request information. This will be shared with the peer during the connection setup
+     */
+    getPairingRequestInfo(): Promise<PostMessagePairingRequest>;
+    /**
+     * Get the pairing response information. This will be shared with the peer during the connection setup
+     */
+    getPairingResponseInfo(request: PostMessagePairingRequest): Promise<PostMessagePairingResponse>;
+    /**
+     * Unsubscribe from encrypted messages from a specific peer
+     *
+     * @param senderPublicKey
+     */
+    unsubscribeFromEncryptedMessage(senderPublicKey: string): Promise<void>;
+    /**
+     * Unsubscribe from all encrypted messages
+     */
+    unsubscribeFromEncryptedMessages(): Promise<void>;
+    /**
+     * Decrypt a message from a specific peer
+     *
+     * @param senderPublicKey
+     * @param payload
+     */
+    protected decryptMessage(senderPublicKey: string, payload: string): Promise<string>;
+    /**
+     * Encrypt a message for a specific publicKey (receiver)
+     *
+     * @param recipientPublicKey
+     * @param message
+     */
+    protected encryptMessage(recipientPublicKey: string, message: string): Promise<string>;
+    /**
+     * Initialize the connection
+     */
+    abstract init(): Promise<void>;
+}

package/dist/cjs/src/transports/clients/MessageBasedClient.js

@@ -0,0 +1,110 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessageBasedClient = void 0;
+const constants_1 = require("../../constants");
+const message_protocol_1 = require("../../message-protocol");
+const octez_connect_utils_1 = require("@tezos-x/octez.connect-utils");
+const CommunicationClient_1 = require("./CommunicationClient");
+const octez_connect_types_1 = require("@tezos-x/octez.connect-types");
+/**
+ * @internalapi
+ *
+ *
+ */
+class MessageBasedClient extends CommunicationClient_1.CommunicationClient {
+    constructor(name, keyPair) {
+        super(keyPair);
+        this.name = name;
+        this.init().catch(console.error);
+    }
+    /**
+     * start the client and make sure all dependencies are ready
+     */
+    start() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield Promise.resolve();
+        });
+    }
+    /**
+     * Get the pairing request information. This will be shared with the peer during the connection setup
+     */
+    getPairingRequestInfo() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new octez_connect_types_1.PostMessagePairingRequest(yield (0, octez_connect_utils_1.generateGUID)(), this.name, yield this.getPublicKey(), constants_1.BEACON_VERSION, (0, message_protocol_1.getPreferredMessageProtocolVersion)());
+        });
+    }
+    /**
+     * Get the pairing response information. This will be shared with the peer during the connection setup
+     */
+    getPairingResponseInfo(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new octez_connect_types_1.PostMessagePairingResponse(request.id, this.name, yield this.getPublicKey(), request.version, (0, message_protocol_1.getPreferredMessageProtocolVersion)());
+        });
+    }
+    /**
+     * Unsubscribe from encrypted messages from a specific peer
+     *
+     * @param senderPublicKey
+     */
+    unsubscribeFromEncryptedMessage(senderPublicKey) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const listener = this.activeListeners.get(senderPublicKey);
+            if (!listener) {
+                return;
+            }
+            this.activeListeners.delete(senderPublicKey);
+        });
+    }
+    /**
+     * Unsubscribe from all encrypted messages
+     */
+    unsubscribeFromEncryptedMessages() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.activeListeners.clear();
+        });
+    }
+    /**
+     * Decrypt a message from a specific peer
+     *
+     * @param senderPublicKey
+     * @param payload
+     */
+    decryptMessage(senderPublicKey, payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const sharedKey = yield this.createCryptoBoxServer(senderPublicKey, this.keyPair);
+            const hexPayload = Buffer.from(payload, 'hex');
+            if (hexPayload.length >= octez_connect_utils_1.secretbox_NONCEBYTES + octez_connect_utils_1.secretbox_MACBYTES) {
+                try {
+                    return yield (0, octez_connect_utils_1.decryptCryptoboxPayload)(hexPayload, sharedKey.receive);
+                }
+                catch (decryptionError) {
+                    /* NO-OP. We try to decode every message, but some might not be addressed to us. */
+                }
+            }
+            throw new Error('Could not decrypt message');
+        });
+    }
+    /**
+     * Encrypt a message for a specific publicKey (receiver)
+     *
+     * @param recipientPublicKey
+     * @param message
+     */
+    encryptMessage(recipientPublicKey, message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const sharedKey = yield this.createCryptoBoxClient(recipientPublicKey, this.keyPair);
+            return (0, octez_connect_utils_1.encryptCryptoboxPayload)(message, sharedKey.send);
+        });
+    }
+}
+exports.MessageBasedClient = MessageBasedClient;
+//# sourceMappingURL=MessageBasedClient.js.map

package/dist/cjs/src/transports/clients/MessageBasedClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MessageBasedClient.js","sourceRoot":"","sources":["../../../../../src/transports/clients/MessageBasedClient.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+CAAgD;AAChD,6DAA2E;AAC3E,sEAMqC;AACrC,+DAA2D;AAC3D,sEAAoG;AAGpG;;;;GAIG;AACH,MAAsB,kBAAmB,SAAQ,yCAAmB;IAMlE,YACqB,IAAY,EAC/B,OAAgB;QAEhB,KAAK,CAAC,OAAO,CAAC,CAAA;QAHK,SAAI,GAAJ,IAAI,CAAQ;QAI/B,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IAClC,CAAC;IAED;;OAEG;IACU,KAAK;;YAChB,MAAM,OAAO,CAAC,OAAO,EAAE,CAAA;QACzB,CAAC;KAAA;IAED;;OAEG;IACU,qBAAqB;;YAChC,OAAO,IAAI,+CAAyB,CAClC,MAAM,IAAA,kCAAY,GAAE,EACpB,IAAI,CAAC,IAAI,EACT,MAAM,IAAI,CAAC,YAAY,EAAE,EACzB,0BAAc,EACd,IAAA,qDAAkC,GAAE,CACrC,CAAA;QACH,CAAC;KAAA;IAED;;OAEG;IACU,sBAAsB,CACjC,OAAkC;;YAElC,OAAO,IAAI,gDAA0B,CACnC,OAAO,CAAC,EAAE,EACV,IAAI,CAAC,IAAI,EACT,MAAM,IAAI,CAAC,YAAY,EAAE,EACzB,OAAO,CAAC,OAAO,EACf,IAAA,qDAAkC,GAAE,CACrC,CAAA;QACH,CAAC;KAAA;IAED;;;;OAIG;IACU,+BAA+B,CAAC,eAAuB;;YAClE,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,eAAe,CAAC,CAAA;YAC1D,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,OAAM;YACR,CAAC;YAED,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,eAAe,CAAC,CAAA;QAC9C,CAAC;KAAA;IAED;;OAEG;IACU,gCAAgC;;YAC3C,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAA;QAC9B,CAAC;KAAA;IAED;;;;;OAKG;IACa,cAAc,CAAC,eAAuB,EAAE,OAAe;;YACrE,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,eAAe,EAAE,IAAI,CAAC,OAAQ,CAAC,CAAA;YAElF,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;YAE9C,IAAI,UAAU,CAAC,MAAM,IAAI,0CAAoB,GAAG,wCAAkB,EAAE,CAAC;gBACnE,IAAI,CAAC;oBACH,OAAO,MAAM,IAAA,6CAAuB,EAAC,UAAU,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;gBACrE,CAAC;gBAAC,OAAO,eAAe,EAAE,CAAC;oBACzB,mFAAmF;gBACrF,CAAC;YACH,CAAC;YAED,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAC9C,CAAC;KAAA;IAED;;;;;OAKG;IACa,cAAc,CAAC,kBAA0B,EAAE,OAAe;;YACxE,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,kBAAkB,EAAE,IAAI,CAAC,OAAQ,CAAC,CAAA;YAErF,OAAO,IAAA,6CAAuB,EAAC,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,CAAA;QACzD,CAAC;KAAA;CAMF;AA5GD,gDA4GC"}

package/dist/cjs/src/utils/Logger.d.ts

@@ -0,0 +1,33 @@
+export interface LoggerInterface {
+    debug(method: string, ...args: any[]): void;
+    log(method: string, ...args: any[]): void;
+    warn(method: string, ...args: any[]): void;
+    error(method: string, ...args: any[]): void;
+    time(start: boolean, label?: string): void;
+    timeLog(method: string, ...args: any[]): void;
+}
+/**
+ * The logger that is used internally
+ */
+export declare class InternalLogger implements LoggerInterface {
+    constructor();
+    debug(name: string, method: string, ...args: any[]): void;
+    log(name: string, method: string, ...args: any[]): void;
+    warn(name: string, method: string, ...args: any[]): void;
+    error(name: string, method: string, ...args: any[]): void;
+    time(start: boolean, label?: string | undefined): void;
+    timeLog(name: string, method: string, ...args: any[]): void;
+    private _log;
+}
+export declare class Logger implements LoggerInterface {
+    private readonly name;
+    constructor(service: string);
+    debug(method: string, ...args: any[]): void;
+    log(method: string, ...args: any[]): void;
+    warn(method: string, ...args: any[]): void;
+    error(method: string, ...args: any[]): void;
+    time(start: boolean, label?: string | undefined): void;
+    timeLog(method: string, ...args: any[]): void;
+}
+export declare const setLogger: (newLogger: LoggerInterface) => void;
+export declare const getLogger: () => LoggerInterface;

package/dist/cjs/src/utils/Logger.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLogger = exports.setLogger = exports.Logger = exports.InternalLogger = void 0;
+const debug_1 = require("../debug");
+/**
+ * The logger that is used internally
+ */
+class InternalLogger {
+    constructor() { }
+    debug(name, method, ...args) {
+        this._log('debug', name, method, args);
+    }
+    log(name, method, ...args) {
+        this._log('log', name, method, args);
+    }
+    warn(name, method, ...args) {
+        this._log('warn', name, method, args);
+    }
+    error(name, method, ...args) {
+        this._log('error', name, method, args);
+    }
+    time(start, label) {
+        start ? console.time(label) : console.timeEnd(label);
+    }
+    timeLog(name, method, ...args) {
+        this._log('timeLog', name, method, args);
+    }
+    _log(type, name, method, args = []) {
+        if (!(0, debug_1.getDebugEnabled)()) {
+            return;
+        }
+        let groupText = `[BEACON] ${new Date().toISOString()} [${name}](${method})`;
+        let data = args;
+        if (args[0] && typeof args[0] === 'string') {
+            groupText += ` ${args[0]}`;
+            data = args.slice(1);
+        }
+        switch (type) {
+            case 'error':
+                console.group(groupText);
+                console.error(...data);
+                break;
+            case 'warn':
+                console.group(groupText);
+                console.warn(...data);
+                break;
+            case 'debug':
+                console.groupCollapsed(groupText);
+                console.debug(...data);
+                break;
+            case 'timeLog':
+                console.group(groupText);
+                console.timeLog(...data);
+                break;
+            default:
+                console.group(groupText);
+                console.log(...data);
+        }
+        console.groupEnd();
+        // echo.group(echo.asWarning(`[BEACON] ${message}`))
+        // echo.log(echo.asWarning(`[${this.name}]`), echo.asAlert(`(${method})`), ...args)
+        // echo.groupEnd()
+    }
+}
+exports.InternalLogger = InternalLogger;
+class Logger {
+    constructor(service) {
+        this.name = service;
+    }
+    debug(method, ...args) {
+        logger.debug(this.name, method, args);
+    }
+    log(method, ...args) {
+        logger.log(this.name, method, args);
+    }
+    warn(method, ...args) {
+        logger.warn(this.name, method, args);
+    }
+    error(method, ...args) {
+        logger.error(this.name, method, args);
+    }
+    time(start, label) {
+        logger.time(start, label);
+    }
+    timeLog(method, ...args) {
+        logger.timeLog(method, args);
+    }
+}
+exports.Logger = Logger;
+const loggerWrapper = new Logger('');
+let logger = new InternalLogger();
+const setLogger = (newLogger) => {
+    logger = newLogger;
+};
+exports.setLogger = setLogger;
+const getLogger = () => loggerWrapper;
+exports.getLogger = getLogger;
+//# sourceMappingURL=Logger.js.map

package/dist/cjs/src/utils/Logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Logger.js","sourceRoot":"","sources":["../../../../src/utils/Logger.ts"],"names":[],"mappings":";;;AAAA,oCAA0C;AAW1C;;GAEG;AACH,MAAa,cAAc;IACzB,gBAAe,CAAC;IAEhB,KAAK,CAAC,IAAY,EAAE,MAAc,EAAE,GAAG,IAAW;QAChD,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;IACxC,CAAC;IAED,GAAG,CAAC,IAAY,EAAE,MAAc,EAAE,GAAG,IAAW;QAC9C,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;IACtC,CAAC;IAED,IAAI,CAAC,IAAY,EAAE,MAAc,EAAE,GAAG,IAAW;QAC/C,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;IACvC,CAAC;IAED,KAAK,CAAC,IAAY,EAAE,MAAc,EAAE,GAAG,IAAW;QAChD,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;IACxC,CAAC;IAED,IAAI,CAAC,KAAc,EAAE,KAA0B;QAC7C,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IACtD,CAAC;IAED,OAAO,CAAC,IAAY,EAAE,MAAc,EAAE,GAAG,IAAW;QAClD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;IAC1C,CAAC;IAEO,IAAI,CACV,IAAoD,EACpD,IAAY,EACZ,MAAc,EACd,OAAc,EAAE;QAEhB,IAAI,CAAC,IAAA,uBAAe,GAAE,EAAE,CAAC;YACvB,OAAM;QACR,CAAC;QAED,IAAI,SAAS,GAAG,YAAY,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,KAAK,IAAI,KAAK,MAAM,GAAG,CAAA;QAC3E,IAAI,IAAI,GAAG,IAAI,CAAA;QACf,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;YAC3C,SAAS,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAA;YAC1B,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QACtB,CAAC;QAED,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,OAAO;gBACV,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;gBACxB,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAA;gBACtB,MAAK;YACP,KAAK,MAAM;gBACT,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;gBACxB,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAA;gBACrB,MAAK;YACP,KAAK,OAAO;gBACV,OAAO,CAAC,cAAc,CAAC,SAAS,CAAC,CAAA;gBACjC,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAA;gBACtB,MAAK;YACP,KAAK,SAAS;gBACZ,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;gBACxB,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAA;gBACxB,MAAK;YACP;gBACE,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;gBACxB,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAA;QACxB,CAAC;QACD,OAAO,CAAC,QAAQ,EAAE,CAAA;QAElB,oDAAoD;QACpD,mFAAmF;QACnF,kBAAkB;IACpB,CAAC;CACF;AAvED,wCAuEC;AAED,MAAa,MAAM;IAGjB,YAAY,OAAe;QACzB,IAAI,CAAC,IAAI,GAAG,OAAO,CAAA;IACrB,CAAC;IAED,KAAK,CAAC,MAAc,EAAE,GAAG,IAAW;QAClC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;IACvC,CAAC;IAED,GAAG,CAAC,MAAc,EAAE,GAAG,IAAW;QAChC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;IACrC,CAAC;IAED,IAAI,CAAC,MAAc,EAAE,GAAG,IAAW;QACjC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;IACtC,CAAC;IAED,KAAK,CAAC,MAAc,EAAE,GAAG,IAAW;QAClC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;IACvC,CAAC;IAED,IAAI,CAAC,KAAc,EAAE,KAA0B;QAC7C,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;IAC3B,CAAC;IAED,OAAO,CAAC,MAAc,EAAE,GAAG,IAAW;QACpC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IAC9B,CAAC;CACF;AA9BD,wBA8BC;AAED,MAAM,aAAa,GAAoB,IAAI,MAAM,CAAC,EAAE,CAAC,CAAA;AACrD,IAAI,MAAM,GAAoB,IAAI,cAAc,EAAE,CAAA;AAE3C,MAAM,SAAS,GAAG,CAAC,SAA0B,EAAQ,EAAE;IAC5D,MAAM,GAAG,SAAS,CAAA;AACpB,CAAC,CAAA;AAFY,QAAA,SAAS,aAErB;AAEM,MAAM,SAAS,GAAG,GAAoB,EAAE,CAAC,aAAa,CAAA;AAAhD,QAAA,SAAS,aAAuC"}

package/dist/cjs/src/utils/assert-never.d.ts

@@ -0,0 +1,6 @@
+/**
+ * A helper function to make sure if/elses and switch/cases are exhaustive
+ *
+ * @param empty The data that has to be empty
+ */
+export declare function assertNever(empty: never): never;

package/dist/cjs/src/utils/assert-never.js

@@ -0,0 +1,14 @@
+"use strict";
+/* eslint-disable prefer-arrow/prefer-arrow-functions */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertNever = assertNever;
+/**
+ * A helper function to make sure if/elses and switch/cases are exhaustive
+ *
+ * @param empty The data that has to be empty
+ */
+function assertNever(empty) {
+    return empty;
+}
+/* eslint-enable prefer-arrow/prefer-arrow-functions */
+//# sourceMappingURL=assert-never.js.map