@tonconnect/sdk 0.0.4 → 0.0.5

package/README.md

@@ -1,10 +1,16 @@
-# TON Connect SDK core
+# TON Connect SDK
 
-⚠️ SDK is work in progress right now.
+⚠️ TonConnect is currently in beta testing. Use it at your own risk.
 
-## Init connector and call autoConnect. If user connected his wallet before, connector will restore connection
+Use it to connect your app to TON wallets via TonConnect protocol. 
+You can find more details and the protocol specification in the [docs](https://github.com/ton-connect/docs).
 
-```js
+## Get started
+`npm i @tonconnect/sdk`
+
+## Init connector and call autoConnect. If user connected his wallet before, connector will restore the connection
+
+```ts
 import TonConnect from '@tonconnect/sdk';
 
 const connector = new TonConnect();
@@ -25,28 +31,28 @@ connector.onStatusChange(
 ## Initialize a wallet connection when user clicks to 'connect' button in your app
 ### Initialize a remote wallet connection via universal link 
 
-```
+```ts
 const walletConnectionSource = {
     universalLinkBase: 'https://app.mycooltonwallet.com',
-    bridgeURL: 'https://bridge.mycooltonwallet.co,'
+    bridgeURL: 'https://bridge.mycooltonwallet.com,'
 }
 
 const uniwersalLink = connector.connect(walletConnectionSource);
 ```
 
-Then you have to show this link to user as QR code, or use it as a deeplink. You will receive update in `connector.onStatusChange` when user approves connection in the wallet
-
-### Initialize injected wallet connection 
+Then you have to show this link to user as QR code, or use it as a deeplink. You will receive an update in `connector.onStatusChange` when user approves connection in the wallet
 
-```
-connector.connect('injected');
+### Initialize injected wallet connection
+```ts
+if (connector.isInjectedProviderAvailable()) {
+    connector.connect('injected');
+}
 ```
 
-
-You will receive update in `connector.onStatusChange` when user approves connection in the wallet
+You will receive an update in `connector.onStatusChange` when user approves connection in the wallet
 
 ## Send transaction
-```js
+```ts
 if (!connetor.connected) {
     alert('Please connect wallet to send the transaction!');
 }
@@ -57,12 +63,12 @@ const transaction = {
         {
             address: "0:412410771DA82CBA306A55FA9E0D43C9D245E38133CB58F1457DFB8D5CD8892F",
             amount: "20000000",
-            initState: "base64bocblahblahblah==" //deploy contract
+            initState: "base64bocblahblahblah=="
         },
         {
             address: "0:E69F10CC84877ABF539F83F879291E5CA169451BA7BCE91A37A5CED3AB8080D3",
             amount: "60000000",
-            payload: "base64bocblahblahblah==" //transfer nft to new deployed account 0:412410771DA82CBA306A55FA9E0D43C9D245E38133CB58F1457DFB8D5CD8892F
+            payload: "base64bocblahblahblah=="
         }
     ]
 }

package/lib/index.d.ts

@@ -3,3 +3,4 @@ export * from './models';
 export * from './errors';
 export { IStorage } from './storage/models/storage.interface';
 export { TonConnect as default } from './ton-connect';
+export { CHAIN, DeviceInfo } from '@tonconnect/protocol';

package/lib/index.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = void 0;
+exports.CHAIN = exports.default = void 0;
 var tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./ton-connect"), exports);
 tslib_1.__exportStar(require("./models"), exports);
 tslib_1.__exportStar(require("./errors"), exports);
 var ton_connect_1 = require("./ton-connect");
 Object.defineProperty(exports, "default", { enumerable: true, get: function () { return ton_connect_1.TonConnect; } });
+var protocol_1 = require("@tonconnect/protocol");
+Object.defineProperty(exports, "CHAIN", { enumerable: true, get: function () { return protocol_1.CHAIN; } });

package/lib/ton-connect.d.ts

@@ -12,21 +12,57 @@ export declare class TonConnect implements ITonConnect {
     private provider;
     private statusChangeSubscriptions;
     private statusChangeErrorSubscriptions;
+    /**
+     * Shows if the wallet is connected right now.
+     */
     get connected(): boolean;
+    /**
+     * Current connected account or null if no account is connected.
+     */
     get account(): Account | null;
+    /**
+     * Current connected wallet or null if no account is connected.
+     */
     get wallet(): Wallet | null;
     private set wallet(value);
     constructor(options?: {
         dappMetedata?: DappMetadata;
         storage?: IStorage;
     });
+    /**
+     * Indicates if the injected wallet is available.
+     */
+    isInjectedProviderAvailable: typeof InjectedProvider.isWalletInjected;
+    /**
+     * Allows to subscribe to connection status changes and handle connection errors.
+     * @param callback will be called after connections status changes with actual wallet or null.
+     * @param errorsHandler (optional) will be called with some instance of TonConnectError when connect error is received.
+     * @returns unsubscribe callback.
+     */
     onStatusChange(callback: (wallet: Wallet | null) => void, errorsHandler?: (err: TonConnectError) => void): () => void;
+    /**
+     * Generates universal link for an external wallet and subscribes to the wallet's bridge, or sends connect request to the injected wallet.
+     * @param wallet wallet's bridge url and universal link for an external wallet or 'injected' for the injected wallet.
+     * @param request (optional) additional request to pass to the wallet while connect (currently only ton_proof is available).
+     * @returns universal link if external wallet was passed or void for the injected wallet.
+     */
     connect<T extends WalletConnectionSource | 'injected'>(wallet: T, request?: ConnectAdditionalRequest): T extends 'injected' ? void : string;
+    /**
+     * Try to restore existing session and reconnect to the corresponding wallet. Call it immediately when your app is loaded.
+     */
     autoConnect(): void;
-    _autoConnect(): Promise<void>;
-    sendTransaction(tx: SendTransactionRequest): Promise<SendTransactionResponse>;
+    /**
+     * Asks connected wallet to sign and send the transaction.
+     * @param transaction transaction to send.
+     * @returns signed transaction boc that allows you to find the transaction in the blockchain.
+     * If user rejects transaction, method will throw the corresponding error.
+     */
+    sendTransaction(transaction: SendTransactionRequest): Promise<SendTransactionResponse>;
+    /**
+     * Disconnect form thw connected wallet and drop current session.
+     */
     disconnect(): Promise<void>;
-    isInjectedProviderAvailable: typeof InjectedProvider.isWalletInjected;
+    private _autoConnect;
     private createProvider;
     private walletEventsListener;
     private onWalletConnected;

package/lib/ton-connect.interface.d.ts

@@ -1,14 +1,51 @@
+import { TonConnectError } from "./errors";
 import { Account, WalletConnectionSource, Wallet } from "./models";
 import { SendTransactionRequest, SendTransactionResponse } from "./models/methods";
 import { ConnectAdditionalRequest } from "./models/methods/connect/connect-additional-request";
 export interface ITonConnect {
+    /**
+     * Shows if the wallet is connected right now.
+     */
     connected: boolean;
+    /**
+     * Current connected account or null if no account is connected.
+     */
     account: Account | null;
+    /**
+     * Current connected wallet or null if no account is connected.
+     */
     wallet: Wallet | null;
-    onStatusChange(callback: (walletInfo: Wallet | null) => void): () => void;
+    /**
+     * Indicates if the injected wallet is available.
+     */
+    isInjectedProviderAvailable(): boolean;
+    /**
+     * Allows to subscribe to connection status changes and handle connection errors.
+     * @param callback will be called after connections status changes with actual wallet or null.
+     * @param errorsHandler (optional) will be called with some instance of TonConnectError when connect error is received.
+     * @returns unsubscribe callback.
+     */
+    onStatusChange(callback: (walletInfo: Wallet | null) => void, errorsHandler?: (err: TonConnectError) => void): () => void;
+    /**
+     * Generates universal link for an external wallet and subscribes to the wallet's bridge, or sends connect request to the injected wallet.
+     * @param wallet wallet's bridge url and universal link for an external wallet or 'injected' for the injected wallet.
+     * @param request (optional) additional request to pass to the wallet while connect (currently only ton_proof is available).
+     * @returns universal link if external wallet was passed or void for the injected wallet.
+     */
     connect<T extends WalletConnectionSource | 'injected'>(wallet: T, request?: ConnectAdditionalRequest): T extends 'injected' ? void : string;
+    /**
+     * Try to restore existing session and reconnect to the corresponding wallet. Call it immediately when your app is loaded.
+     */
     autoConnect(): void;
-    sendTransaction(tx: SendTransactionRequest): Promise<SendTransactionResponse>;
+    /**
+     * Disconnect form thw connected wallet and drop current session.
+     */
     disconnect(): Promise<void>;
-    isInjectedProviderAvailable(): boolean;
+    /**
+     * Asks connected wallet to sign and send the transaction.
+     * @param transaction transaction to send.
+     * @returns signed transaction boc that allows you to find the transaction in the blockchain.
+     * If user rejects transaction, method will throw the corresponding error.
+     */
+    sendTransaction(transaction: SendTransactionRequest): Promise<SendTransactionResponse>;
 }

package/lib/ton-connect.js

@@ -19,6 +19,9 @@ var TonConnect = /** @class */ (function () {
         this.provider = null;
         this.statusChangeSubscriptions = [];
         this.statusChangeErrorSubscriptions = [];
+        /**
+         * Indicates if the injected wallet is available.
+         */
         this.isInjectedProviderAvailable = injected_provider_1.InjectedProvider.isWalletInjected;
         this.dappSettings = {
             metadata: (options === null || options === void 0 ? void 0 : options.dappMetedata) || (0, web_api_1.getWebPageMetadata)(),
@@ -27,6 +30,9 @@ var TonConnect = /** @class */ (function () {
         this.bridgeConnectionStorage = new bridge_connection_storage_1.BridgeConnectionStorage(this.dappSettings.storage);
     }
     Object.defineProperty(TonConnect.prototype, "connected", {
+        /**
+         * Shows if the wallet is connected right now.
+         */
         get: function () {
             return this._wallet !== null;
         },
@@ -34,6 +40,9 @@ var TonConnect = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(TonConnect.prototype, "account", {
+        /**
+         * Current connected account or null if no account is connected.
+         */
         get: function () {
             var _a;
             return ((_a = this._wallet) === null || _a === void 0 ? void 0 : _a.account) || null;
@@ -42,6 +51,9 @@ var TonConnect = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(TonConnect.prototype, "wallet", {
+        /**
+         * Current connected wallet or null if no account is connected.
+         */
         get: function () {
             return this._wallet;
         },
@@ -53,6 +65,12 @@ var TonConnect = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    /**
+     * Allows to subscribe to connection status changes and handle connection errors.
+     * @param callback will be called after connections status changes with actual wallet or null.
+     * @param errorsHandler (optional) will be called with some instance of TonConnectError when connect error is received.
+     * @returns unsubscribe callback.
+     */
     TonConnect.prototype.onStatusChange = function (callback, errorsHandler) {
         var _this = this;
         this.statusChangeSubscriptions.push(callback);
@@ -75,43 +93,26 @@ var TonConnect = /** @class */ (function () {
         this.provider = this.createProvider(wallet);
         return this.provider.connect(this.createConnectRequest(request));
     };
+    /**
+     * Try to restore existing session and reconnect to the corresponding wallet. Call it immediately when your app is loaded.
+     */
     TonConnect.prototype.autoConnect = function () {
         this._autoConnect();
     };
-    TonConnect.prototype._autoConnect = function () {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var bridgeConnection, _a, _b;
-            return tslib_1.__generator(this, function (_c) {
-                switch (_c.label) {
-                    case 0: return [4 /*yield*/, this.bridgeConnectionStorage.getConnection()];
-                    case 1:
-                        bridgeConnection = _c.sent();
-                        if (!bridgeConnection) return [3 /*break*/, 3];
-                        _a = this;
-                        return [4 /*yield*/, this.createProvider(bridgeConnection.session.walletConnectionSource)];
-                    case 2:
-                        _a.provider = _c.sent();
-                        return [2 /*return*/, this.provider.autoConnect()];
-                    case 3:
-                        if (!injected_provider_1.InjectedProvider.isWalletInjected()) return [3 /*break*/, 5];
-                        _b = this;
-                        return [4 /*yield*/, this.createProvider('injected')];
-                    case 4:
-                        _b.provider = _c.sent();
-                        return [2 /*return*/, this.provider.autoConnect()];
-                    case 5: return [2 /*return*/];
-                }
-            });
-        });
-    };
-    TonConnect.prototype.sendTransaction = function (tx) {
+    /**
+     * Asks connected wallet to sign and send the transaction.
+     * @param transaction transaction to send.
+     * @returns signed transaction boc that allows you to find the transaction in the blockchain.
+     * If user rejects transaction, method will throw the corresponding error.
+     */
+    TonConnect.prototype.sendTransaction = function (transaction) {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
             var response;
             return tslib_1.__generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         this.checkConnection();
-                        return [4 /*yield*/, this.provider.sendRequest(send_transaction_parser_1.sendTransactionParser.convertToRpcRequest(tx))];
+                        return [4 /*yield*/, this.provider.sendRequest(send_transaction_parser_1.sendTransactionParser.convertToRpcRequest(transaction))];
                     case 1:
                         response = _a.sent();
                         if (send_transaction_parser_1.sendTransactionParser.isError(response)) {
@@ -122,6 +123,9 @@ var TonConnect = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Disconnect form thw connected wallet and drop current session.
+     */
     TonConnect.prototype.disconnect = function () {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
             return tslib_1.__generator(this, function (_a) {
@@ -139,6 +143,32 @@ var TonConnect = /** @class */ (function () {
             });
         });
     };
+    TonConnect.prototype._autoConnect = function () {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var bridgeConnection, _a, _b;
+            return tslib_1.__generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0: return [4 /*yield*/, this.bridgeConnectionStorage.getConnection()];
+                    case 1:
+                        bridgeConnection = _c.sent();
+                        if (!bridgeConnection) return [3 /*break*/, 3];
+                        _a = this;
+                        return [4 /*yield*/, this.createProvider(bridgeConnection.session.walletConnectionSource)];
+                    case 2:
+                        _a.provider = _c.sent();
+                        return [2 /*return*/, this.provider.autoConnect()];
+                    case 3:
+                        if (!injected_provider_1.InjectedProvider.isWalletInjected()) return [3 /*break*/, 5];
+                        _b = this;
+                        return [4 /*yield*/, this.createProvider('injected')];
+                    case 4:
+                        _b.provider = _c.sent();
+                        return [2 /*return*/, this.provider.autoConnect()];
+                    case 5: return [2 /*return*/];
+                }
+            });
+        });
+    };
     TonConnect.prototype.createProvider = function (wallet) {
         var provider;
         if (wallet === 'injected') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tonconnect/sdk",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "scripts": {
     "build": "npx rimraf lib && ttsc",
     "build:production": "npx rimraf lib && ttsc --sourceMap false"
@@ -26,7 +26,7 @@
   "dependencies": {
     "deepmerge": "^4.2.2",
     "tweetnacl": "^1.0.3",
-    "@tonconnect/protocol": "^0.0.4"
+    "@tonconnect/protocol": "^0.0.5"
   },
   "files": [
     "lib"