@tezos-x/octez.connect-core 0.9.0

package/LICENCE

@@ -0,0 +1,19 @@
+Copyright (c) 2021 Papers AG
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
+OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,9 @@
+# `@tezos-x/octez.connect-core`
+
+This package is part of the `@tezos-x/octez.connect-sdk` project. [Read more](https://github.com/trilitech/octez.connect-sdk)
+
+## Introduction
+
+This package contains internal methods that are used by both the dApp and wallet client.
+
+Unless you need to import types from this package, you probably don't need to add it to your project.

package/dist/cjs/MockAnalytics.d.ts

@@ -0,0 +1,4 @@
+import { AnalyticsInterface } from '@tezos-x/octez.connect-types';
+export declare class MockAnalytics implements AnalyticsInterface {
+    track(_trigger: 'click' | 'event', _section: string, _label: string, _data?: Record<string, any>): void;
+}

package/dist/cjs/MockAnalytics.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MockAnalytics = void 0;
+class MockAnalytics {
+    track(_trigger, _section, _label, _data) {
+        // console.log('##### TRACK', trigger, section, label, data)
+        // noop
+    }
+}
+exports.MockAnalytics = MockAnalytics;
+//# sourceMappingURL=MockAnalytics.js.map

package/dist/cjs/MockAnalytics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MockAnalytics.js","sourceRoot":"","sources":["../../src/MockAnalytics.ts"],"names":[],"mappings":";;;AAEA,MAAa,aAAa;IACxB,KAAK,CACH,QAA2B,EAC3B,QAAgB,EAChB,MAAc,EACd,KAA2B;QAE3B,4DAA4D;QAC5D,OAAO;IACT,CAAC;CACF;AAVD,sCAUC"}

package/dist/cjs/MockWindow.d.ts

@@ -0,0 +1,14 @@
+type Callback = (message: unknown) => void;
+/**
+ * A mock for postmessage if run in node.js environment
+ */
+declare let windowRef: {
+    postMessage: (message: string | Record<string, unknown>, _target?: string) => void;
+    addEventListener: (_name: string, eventCallback: Callback) => void;
+    removeEventListener: (_name: string, eventCallback: Callback) => void;
+    location: {
+        origin: string;
+    };
+};
+declare const clearMockWindowState: () => void;
+export { windowRef, clearMockWindowState };

package/dist/cjs/MockWindow.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearMockWindowState = exports.windowRef = void 0;
+const cbs = [(_) => undefined];
+/**
+ * A mock for postmessage if run in node.js environment
+ */
+let windowRef = {
+    postMessage: (message, _target) => {
+        console.log('GOT MOCK POST MESSAGE', message);
+        cbs.forEach((callbackElement) => {
+            callbackElement({ data: message });
+        });
+    },
+    addEventListener: (_name, eventCallback) => {
+        cbs.push(eventCallback);
+    },
+    removeEventListener: (_name, eventCallback) => {
+        cbs.splice(cbs.indexOf((element) => element === eventCallback), 1);
+    },
+    location: {
+        origin: '*'
+    }
+};
+exports.windowRef = windowRef;
+try {
+    if (typeof window !== 'undefined') {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        exports.windowRef = windowRef = window;
+    }
+}
+catch (windowError) {
+    console.log(`not defined: ${windowError}`);
+}
+const clearMockWindowState = () => {
+    cbs.length = 0;
+};
+exports.clearMockWindowState = clearMockWindowState;
+//# sourceMappingURL=MockWindow.js.map

package/dist/cjs/MockWindow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MockWindow.js","sourceRoot":"","sources":["../../src/MockWindow.ts"],"names":[],"mappings":";;;AAEA,MAAM,GAAG,GAAe,CAAC,CAAC,CAAU,EAAQ,EAAE,CAAC,SAAS,CAAC,CAAA;AAEzD;;GAEG;AACH,IAAI,SAAS,GAAG;IACd,WAAW,EAAE,CAAC,OAAyC,EAAE,OAAgB,EAAQ,EAAE;QACjF,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAA;QAC7C,GAAG,CAAC,OAAO,CAAC,CAAC,eAAyB,EAAE,EAAE;YACxC,eAAe,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAA;QACpC,CAAC,CAAC,CAAA;IACJ,CAAC;IACD,gBAAgB,EAAE,CAAC,KAAa,EAAE,aAAuB,EAAQ,EAAE;QACjE,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;IACzB,CAAC;IACD,mBAAmB,EAAE,CAAC,KAAa,EAAE,aAAuB,EAAQ,EAAE;QACpE,GAAG,CAAC,MAAM,CACR,GAAG,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,KAAK,aAAa,CAAC,EACnD,CAAC,CACF,CAAA;IACH,CAAC;IACD,QAAQ,EAAE;QACR,MAAM,EAAE,GAAG;KACZ;CACF,CAAA;AAeQ,8BAAS;AAblB,IAAI,CAAC;IACH,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;QAClC,8DAA8D;QAC9D,oBAAA,SAAS,GAAG,MAAa,CAAA;IAC3B,CAAC;AACH,CAAC;AAAC,OAAO,WAAW,EAAE,CAAC;IACrB,OAAO,CAAC,GAAG,CAAC,gBAAgB,WAAW,EAAE,CAAC,CAAA;AAC5C,CAAC;AAED,MAAM,oBAAoB,GAAe,GAAS,EAAE;IAClD,GAAG,CAAC,MAAM,GAAG,CAAC,CAAA;AAChB,CAAC,CAAA;AAEmB,oDAAoB"}

package/dist/cjs/Serializer.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @internalapi
+ *
+ * The Serializer is used to serialize / deserialize JSON objects and encode them with bs58check
+ */
+export declare class Serializer {
+    /**
+     * Serialize and bs58check encode an object
+     *
+     * @param message JSON object to serialize
+     */
+    serialize(message: unknown): Promise<string>;
+    /**
+     * Deserialize a bs58check encoded string
+     *
+     * @param encoded String to be deserialized
+     */
+    deserialize(encoded: string): Promise<unknown>;
+}

package/dist/cjs/Serializer.js

@@ -0,0 +1,48 @@
+"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.Serializer = void 0;
+const bs58check_1 = require("bs58check");
+/**
+ * @internalapi
+ *
+ * The Serializer is used to serialize / deserialize JSON objects and encode them with bs58check
+ */
+class Serializer {
+    /**
+     * Serialize and bs58check encode an object
+     *
+     * @param message JSON object to serialize
+     */
+    serialize(message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const str = JSON.stringify(message);
+            return bs58check_1.default.encode(Buffer.from(str));
+        });
+    }
+    /**
+     * Deserialize a bs58check encoded string
+     *
+     * @param encoded String to be deserialized
+     */
+    deserialize(encoded) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (typeof encoded !== 'string') {
+                throw new Error('Encoded payload needs to be a string');
+            }
+            const decodedBytes = bs58check_1.default.decode(encoded);
+            const jsonString = Buffer.from(decodedBytes).toString('utf8');
+            return JSON.parse(jsonString);
+        });
+    }
+}
+exports.Serializer = Serializer;
+//# sourceMappingURL=Serializer.js.map

