@relayprotocol/relay-ton-wallet-adapter 2.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Reservoir
+
+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,47 @@
+<h3 align="center">Relay TON Wallet Adapter</h3>
+
+### Installation
+
+```
+yarn add @relayprotocol/relay-ton-wallet-adapter @relayprotocol/relay-sdk
+```
+
+Also make sure to install the peer dependencies required by the adapter if your application doesn't already include them:
+
+```
+yarn add viem @relayprotocol/relay-sdk @ton/core @ton/ton
+```
+
+### Usage
+
+`adaptTonWallet` turns a connected TON wallet into an `AdaptedWallet` the Relay
+SDK can execute against. The user's key lives in their wallet, so the adapter
+never signs — you pass a `sendTransaction` callback that signs + broadcasts the
+request via your wallet provider (e.g. Dynamic or TonConnect UI), and the
+adapter handles request building and on-chain confirmation.
+
+```ts
+import { adaptTonWallet } from '@relayprotocol/relay-ton-wallet-adapter'
+
+const adaptedWallet = adaptTonWallet(walletAddress, async (request) => {
+  // `request` is a TonConnect-style { validUntil, messages, network? }.
+  // Forward it to your wallet provider's send method (e.g. Dynamic's TON
+  // connector, or `tonConnectUI.sendTransaction`) and return the result. The
+  // adapter accepts { boc } (the signed external-message BOC most TonConnect
+  // wallets return) or { transactionHash }.
+  const boc = await wallet.sendTransaction(request)
+  return { boc }
+})
+```
+
+#### Confirmation endpoint
+
+`handleConfirmTransactionStep` polls a read-only [`@ton/ton`](https://github.com/ton-org/ton)
+`TonClient` to confirm the origin transaction. The RPC endpoint comes from the
+TON chain's `httpRpcUrl` in the Relay client's chain configuration, so to use a
+custom endpoint (e.g. a keyed provider for production), override the TON chain's
+`httpRpcUrl` when configuring the SDK client rather than passing it to the
+adapter.
+
+> Note: message signing (`handleSignMessageStep`) is not implemented, as it is
+> not used by deposit/bridge flows.

package/_cjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

package/_cjs/src/adapter.js

@@ -0,0 +1,148 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.adaptTonWallet = void 0;
+const relay_sdk_1 = require("@relayprotocol/relay-sdk");
+const ton_1 = require("@ton/ton");
+const core_1 = require("@ton/core");
+const TON_MAINNET_CHAIN = '-239';
+const TON_CHAIN_ID = 224235520;
+const DEFAULT_VALID_FOR_SECONDS = 300;
+const CONFIRM_POLL_MS = 2000;
+const CONFIRM_TIMEOUT_MS = 120_000;
+const CONFIRM_TX_LOOKBACK = 32;
+const adaptTonWallet = (walletAddress, sendTransaction) => {
+    if (typeof sendTransaction !== 'function') {
+        throw new Error('adaptTonWallet requires a sendTransaction function');
+    }
+    const walletAccount = core_1.Address.parse(walletAddress);
+    return {
+        vmType: 'tonvm',
+        getChainId: async () => TON_CHAIN_ID,
+        address: async () => walletAddress,
+        handleSignMessageStep: async () => {
+            throw new Error('Message signing not implemented for TON');
+        },
+        handleSendTransactionStep: async (_chainId, stepItem) => {
+            const client = (0, relay_sdk_1.getClient)();
+            const messages = stepItem.data.messages;
+            if (!messages || messages.length === 0) {
+                throw new Error('TON transaction step is missing messages');
+            }
+            const request = {
+                validUntil: Math.floor(Date.now() / 1000) + DEFAULT_VALID_FOR_SECONDS,
+                network: TON_MAINNET_CHAIN,
+                messages: messages.map((message) => ({
+                    address: encodeAddress(message.to, message.bounce),
+                    amount: message.value.toString(),
+                    ...(message.body ? { payload: message.body } : {}),
+                    ...(message.stateInit ? { stateInit: message.stateInit } : {})
+                }))
+            };
+            client.log(['Sending TON transaction', request], relay_sdk_1.LogLevel.Verbose);
+            const result = await sendTransaction(request);
+            const boc = result.boc ?? result.transactionHash;
+            if (!boc) {
+                throw new Error('No result returned from the TON wallet');
+            }
+            const messageHash = toMessageHash(boc, walletAccount);
+            client.log(['TON transaction submitted', messageHash], relay_sdk_1.LogLevel.Verbose);
+            return messageHash;
+        },
+        handleConfirmTransactionStep: async (externalMessageHash, chainId) => {
+            const client = (0, relay_sdk_1.getClient)();
+            const rpcUrl = client.chains.find((chain) => chain.id === chainId)
+                ?.httpRpcUrl;
+            if (!rpcUrl) {
+                throw new Error(`No TON httpRpcUrl configured for chainId ${chainId} in the Relay client`);
+            }
+            const tonClient = new ton_1.TonClient({ endpoint: rpcUrl });
+            const start = Date.now();
+            const maxAttempts = Math.ceil(CONFIRM_TIMEOUT_MS / CONFIRM_POLL_MS) + 1;
+            for (let attempt = 0; attempt < maxAttempts; attempt++) {
+                let match;
+                try {
+                    const transactions = await tonClient.getTransactions(walletAccount, {
+                        limit: CONFIRM_TX_LOOKBACK
+                    });
+                    for (const tx of transactions) {
+                        if (!tx.inMessage) {
+                            continue;
+                        }
+                        if (hashMessage(tx.inMessage) === externalMessageHash) {
+                            match = {
+                                hash: tx.hash().toString('hex'),
+                                lt: tx.lt.toString(),
+                                description: tx.description
+                            };
+                            break;
+                        }
+                    }
+                }
+                catch (error) {
+                    client.log(['Error polling for TON transaction', error], relay_sdk_1.LogLevel.Verbose);
+                }
+                if (match) {
+                    if (!isTransactionSuccessful(match.description)) {
+                        client.log(['TON transaction failed', match.description], relay_sdk_1.LogLevel.Verbose);
+                        throw new Error('TON transaction failed');
+                    }
+                    return { hash: match.hash, lt: match.lt };
+                }
+                if (Date.now() - start > CONFIRM_TIMEOUT_MS) {
+                    break;
+                }
+                await new Promise((resolve) => setTimeout(resolve, CONFIRM_POLL_MS));
+            }
+            throw new Error('TON transaction confirmation timed out');
+        },
+        switchChain: () => Promise.resolve()
+    };
+};
+exports.adaptTonWallet = adaptTonWallet;
+const hashMessage = (message) => {
+    return (0, core_1.beginCell)()
+        .store((0, core_1.storeMessage)(message))
+        .endCell()
+        .hash()
+        .toString('hex');
+};
+const toMessageHash = (bocOrHash, expectedWallet) => {
+    try {
+        const message = (0, core_1.loadMessage)(core_1.Cell.fromBase64(bocOrHash).beginParse());
+        if (message.info.type !== 'external-in') {
+            throw new Error(`Expected an external-in message, got ${message.info.type}`);
+        }
+        if (expectedWallet && !message.info.dest.equals(expectedWallet)) {
+            throw new Error('TON wallet returned a BOC for an unexpected account');
+        }
+        return hashMessage(message);
+    }
+    catch (error) {
+        const normalized = bocOrHash.trim().replace(/^0x/, '').toLowerCase();
+        if (/^[0-9a-f]{64}$/.test(normalized)) {
+            return normalized;
+        }
+        throw error;
+    }
+};
+const encodeAddress = (to, bounce) => {
+    if (bounce === undefined) {
+        return to;
+    }
+    return core_1.Address.parse(to).toString({ bounceable: bounce, urlSafe: true });
+};
+const isTransactionSuccessful = (description) => {
+    const desc = description;
+    if (desc?.type !== 'generic') {
+        return true;
+    }
+    if (desc.aborted === true) {
+        return false;
+    }
+    const computeOk = desc.computePhase?.type === 'vm'
+        ? desc.computePhase.success !== false
+        : true;
+    const actionOk = desc.actionPhase ? desc.actionPhase.success !== false : true;
+    return computeOk && actionOk;
+};
+//# sourceMappingURL=adapter.js.map

package/_cjs/src/adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.js","sourceRoot":"","sources":["../../src/adapter.ts"],"names":[],"mappings":";;;AAAA,wDAIiC;AACjC,kCAAoC;AACpC,oCAOkB;AAOlB,MAAM,iBAAiB,GAAG,MAAM,CAAA;AAGhC,MAAM,YAAY,GAAG,SAAS,CAAA;AAE9B,MAAM,yBAAyB,GAAG,GAAG,CAAA;AACrC,MAAM,eAAe,GAAG,IAAI,CAAA;AAC5B,MAAM,kBAAkB,GAAG,OAAO,CAAA;AAClC,MAAM,mBAAmB,GAAG,EAAE,CAAA;AAavB,MAAM,cAAc,GAAG,CAC5B,aAAqB,EACrB,eAAmC,EACpB,EAAE;IACjB,IAAI,OAAO,eAAe,KAAK,UAAU,EAAE,CAAC;QAC1C,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAA;IACvE,CAAC;IAED,MAAM,aAAa,GAAG,cAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAA;IAElD,OAAO;QACL,MAAM,EAAE,OAAO;QACf,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,YAAY;QACpC,OAAO,EAAE,KAAK,IAAI,EAAE,CAAC,aAAa;QAClC,qBAAqB,EAAE,KAAK,IAAI,EAAE;YAEhC,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAA;QAC5D,CAAC;QACD,yBAAyB,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE;YACtD,MAAM,MAAM,GAAG,IAAA,qBAAS,GAAE,CAAA;YAE1B,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAA;YACvC,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACvC,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAA;YAC7D,CAAC;YAQD,MAAM,OAAO,GAAiC;gBAC5C,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,GAAG,yBAAyB;gBACrE,OAAO,EAAE,iBAAiB;gBAC1B,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;oBACnC,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,MAAM,CAAC;oBAClD,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE;oBAChC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;oBAClD,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBAC/D,CAAC,CAAC;aACJ,CAAA;YAED,MAAM,CAAC,GAAG,CAAC,CAAC,yBAAyB,EAAE,OAAO,CAAC,EAAE,oBAAQ,CAAC,OAAO,CAAC,CAAA;YAElE,MAAM,MAAM,GAAG,MAAM,eAAe,CAAC,OAAO,CAAC,CAAA;YAI7C,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,IAAI,MAAM,CAAC,eAAe,CAAA;YAChD,IAAI,CAAC,GAAG,EAAE,CAAC;gBACT,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAA;YAC3D,CAAC;YACD,MAAM,WAAW,GAAG,aAAa,CAAC,GAAG,EAAE,aAAa,CAAC,CAAA;YAErD,MAAM,CAAC,GAAG,CAAC,CAAC,2BAA2B,EAAE,WAAW,CAAC,EAAE,oBAAQ,CAAC,OAAO,CAAC,CAAA;YACxE,OAAO,WAAW,CAAA;QACpB,CAAC;QACD,4BAA4B,EAAE,KAAK,EAAE,mBAAmB,EAAE,OAAO,EAAE,EAAE;YACnE,MAAM,MAAM,GAAG,IAAA,qBAAS,GAAE,CAAA;YAI1B,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,OAAO,CAAC;gBAChE,EAAE,UAAU,CAAA;YACd,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CACb,4CAA4C,OAAO,sBAAsB,CAC1E,CAAA;YACH,CAAC;YACD,MAAM,SAAS,GAAG,IAAI,eAAS,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAA;YAQrD,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;YAExB,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,kBAAkB,GAAG,eAAe,CAAC,GAAG,CAAC,CAAA;YAEvE,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,GAAG,WAAW,EAAE,OAAO,EAAE,EAAE,CAAC;gBACvD,IAAI,KAES,CAAA;gBACb,IAAI,CAAC;oBACH,MAAM,YAAY,GAAG,MAAM,SAAS,CAAC,eAAe,CAAC,aAAa,EAAE;wBAClE,KAAK,EAAE,mBAAmB;qBAC3B,CAAC,CAAA;oBACF,KAAK,MAAM,EAAE,IAAI,YAAY,EAAE,CAAC;wBAC9B,IAAI,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC;4BAClB,SAAQ;wBACV,CAAC;wBACD,IAAI,WAAW,CAAC,EAAE,CAAC,SAAS,CAAC,KAAK,mBAAmB,EAAE,CAAC;4BACtD,KAAK,GAAG;gCACN,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;gCAC/B,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,QAAQ,EAAE;gCACpB,WAAW,EAAE,EAAE,CAAC,WAAW;6BAC5B,CAAA;4BACD,MAAK;wBACP,CAAC;oBACH,CAAC;gBACH,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,MAAM,CAAC,GAAG,CACR,CAAC,mCAAmC,EAAE,KAAK,CAAC,EAC5C,oBAAQ,CAAC,OAAO,CACjB,CAAA;gBACH,CAAC;gBAED,IAAI,KAAK,EAAE,CAAC;oBACV,IAAI,CAAC,uBAAuB,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC;wBAChD,MAAM,CAAC,GAAG,CACR,CAAC,wBAAwB,EAAE,KAAK,CAAC,WAAW,CAAC,EAC7C,oBAAQ,CAAC,OAAO,CACjB,CAAA;wBACD,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAA;oBAC3C,CAAC;oBACD,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,KAAK,CAAC,EAAE,EAAE,CAAA;gBAC3C,CAAC;gBACD,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,kBAAkB,EAAE,CAAC;oBAC5C,MAAK;gBACP,CAAC;gBACD,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC,CAAA;YACtE,CAAC;YAED,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAA;QAC3D,CAAC;QACD,WAAW,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE;KACrC,CAAA;AACH,CAAC,CAAA;AAlIY,QAAA,cAAc,kBAkI1B;AAGD,MAAM,WAAW,GAAG,CAAC,OAAgB,EAAU,EAAE;IAC/C,OAAO,IAAA,gBAAS,GAAE;SACf,KAAK,CAAC,IAAA,mBAAY,EAAC,OAAO,CAAC,CAAC;SAC5B,OAAO,EAAE;SACT,IAAI,EAAE;SACN,QAAQ,CAAC,KAAK,CAAC,CAAA;AACpB,CAAC,CAAA;AASD,MAAM,aAAa,GAAG,CAAC,SAAiB,EAAE,cAAwB,EAAU,EAAE;IAC5E,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,IAAA,kBAAW,EAAC,WAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,CAAC,CAAA;QACpE,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CACb,wCAAwC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,CAC5D,CAAA;QACH,CAAC;QACD,IAAI,cAAc,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAA;QACxE,CAAC;QACD,OAAO,WAAW,CAAC,OAAO,CAAC,CAAA;IAC7B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,UAAU,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAA;QACpE,IAAI,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YACtC,OAAO,UAAU,CAAA;QACnB,CAAC;QACD,MAAM,KAAK,CAAA;IACb,CAAC;AACH,CAAC,CAAA;AASD,MAAM,aAAa,GAAG,CAAC,EAAU,EAAE,MAAgB,EAAU,EAAE;IAC7D,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,EAAE,CAAA;IACX,CAAC;IACD,OAAO,cAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAA;AAC1E,CAAC,CAAA;AASD,MAAM,uBAAuB,GAAG,CAAC,WAAoB,EAAW,EAAE;IAChE,MAAM,IAAI,GAAG,WAKZ,CAAA;IACD,IAAI,IAAI,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAA;IACb,CAAC;IACD,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAA;IACd,CAAC;IACD,MAAM,SAAS,GACb,IAAI,CAAC,YAAY,EAAE,IAAI,KAAK,IAAI;QAC9B,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,KAAK,KAAK;QACrC,CAAC,CAAC,IAAI,CAAA;IACV,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,CAAA;IAC7E,OAAO,SAAS,IAAI,QAAQ,CAAA;AAC9B,CAAC,CAAA"}

package/_cjs/src/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./adapter.js"), exports);
+tslib_1.__exportStar(require("./types.js"), exports);
+//# sourceMappingURL=index.js.map

package/_cjs/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,uDAA4B;AAC5B,qDAA0B"}

package/_cjs/src/types.js

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

package/_cjs/src/types.js.map

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