@tonconnect/sdk 3.0.2 → 3.0.3-beta.0

package/lib/esm/index.mjs

@@ -1,5 +1,5 @@
 import { CONNECT_EVENT_ERROR_CODES, SEND_TRANSACTION_ERROR_CODES, Base64, SessionCrypto, hexToByteArray } from '@tonconnect/protocol';
-export { CHAIN, CONNECT_ITEM_ERROR_CODES } from '@tonconnect/protocol';
+export { CHAIN, CONNECT_EVENT_ERROR_CODES, CONNECT_ITEM_ERROR_CODES, SEND_TRANSACTION_ERROR_CODES } from '@tonconnect/protocol';
 import '@tonconnect/isomorphic-eventsource';
 import '@tonconnect/isomorphic-fetch';
 
@@ -489,7 +489,10 @@ function createResource(createFn, disposeFn) {
             currentResource = null;
             const promise = currentPromise;
             currentPromise = null;
-            abortController === null || abortController === void 0 ? void 0 : abortController.abort();
+            try {
+                abortController === null || abortController === void 0 ? void 0 : abortController.abort();
+            }
+            catch (e) { }
             yield Promise.allSettled([
                 resource ? disposeFn(resource) : Promise.resolve(),
                 promise ? disposeFn(yield promise) : Promise.resolve()
@@ -1267,12 +1270,10 @@ class BridgeProvider {
         return __awaiter(this, void 0, void 0, function* () {
             if (Array.isArray(this.walletConnectionSource)) {
                 // close all gateways before opening new ones
-                this.pendingGateways.map(bridge => bridge.close().catch(e => console.error(e)));
+                this.pendingGateways.map(bridge => bridge.close().catch());
                 // open new gateways
                 this.pendingGateways = this.walletConnectionSource.map(source => {
-                    const gateway = new BridgeGateway(this.storage, source.bridgeUrl, sessionCrypto.sessionId, () => { }, e => {
-                        console.error(e);
-                    });
+                    const gateway = new BridgeGateway(this.storage, source.bridgeUrl, sessionCrypto.sessionId, () => { }, () => { });
                     gateway.setListener(message => this.pendingGatewaysListener(gateway, source.bridgeUrl, message));
                     return gateway;
                 });
@@ -2005,6 +2006,307 @@ function checkSendTransactionSupport(features, options) {
     logWarning("Connected wallet didn't provide information about max allowed messages in the SendTransaction request. Request may be rejected by the wallet.");
 }
 
+function createConnectionInfo(wallet) {
+    var _a, _b, _c, _d, _e, _f, _g, _h;
+    const isTonProof = ((_a = wallet === null || wallet === void 0 ? void 0 : wallet.connectItems) === null || _a === void 0 ? void 0 : _a.tonProof) && 'proof' in wallet.connectItems.tonProof;
+    const authType = isTonProof ? 'ton_proof' : 'ton_addr';
+    return {
+        wallet_address: (_c = (_b = wallet === null || wallet === void 0 ? void 0 : wallet.account) === null || _b === void 0 ? void 0 : _b.address) !== null && _c !== void 0 ? _c : null,
+        wallet_type: (_d = wallet === null || wallet === void 0 ? void 0 : wallet.device.appName) !== null && _d !== void 0 ? _d : null,
+        wallet_version: (_e = wallet === null || wallet === void 0 ? void 0 : wallet.device.appVersion) !== null && _e !== void 0 ? _e : null,
+        auth_type: authType,
+        custom_data: {
+            chain_id: (_g = (_f = wallet === null || wallet === void 0 ? void 0 : wallet.account) === null || _f === void 0 ? void 0 : _f.chain) !== null && _g !== void 0 ? _g : null,
+            provider: (_h = wallet === null || wallet === void 0 ? void 0 : wallet.provider) !== null && _h !== void 0 ? _h : null
+        }
+    };
+}
+/**
+ * Create a connection init event.
+ */
+function createConnectionStartedEvent() {
+    return {
+        type: 'connection-started'
+    };
+}
+/**
+ * Create a connection completed event.
+ * @param wallet
+ */
+function createConnectionCompletedEvent(wallet) {
+    return Object.assign({ type: 'connection-completed' }, createConnectionInfo(wallet));
+}
+/**
+ * Create a connection error event.
+ * @param error_message
+ * @param errorCode
+ */
+function createConnectionErrorEvent(error_message, errorCode) {
+    return {
+        type: 'connection-error',
+        error_message: error_message,
+        error_code: errorCode !== null && errorCode !== void 0 ? errorCode : null
+    };
+}
+/**
+ * Create a connection restoring started event.
+ */
+function createConnectionRestoringStartedEvent() {
+    return {
+        type: 'connection-restoring-started'
+    };
+}
+/**
+ * Create a connection restoring completed event.
+ * @param wallet
+ */
+function createConnectionRestoringCompletedEvent(wallet) {
+    return Object.assign({ type: 'connection-restoring-completed' }, createConnectionInfo(wallet));
+}
+/**
+ * Create a connection restoring error event.
+ * @param errorMessage
+ */
+function createConnectionRestoringErrorEvent(errorMessage) {
+    return {
+        type: 'connection-restoring-error',
+        error_message: errorMessage
+    };
+}
+function createTransactionInfo(wallet, transaction) {
+    var _a, _b, _c, _d;
+    return {
+        valid_until: (_a = String(transaction.validUntil)) !== null && _a !== void 0 ? _a : null,
+        from: (_d = (_b = transaction.from) !== null && _b !== void 0 ? _b : (_c = wallet === null || wallet === void 0 ? void 0 : wallet.account) === null || _c === void 0 ? void 0 : _c.address) !== null && _d !== void 0 ? _d : null,
+        messages: transaction.messages.map(message => {
+            var _a, _b;
+            return ({
+                address: (_a = message.address) !== null && _a !== void 0 ? _a : null,
+                amount: (_b = message.amount) !== null && _b !== void 0 ? _b : null
+            });
+        })
+    };
+}
+/**
+ * Create a transaction init event.
+ * @param wallet
+ * @param transaction
+ */
+function createTransactionSentForSignatureEvent(wallet, transaction) {
+    return Object.assign(Object.assign({ type: 'transaction-sent-for-signature' }, createConnectionInfo(wallet)), createTransactionInfo(wallet, transaction));
+}
+/**
+ * Create a transaction signed event.
+ * @param wallet
+ * @param transaction
+ * @param signedTransaction
+ */
+function createTransactionSignedEvent(wallet, transaction, signedTransaction) {
+    return Object.assign(Object.assign({ type: 'transaction-signed', signed_transaction: signedTransaction.boc }, createConnectionInfo(wallet)), createTransactionInfo(wallet, transaction));
+}
+/**
+ * Create a transaction error event.
+ * @param wallet
+ * @param transaction
+ * @param errorMessage
+ * @param errorCode
+ */
+function createTransactionSigningFailedEvent(wallet, transaction, errorMessage, errorCode) {
+    return Object.assign(Object.assign({ type: 'transaction-signing-failed', error_message: errorMessage, error_code: errorCode !== null && errorCode !== void 0 ? errorCode : null }, createConnectionInfo(wallet)), createTransactionInfo(wallet, transaction));
+}
+/**
+ * Create a disconnect event.
+ * @param wallet
+ * @param scope
+ * @returns
+ */
+function createDisconnectionEvent(wallet, scope) {
+    return Object.assign({ type: 'disconnection', scope: scope }, createConnectionInfo(wallet));
+}
+
+/**
+ * A concrete implementation of EventDispatcher that dispatches events to the browser window.
+ */
+class BrowserEventDispatcher {
+    constructor() {
+        /**
+         * The window object, possibly undefined in a server environment.
+         * @private
+         */
+        this.window = getWindow();
+    }
+    /**
+     * Dispatches an event with the given name and details to the browser window.
+     * @param eventName - The name of the event to dispatch.
+     * @param eventDetails - The details of the event to dispatch.
+     * @returns A promise that resolves when the event has been dispatched.
+     */
+    dispatchEvent(eventName, eventDetails) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const event = new CustomEvent(eventName, { detail: eventDetails });
+            (_a = this.window) === null || _a === void 0 ? void 0 : _a.dispatchEvent(event);
+        });
+    }
+}
+
+/**
+ * Tracker for TonConnect user actions, such as transaction signing, connection, etc.
+ *
+ * List of events:
+ *  * `connection-started`: when a user starts connecting a wallet.
+ *  * `connection-completed`: when a user successfully connected a wallet.
+ *  * `connection-error`: when a user cancels a connection or there is an error during the connection process.
+ *  * `connection-restoring-started`: when the dApp starts restoring a connection.
+ *  * `connection-restoring-completed`: when the dApp successfully restores a connection.
+ *  * `connection-restoring-error`: when the dApp fails to restore a connection.
+ *  * `disconnection`: when a user starts disconnecting a wallet.
+ *  * `transaction-sent-for-signature`: when a user sends a transaction for signature.
+ *  * `transaction-signed`: when a user successfully signs a transaction.
+ *  * `transaction-signing-failed`: when a user cancels transaction signing or there is an error during the signing process.
+ *
+ * If you want to track user actions, you can subscribe to the window events with prefix `ton-connect-`:
+ *
+ * @example
+ * window.addEventListener('ton-connect-transaction-sent-for-signature', (event) => {
+ *    console.log('Transaction init', event.detail);
+ * });
+ *
+ * @internal
+ */
+class TonConnectTracker {
+    constructor(eventDispatcher) {
+        /**
+         * Event prefix for user actions.
+         * @private
+         */
+        this.eventPrefix = 'ton-connect-';
+        this.eventDispatcher = eventDispatcher !== null && eventDispatcher !== void 0 ? eventDispatcher : new BrowserEventDispatcher();
+    }
+    /**
+     * Emit user action event to the window.
+     * @param eventDetails
+     * @private
+     */
+    dispatchUserActionEvent(eventDetails) {
+        try {
+            const eventName = `${this.eventPrefix}${eventDetails.type}`;
+            this.eventDispatcher.dispatchEvent(eventName, eventDetails).catch();
+        }
+        catch (e) { }
+    }
+    /**
+     * Track connection init event.
+     * @param args
+     */
+    trackConnectionStarted(...args) {
+        try {
+            const event = createConnectionStartedEvent(...args);
+            this.dispatchUserActionEvent(event);
+        }
+        catch (e) { }
+    }
+    /**
+     * Track connection success event.
+     * @param args
+     */
+    trackConnectionCompleted(...args) {
+        try {
+            const event = createConnectionCompletedEvent(...args);
+            this.dispatchUserActionEvent(event);
+        }
+        catch (e) { }
+    }
+    /**
+     * Track connection error event.
+     * @param args
+     */
+    trackConnectionError(...args) {
+        try {
+            const event = createConnectionErrorEvent(...args);
+            this.dispatchUserActionEvent(event);
+        }
+        catch (e) { }
+    }
+    /**
+     * Track connection restoring init event.
+     * @param args
+     */
+    trackConnectionRestoringStarted(...args) {
+        try {
+            const event = createConnectionRestoringStartedEvent(...args);
+            this.dispatchUserActionEvent(event);
+        }
+        catch (e) { }
+    }
+    /**
+     * Track connection restoring success event.
+     * @param args
+     */
+    trackConnectionRestoringCompleted(...args) {
+        try {
+            const event = createConnectionRestoringCompletedEvent(...args);
+            this.dispatchUserActionEvent(event);
+        }
+        catch (e) { }
+    }
+    /**
+     * Track connection restoring error event.
+     * @param args
+     */
+    trackConnectionRestoringError(...args) {
+        try {
+            const event = createConnectionRestoringErrorEvent(...args);
+            this.dispatchUserActionEvent(event);
+        }
+        catch (e) { }
+    }
+    /**
+     * Track disconnect event.
+     * @param args
+     */
+    trackDisconnection(...args) {
+        try {
+            const event = createDisconnectionEvent(...args);
+            this.dispatchUserActionEvent(event);
+        }
+        catch (e) { }
+    }
+    /**
+     * Track transaction init event.
+     * @param args
+     */
+    trackTransactionSentForSignature(...args) {
+        try {
+            const event = createTransactionSentForSignatureEvent(...args);
+            this.dispatchUserActionEvent(event);
+        }
+        catch (e) { }
+    }
+    /**
+     * Track transaction signed event.
+     * @param args
+     */
+    trackTransactionSigned(...args) {
+        try {
+            const event = createTransactionSignedEvent(...args);
+            this.dispatchUserActionEvent(event);
+        }
+        catch (e) { }
+    }
+    /**
+     * Track transaction error event.
+     * @param args
+     */
+    trackTransactionSigningFailed(...args) {
+        try {
+            const event = createTransactionSigningFailedEvent(...args);
+            this.dispatchUserActionEvent(event);
+        }
+        catch (e) { }
+    }
+}
+
 class TonConnect {
     constructor(options) {
         this.walletsList = new WalletsListManager();
@@ -2020,6 +2322,7 @@ class TonConnect {
             walletsListSource: options === null || options === void 0 ? void 0 : options.walletsListSource,
             cacheTTLMs: options === null || options === void 0 ? void 0 : options.walletsListCacheTTLMs
         });
+        this.tracker = new TonConnectTracker(options === null || options === void 0 ? void 0 : options.eventDispatcher);
         if (!this.dappSettings.manifestUrl) {
             throw new DappMetadataError('Dapp tonconnect-manifest.json must be specified if window.location.origin is undefined. See more https://github.com/ton-connect/docs/blob/main/requests-responses.md#app-manifest');
         }
@@ -2112,6 +2415,7 @@ class TonConnect {
             (_a = this.provider) === null || _a === void 0 ? void 0 : _a.closeConnection();
             this.provider = null;
         });
+        this.tracker.trackConnectionStarted();
         return this.provider.connect(this.createConnectRequest(options === null || options === void 0 ? void 0 : options.request), {
             openingDeadlineMS: options === null || options === void 0 ? void 0 : options.openingDeadlineMS,
             signal: abortController.signal
@@ -2123,10 +2427,12 @@ class TonConnect {
     restoreConnection(options) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            this.tracker.trackConnectionRestoringStarted();
             const abortController = createAbortController(options === null || options === void 0 ? void 0 : options.signal);
             (_a = this.abortController) === null || _a === void 0 ? void 0 : _a.abort();
             this.abortController = abortController;
             if (abortController.signal.aborted) {
+                this.tracker.trackConnectionRestoringError('Connection restoring was aborted');
                 return;
             }
             // TODO: potentially race condition here
@@ -2135,6 +2441,7 @@ class TonConnect {
                 this.walletsList.getEmbeddedWallet()
             ]);
             if (abortController.signal.aborted) {
+                this.tracker.trackConnectionRestoringError('Connection restoring was aborted');
                 return;
             }
             let provider = null;
@@ -2156,6 +2463,7 @@ class TonConnect {
                 }
             }
             catch (_c) {
+                this.tracker.trackConnectionRestoringError('Provider is not restored');
                 yield this.bridgeConnectionStorage.removeConnection();
                 provider === null || provider === void 0 ? void 0 : provider.closeConnection();
                 provider = null;
@@ -2163,24 +2471,35 @@ class TonConnect {
             }
             if (abortController.signal.aborted) {
                 provider === null || provider === void 0 ? void 0 : provider.closeConnection();
+                this.tracker.trackConnectionRestoringError('Connection restoring was aborted');
                 return;
             }
             if (!provider) {
                 logError('Provider is not restored');
+                this.tracker.trackConnectionRestoringError('Provider is not restored');
                 return;
             }
             (_b = this.provider) === null || _b === void 0 ? void 0 : _b.closeConnection();
             this.provider = provider;
             provider.listen(this.walletEventsListener.bind(this));
-            abortController.signal.addEventListener('abort', () => {
+            const onAbortRestore = () => {
+                this.tracker.trackConnectionRestoringError('Connection restoring was aborted');
                 provider === null || provider === void 0 ? void 0 : provider.closeConnection();
                 provider = null;
-            });
+            };
+            abortController.signal.addEventListener('abort', onAbortRestore);
             return yield callForSuccess((_options) => __awaiter(this, void 0, void 0, function* () {
-                return provider === null || provider === void 0 ? void 0 : provider.restoreConnection({
+                yield (provider === null || provider === void 0 ? void 0 : provider.restoreConnection({
                     openingDeadlineMS: options === null || options === void 0 ? void 0 : options.openingDeadlineMS,
                     signal: _options.signal
-                });
+                }));
+                abortController.signal.removeEventListener('abort', onAbortRestore);
+                if (this.connected) {
+                    this.tracker.trackConnectionRestoringCompleted(this.wallet);
+                }
+                else {
+                    this.tracker.trackConnectionRestoringError('Connection restoring failed');
+                }
             }), {
                 attempts: Number.MAX_SAFE_INTEGER,
                 delayMs: 5000,
@@ -2207,15 +2526,19 @@ class TonConnect {
             checkSendTransactionSupport(this.wallet.device.features, {
                 requiredMessagesNumber: transaction.messages.length
             });
+            this.tracker.trackTransactionSentForSignature(this.wallet, transaction);
             const { validUntil } = transaction, tx = __rest(transaction, ["validUntil"]);
             const from = transaction.from || this.account.address;
             const network = transaction.network || this.account.chain;
             const response = yield this.provider.sendRequest(sendTransactionParser.convertToRpcRequest(Object.assign(Object.assign({}, tx), { valid_until: validUntil, from,
                 network })), { onRequestSent: options.onRequestSent, signal: abortController.signal });
             if (sendTransactionParser.isError(response)) {
+                this.tracker.trackTransactionSigningFailed(this.wallet, transaction, response.error.message, response.error.code);
                 return sendTransactionParser.parseAndThrowError(response);
             }
-            return sendTransactionParser.convertFromRpcResponse(response);
+            const result = sendTransactionParser.convertFromRpcResponse(response);
+            this.tracker.trackTransactionSigned(this.wallet, transaction, result);
+            return result;
         });
     }
     /**
@@ -2233,7 +2556,7 @@ class TonConnect {
             if (abortController.signal.aborted) {
                 throw new TonConnectError('Disconnect was aborted');
             }
-            this.onWalletDisconnected();
+            this.onWalletDisconnected('dapp');
             yield ((_a = this.provider) === null || _a === void 0 ? void 0 : _a.disconnect({
                 signal: abortController.signal
             }));
@@ -2300,7 +2623,7 @@ class TonConnect {
                 this.onWalletConnectError(e.payload);
                 break;
             case 'disconnect':
-                this.onWalletDisconnected();
+                this.onWalletDisconnected('wallet');
         }
     }
     onWalletConnected(connectEvent) {
@@ -2325,17 +2648,20 @@ class TonConnect {
             };
         }
         this.wallet = wallet;
+        this.tracker.trackConnectionCompleted(wallet);
     }
     onWalletConnectError(connectEventError) {
         const error = connectErrorsParser.parseError(connectEventError);
         this.statusChangeErrorSubscriptions.forEach(errorsHandler => errorsHandler(error));
         console.debug(error);
+        this.tracker.trackConnectionError(connectEventError.message, connectEventError.code);
         if (error instanceof ManifestNotFoundError || error instanceof ManifestContentErrorError) {
             console.error(error);
             throw error;
         }
     }
-    onWalletDisconnected() {
+    onWalletDisconnected(scope) {
+        this.tracker.trackDisconnection(this.wallet, scope);
         this.wallet = null;
     }
     checkConnection() {
@@ -2465,5 +2791,5 @@ function hexToBytes(hex) {
     return result;
 }
 
-export { BadRequestError, FetchWalletsError, LocalstorageNotFoundError, ParseHexError, TonConnect, TonConnectError, UnknownAppError, UnknownError, UserRejectsError, WalletAlreadyConnectedError, WalletNotConnectedError, WalletNotInjectedError, WalletsListManager, WrongAddressError, TonConnect as default, encodeTelegramUrlParameters, isTelegramUrl, isWalletInfoCurrentlyEmbedded, isWalletInfoCurrentlyInjected, isWalletInfoInjectable, isWalletInfoInjected, isWalletInfoRemote, toUserFriendlyAddress };
+export { BadRequestError, BrowserEventDispatcher, FetchWalletsError, LocalstorageNotFoundError, ParseHexError, TonConnect, TonConnectError, UnknownAppError, UnknownError, UserRejectsError, WalletAlreadyConnectedError, WalletNotConnectedError, WalletNotInjectedError, WalletsListManager, WrongAddressError, createConnectionCompletedEvent, createConnectionErrorEvent, createConnectionRestoringCompletedEvent, createConnectionRestoringErrorEvent, createConnectionRestoringStartedEvent, createConnectionStartedEvent, createDisconnectionEvent, createTransactionSentForSignatureEvent, createTransactionSignedEvent, createTransactionSigningFailedEvent, TonConnect as default, encodeTelegramUrlParameters, isTelegramUrl, isWalletInfoCurrentlyEmbedded, isWalletInfoCurrentlyInjected, isWalletInfoInjectable, isWalletInfoInjected, isWalletInfoRemote, toUserFriendlyAddress };
 //# sourceMappingURL=index.mjs.map