package/dist/cjs/Serializer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Serializer.js","sourceRoot":"","sources":["../../src/Serializer.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yCAAiC;AAEjC;;;;GAIG;AACH,MAAa,UAAU;IACrB;;;;OAIG;IACU,SAAS,CAAC,OAAgB;;YACrC,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;YAEnC,OAAO,mBAAS,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;QAC3C,CAAC;KAAA;IAED;;;;OAIG;IACU,WAAW,CAAC,OAAe;;YACtC,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;gBAChC,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAA;YACzD,CAAC;YAED,MAAM,YAAY,GAAG,mBAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;YAC9C,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;YAC7D,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;QAC/B,CAAC;KAAA;CACF;AA1BD,gCA0BC"}

package/dist/cjs/clients/beacon-client/BeaconClient.d.ts

@@ -0,0 +1,53 @@
+import { ExposedPromise } from '@tezos-x/octez.connect-utils';
+import { AnalyticsInterface, Storage } from '@tezos-x/octez.connect-types';
+import { BeaconClientOptions } from './BeaconClientOptions';
+import { KeyPair } from '@stablelib/ed25519';
+/**
+ * @internalapi
+ *
+ * The beacon client is an abstract client that handles everything that is shared between all other clients.
+ * Specifically, it handles managing the beaconId and and the local keypair.
+ */
+export declare abstract class BeaconClient {
+    /**
+     * The name of the client
+     */
+    readonly name: string;
+    /**
+     * The URL of the dApp Icon. This can be used to display the icon of the dApp on in the wallet
+     */
+    readonly iconUrl?: string;
+    /**
+     * The URL of the dApp.
+     */
+    readonly appUrl?: string;
+    /** The beaconId is a public key that is used to identify one specific application (dapp or wallet).
+     * This is used inside a message to specify the sender, for example.
+     */
+    protected _beaconId: ExposedPromise<string>;
+    get beaconId(): Promise<string>;
+    protected storage: Storage;
+    protected analytics: AnalyticsInterface;
+    /**
+     * The local keypair that is used for the communication encryption
+     */
+    protected _keyPair: ExposedPromise<KeyPair>;
+    protected get keyPair(): Promise<KeyPair>;
+    constructor(config: BeaconClientOptions);
+    /**
+     * This resets the SDK. After using this method, this instance is no longer usable. You will have to instanciate a new client.
+     */
+    destroy(): Promise<void>;
+    /**
+     * This method initializes the SDK by setting some values in the storage and generating a keypair.
+     */
+    protected initSDK(): Promise<void>;
+    /**
+     * Removes all beacon values from the storage.
+     */
+    private removeBeaconEntriesFromStorage;
+    /**
+     * This method tries to load the seed from storage, if it doesn't exist, a new one will be created and persisted.
+     */
+    private loadOrCreateBeaconSecret;
+}

package/dist/cjs/clients/beacon-client/BeaconClient.js

@@ -0,0 +1,111 @@
+"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.BeaconClient = void 0;
+const octez_connect_utils_1 = require("@tezos-x/octez.connect-utils");
+const octez_connect_utils_2 = require("@tezos-x/octez.connect-utils");
+const octez_connect_types_1 = require("@tezos-x/octez.connect-types");
+const constants_1 = require("../../constants");
+const MockWindow_1 = require("../../MockWindow");
+const MockAnalytics_1 = require("../../MockAnalytics");
+/**
+ * @internalapi
+ *
+ * The beacon client is an abstract client that handles everything that is shared between all other clients.
+ * Specifically, it handles managing the beaconId and and the local keypair.
+ */
+class BeaconClient {
+    get beaconId() {
+        return this._beaconId.promise;
+    }
+    get keyPair() {
+        return this._keyPair.promise;
+    }
+    constructor(config) {
+        var _a, _b;
+        /** The beaconId is a public key that is used to identify one specific application (dapp or wallet).
+         * This is used inside a message to specify the sender, for example.
+         */
+        this._beaconId = new octez_connect_utils_1.ExposedPromise();
+        /**
+         * The local keypair that is used for the communication encryption
+         */
+        this._keyPair = new octez_connect_utils_1.ExposedPromise();
+        if (!config.name) {
+            throw new Error('Name not set');
+        }
+        if (!config.storage) {
+            throw new Error('Storage not set');
+        }
+        this.name = config.name;
+        this.iconUrl = config.iconUrl;
+        this.appUrl = (_a = config.appUrl) !== null && _a !== void 0 ? _a : MockWindow_1.windowRef.location.origin;
+        this.storage = config.storage;
+        this.analytics = (_b = config.analytics) !== null && _b !== void 0 ? _b : new MockAnalytics_1.MockAnalytics();
+        // TODO: This is a temporary "workaround" to prevent users from creating multiple Client instances
+        if (MockWindow_1.windowRef.beaconCreatedClientInstance) {
+            console.error('[OCTEZ.CONNECT] It looks like you created multiple octez.connect SDK Client instances. This can lead to problems. Only create one instance and re-use it everywhere.');
+        }
+        else {
+            ;
+            MockWindow_1.windowRef.beaconCreatedClientInstance = true;
+        }
+        this.initSDK().catch(console.error);
+    }
+    /**
+     * This resets the SDK. After using this method, this instance is no longer usable. You will have to instanciate a new client.
+     */
+    destroy() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.removeBeaconEntriesFromStorage();
+            MockWindow_1.windowRef.beaconCreatedClientInstance = false;
+        });
+    }
+    /**
+     * This method initializes the SDK by setting some values in the storage and generating a keypair.
+     */
+    initSDK() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.storage.set(octez_connect_types_1.StorageKey.BEACON_SDK_VERSION, constants_1.SDK_VERSION).catch(console.error);
+            this.loadOrCreateBeaconSecret().catch(console.error);
+            return this.keyPair.then((keyPair) => {
+                this._beaconId.resolve((0, octez_connect_utils_2.toHex)(keyPair.publicKey));
+            });
+        });
+    }
+    /**
+     * Removes all beacon values from the storage.
+     */
+    removeBeaconEntriesFromStorage() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const allKeys = Object.values(octez_connect_types_1.StorageKey);
+            yield Promise.all(allKeys.map((key) => this.storage.delete(key)));
+        });
+    }
+    /**
+     * This method tries to load the seed from storage, if it doesn't exist, a new one will be created and persisted.
+     */
+    loadOrCreateBeaconSecret() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const storageValue = yield this.storage.get(octez_connect_types_1.StorageKey.BEACON_SDK_SECRET_SEED);
+            if (storageValue && typeof storageValue === 'string') {
+                this._keyPair.resolve(yield (0, octez_connect_utils_2.getKeypairFromSeed)(storageValue));
+            }
+            else {
+                const key = yield (0, octez_connect_utils_2.generateGUID)();
+                yield this.storage.set(octez_connect_types_1.StorageKey.BEACON_SDK_SECRET_SEED, key);
+                this._keyPair.resolve(yield (0, octez_connect_utils_2.getKeypairFromSeed)(key));
+            }
+        });
+    }
+}
+exports.BeaconClient = BeaconClient;
+//# sourceMappingURL=BeaconClient.js.map

package/dist/cjs/clients/beacon-client/BeaconClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BeaconClient.js","sourceRoot":"","sources":["../../../../src/clients/beacon-client/BeaconClient.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,sEAA6D;AAC7D,sEAAsF;AACtF,sEAAsF;AACtF,+CAA6C;AAC7C,iDAA4C;AAG5C,uDAAmD;AAEnD;;;;;GAKG;AACH,MAAsB,YAAY;IAoBhC,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAA;IAC/B,CAAC;IAUD,IAAc,OAAO;QACnB,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAA;IAC9B,CAAC;IAED,YAAY,MAA2B;;QApBvC;;WAEG;QACO,cAAS,GAA2B,IAAI,oCAAc,EAAE,CAAA;QASlE;;WAEG;QACO,aAAQ,GAA4B,IAAI,oCAAc,EAAE,CAAA;QAMhE,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,CAAA;QACjC,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAA;QACpC,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAA;QACvB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAA;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAA,MAAM,CAAC,MAAM,mCAAI,sBAAS,CAAC,QAAQ,CAAC,MAAM,CAAA;QACxD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAA;QAC7B,IAAI,CAAC,SAAS,GAAG,MAAA,MAAM,CAAC,SAAS,mCAAI,IAAI,6BAAa,EAAE,CAAA;QAExD,kGAAkG;QAClG,IAAK,sBAAiB,CAAC,2BAA2B,EAAE,CAAC;YACnD,OAAO,CAAC,KAAK,CACX,sKAAsK,CACvK,CAAA;QACH,CAAC;aAAM,CAAC;YACN,CAAC;YAAC,sBAAiB,CAAC,2BAA2B,GAAG,IAAI,CAAA;QACxD,CAAC;QAED,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IACrC,CAAC;IAED;;OAEG;IACU,OAAO;;YAClB,MAAM,IAAI,CAAC,8BAA8B,EAAE,CAC1C;YAAC,sBAAiB,CAAC,2BAA2B,GAAG,KAAK,CAAA;QACzD,CAAC;KAAA;IAED;;OAEG;IACa,OAAO;;YACrB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gCAAU,CAAC,kBAAkB,EAAE,uBAAW,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;YAEjF,IAAI,CAAC,wBAAwB,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;YAEpD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;gBACnC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAA,2BAAK,EAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAA;YAClD,CAAC,CAAC,CAAA;QACJ,CAAC;KAAA;IAED;;OAEG;IACW,8BAA8B;;YAC1C,MAAM,OAAO,GAAiB,MAAM,CAAC,MAAM,CAAC,gCAAU,CAAC,CAAA;YACvD,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;QACnE,CAAC;KAAA;IAED;;OAEG;IACW,wBAAwB;;YACpC,MAAM,YAAY,GAAY,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gCAAU,CAAC,sBAAsB,CAAC,CAAA;YACvF,IAAI,YAAY,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;gBACrD,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,IAAA,wCAAkB,EAAC,YAAY,CAAC,CAAC,CAAA;YAC/D,CAAC;iBAAM,CAAC;gBACN,MAAM,GAAG,GAAG,MAAM,IAAA,kCAAY,GAAE,CAAA;gBAChC,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gCAAU,CAAC,sBAAsB,EAAE,GAAG,CAAC,CAAA;gBAC9D,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,IAAA,wCAAkB,EAAC,GAAG,CAAC,CAAC,CAAA;YACtD,CAAC;QACH,CAAC;KAAA;CACF;AAvGD,oCAuGC"}

package/dist/cjs/clients/beacon-client/BeaconClientOptions.d.ts

@@ -0,0 +1,26 @@
+import { AnalyticsInterface, Storage } from '@tezos-x/octez.connect-types';
+/**
+ * @internalapi
+ */
+export interface BeaconClientOptions {
+    /**
+     * Name of the application
+     */
+    name: string;
+    /**
+     * A URL to the icon of the application
+     */
+    iconUrl?: string;
+    /**
+     * A URL to the website of the application
+     */
+    appUrl?: string;
+    /**
+     * The storage that will be used by the SDK
+     */
+    storage: Storage;
+    /**
+     * The analytics instance that will be used by the SDK
+     */
+    analytics?: AnalyticsInterface;
+}

package/dist/cjs/clients/beacon-client/BeaconClientOptions.js

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

package/dist/cjs/clients/beacon-client/BeaconClientOptions.js.map

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

package/dist/cjs/clients/client/Client.d.ts

@@ -0,0 +1,91 @@
+import { ExposedPromise } from '@tezos-x/octez.connect-utils';
+import { ConnectionContext, TransportType, TransportStatus, BeaconBaseMessage, AccountInfo, PeerInfo, AppMetadata, BeaconRequestMessage, BeaconMessageWrapper, NodeDistributions } from '@tezos-x/octez.connect-types';
+import { BeaconClient } from '../beacon-client/BeaconClient';
+import { AccountManager } from '../../managers/AccountManager';
+import { ClientOptions } from './ClientOptions';
+import { Transport } from '../../transports/Transport';
+/**
+ * @internalapi
+ *
+ * This abstract class handles the a big part of the logic that is shared between the dapp and wallet client.
+ * For example, it selects and manages the transport and accounts.
+ */
+export declare abstract class Client extends BeaconClient {
+    protected readonly accountManager: AccountManager;
+    protected handleResponse: (_event: BeaconRequestMessage | BeaconMessageWrapper<BeaconBaseMessage>, connectionInfo: ConnectionContext) => void;
+    /**
+     * How many requests can be sent after another
+     */
+    protected readonly rateLimit: number;
+    /**
+     * The time window in seconds in which the "rateLimit" is checked
+     */
+    protected readonly rateLimitWindowInSeconds: number;
+    /**
+     * Stores the times when requests have been made to determine if the rate limit has been reached
+     */
+    protected requestCounter: number[];
+    protected readonly matrixNodes: NodeDistributions;
+    private transportListeners;
+    protected _transport: ExposedPromise<Transport<any>>;
+    protected get transport(): Promise<Transport<any>>;
+    /**
+     * Returns the connection status of the Client
+     */
+    get connectionStatus(): TransportStatus;
+    /**
+     * Returns whether or not the transaport is ready
+     */
+    get ready(): Promise<void>;
+    constructor(config: ClientOptions);
+    protected cleanup(): Promise<void>;
+    /**
+     * Return all locally known accounts
+     */
+    getAccounts(): Promise<AccountInfo[]>;
+    /**
+     * Return the account by ID
+     * @param accountIdentifier The ID of an account
+     */
+    getAccount(accountIdentifier: string): Promise<AccountInfo | undefined>;
+    /**
+     * Remove the account by ID
+     * @param accountIdentifier The ID of an account
+     */
+    removeAccount(accountIdentifier: string): Promise<void>;
+    /**
+     * Remove all locally stored accounts
+     */
+    removeAllAccounts(): Promise<void>;
+    /**
+     * Add a new request (current timestamp) to the pending requests, remove old ones and check if we are above the limit
+     */
+    addRequestAndCheckIfRateLimited(): Promise<boolean>;
+    /**
+     * This method initializes the client. It will check if the connection should be established to a
+     * browser extension or if the P2P transport should be used.
+     *
+     * @param transport A transport that can be provided by the user
+     */
+    init(transport: Transport<any>): Promise<TransportType>;
+    /**
+     * Returns the metadata of this DApp
+     */
+    getOwnAppMetadata(): Promise<AppMetadata>;
+    /**
+     * Return all known peers
+     */
+    getPeers(): Promise<PeerInfo[]>;
+    /**
+     * Add a new peer to the known peers
+     * @param peer The new peer to add
+     */
+    addPeer(peer: PeerInfo): Promise<void>;
+    destroy(): Promise<void>;
+    /**
+     * A "setter" for when the transport needs to be changed.
+     */
+    protected setTransport(transport?: Transport<any>): Promise<void>;
+    protected addListener(transport: Transport<any>): Promise<void>;
+    protected sendDisconnectToPeer(peer: PeerInfo, transport?: Transport<any>): Promise<void>;
+}