@tonconnect/sdk 0.0.30 → 0.0.32

package/README.md

@@ -6,7 +6,8 @@ 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).
 See the example of sdk usage [here](https://github.com/ton-connect/demo-dapp).
 
-## Get started
+# Get started
+## Install package
 `npm i @tonconnect/sdk`
 
 ## Init connector and call autoConnect. If user connected his wallet before, connector will restore the connection
@@ -45,7 +46,7 @@ const walletsList = await connector.getWallets();
     bridgeUrl?: string;
     jsBridgeKey?: string;
     injected?: boolean; // true if this wallet is injected to the webpage
-    embedded?: boolean; // true if dapp is opened inside this wallet's browser
+    embedded?: boolean; // true if the dapp is opened inside this wallet's browser
 }[] 
  */
 ```

package/lib/errors/dapp/dapp-metadata.error.d.ts

@@ -1,4 +1,7 @@
 import { TonConnectError } from "../ton-connect.error";
+/**
+ * Thrown when passed DappMetadata is in incorrect format.
+ */
 export declare class DappMetadataError extends TonConnectError {
     constructor(...args: ConstructorParameters<typeof TonConnectError>);
 }

package/lib/errors/dapp/dapp-metadata.error.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DappMetadataError = void 0;
 const ton_connect_error_1 = require("../ton-connect.error");
+/**
+ * Thrown when passed DappMetadata is in incorrect format.
+ */
 class DappMetadataError extends ton_connect_error_1.TonConnectError {
     constructor(...args) {
         super(...args);

package/lib/errors/protocol/events/connect/user-rejects.error.d.ts

@@ -1,4 +1,7 @@
 import { TonConnectError } from "../../../ton-connect.error";
+/**
+ * Thrown when user rejects the action in the wallet.
+ */
 export declare class UserRejectsError extends TonConnectError {
     constructor(...args: ConstructorParameters<typeof TonConnectError>);
 }

package/lib/errors/protocol/events/connect/user-rejects.error.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UserRejectsError = void 0;
 const ton_connect_error_1 = require("../../../ton-connect.error");
+/**
+ * Thrown when user rejects the action in the wallet.
+ */
 class UserRejectsError extends ton_connect_error_1.TonConnectError {
     constructor(...args) {
         super(...args);

package/lib/errors/protocol/responses/bad-request.error.d.ts

@@ -1,4 +1,7 @@
 import { TonConnectError } from "../../ton-connect.error";
+/**
+ * Thrown when request to the wallet contains errors.
+ */
 export declare class BadRequestError extends TonConnectError {
     constructor(...args: ConstructorParameters<typeof TonConnectError>);
 }

package/lib/errors/protocol/responses/bad-request.error.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BadRequestError = void 0;
 const ton_connect_error_1 = require("../../ton-connect.error");
+/**
+ * Thrown when request to the wallet contains errors.
+ */
 class BadRequestError extends ton_connect_error_1.TonConnectError {
     constructor(...args) {
         super(...args);

package/lib/errors/protocol/responses/unknown-app.error.d.ts

@@ -1,4 +1,7 @@
 import { TonConnectError } from "../../ton-connect.error";
+/**
+ * Thrown when app tries to send rpc request to the injected wallet while not connected.
+ */
 export declare class UnknownAppError extends TonConnectError {
     constructor(...args: ConstructorParameters<typeof TonConnectError>);
 }

package/lib/errors/protocol/responses/unknown-app.error.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UnknownAppError = void 0;
 const ton_connect_error_1 = require("../../ton-connect.error");
+/**
+ * Thrown when app tries to send rpc request to the injected wallet while not connected.
+ */
 class UnknownAppError extends ton_connect_error_1.TonConnectError {
     constructor(...args) {
         super(...args);

package/lib/errors/storage/localstorage-not-found.error.d.ts

@@ -1,4 +1,7 @@
 import { TonConnectError } from "../ton-connect.error";
+/**
+ * Thrown when `Storage` was not specified in the `DappMetadata` and default `localStorage` was not detected in the environment.
+ */
 export declare class LocalstorageNotFoundError extends TonConnectError {
     constructor(...args: ConstructorParameters<typeof TonConnectError>);
 }

package/lib/errors/storage/localstorage-not-found.error.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LocalstorageNotFoundError = void 0;
 const ton_connect_error_1 = require("../ton-connect.error");
+/**
+ * Thrown when `Storage` was not specified in the `DappMetadata` and default `localStorage` was not detected in the environment.
+ */
 class LocalstorageNotFoundError extends ton_connect_error_1.TonConnectError {
     constructor(...args) {
         super(...args);

package/lib/errors/ton-connect.error.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Base class for TonConnect errors. You can check if the error was triggered by the @tonconnect/sdk using `err instanceof TonConnectError`.
+ */
 export declare class TonConnectError extends Error {
     constructor(...args: ConstructorParameters<typeof Error>);
 }

package/lib/errors/ton-connect.error.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TonConnectError = void 0;
+/**
+ * Base class for TonConnect errors. You can check if the error was triggered by the @tonconnect/sdk using `err instanceof TonConnectError`.
+ */
 class TonConnectError extends Error {
     constructor(...args) {
         super(...args);

package/lib/errors/unknown.error.d.ts

@@ -1,4 +1,7 @@
 import { TonConnectError } from "./ton-connect.error";
+/**
+ * Unhanded unknown error.
+ */
 export declare class UnknownError extends TonConnectError {
     constructor(...args: ConstructorParameters<typeof TonConnectError>);
 }

package/lib/errors/unknown.error.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UnknownError = void 0;
 const ton_connect_error_1 = require("./ton-connect.error");
+/**
+ * Unhanded unknown error.
+ */
 class UnknownError extends ton_connect_error_1.TonConnectError {
     constructor(...args) {
         super(...args);

package/lib/errors/wallet/wallet-already-connected.error.d.ts

@@ -1,4 +1,7 @@
 import { TonConnectError } from "../ton-connect.error";
+/**
+ * Thrown when wallet connection called but wallet already connected. To avoid the error, disconnect the wallet before doing a new connection.
+ */
 export declare class WalletAlreadyConnectedError extends TonConnectError {
     constructor(...args: ConstructorParameters<typeof TonConnectError>);
 }

package/lib/errors/wallet/wallet-already-connected.error.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WalletAlreadyConnectedError = void 0;
 const ton_connect_error_1 = require("../ton-connect.error");
+/**
+ * Thrown when wallet connection called but wallet already connected. To avoid the error, disconnect the wallet before doing a new connection.
+ */
 class WalletAlreadyConnectedError extends ton_connect_error_1.TonConnectError {
     constructor(...args) {
         super(...args);

package/lib/errors/wallet/wallet-not-connected.error.d.ts

@@ -1,4 +1,7 @@
 import { TonConnectError } from "../ton-connect.error";
+/**
+ * Thrown when send transaction or other protocol methods called while wallet is not connected.
+ */
 export declare class WalletNotConnectedError extends TonConnectError {
     constructor(...args: ConstructorParameters<typeof TonConnectError>);
 }

package/lib/errors/wallet/wallet-not-connected.error.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WalletNotConnectedError = void 0;
 const ton_connect_error_1 = require("../ton-connect.error");
+/**
+ * Thrown when send transaction or other protocol methods called while wallet is not connected.
+ */
 class WalletNotConnectedError extends ton_connect_error_1.TonConnectError {
     constructor(...args) {
         super(...args);

package/lib/errors/wallet/wallet-not-injected.error.d.ts

@@ -1,4 +1,7 @@
 import { TonConnectError } from "../ton-connect.error";
+/**
+ * Thrown when there is an attempt to connect to the injected wallet while it is not exists in the webpage.
+ */
 export declare class WalletNotInjectedError extends TonConnectError {
     constructor(...args: ConstructorParameters<typeof TonConnectError>);
 }

package/lib/errors/wallet/wallet-not-injected.error.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WalletNotInjectedError = void 0;
 const ton_connect_error_1 = require("../ton-connect.error");
+/**
+ * Thrown when there is an attempt to connect to the injected wallet while it is not exists in the webpage.
+ */
 class WalletNotInjectedError extends ton_connect_error_1.TonConnectError {
     constructor(...args) {
         super(...args);

package/lib/errors/wallets-manager/fetch-wallets.error.d.ts

@@ -1,4 +1,7 @@
 import { TonConnectError } from "../ton-connect.error";
+/**
+ * Thrown when an error occurred while fetching the wallets list.
+ */
 export declare class FetchWalletsError extends TonConnectError {
     constructor(...args: ConstructorParameters<typeof TonConnectError>);
 }

package/lib/errors/wallets-manager/fetch-wallets.error.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FetchWalletsError = void 0;
 const ton_connect_error_1 = require("../ton-connect.error");
+/**
+ * Thrown when an error occurred while fetching the wallets list.
+ */
 class FetchWalletsError extends ton_connect_error_1.TonConnectError {
     constructor(...args) {
         super(...args);

package/lib/models/dapp/dapp-metadata.d.ts

@@ -1,5 +1,18 @@
 export interface DappMetadata {
+    /**
+     * Dapp name. Might be simple, will not be used as identifier.
+     * @default `document.title` if exists, 'Unknown dapp' overwise
+     */
     name: string;
+    /**
+     * URL to the dapp icon. Must be PNG, ICO, ... . SVG icons are not supported.
+     * @default best quality favicon declared via <link> in the document or '' if there are no any icons in the document.
+     */
     icon: string;
+    /**
+     * Dapp URL. Will be used as the dapp identifier. Will be used to open the dapp after click to its icon in the wallet.
+     * It is recommended to pass url without closing slash, e.g. 'https://mydapp.com' instead of 'https://mydapp.com/'.
+     * @default `window.location.origin` if exists, otherwise (if not explicitly specified) an error will be thrown.
+     */
     url: string;
 }

package/lib/models/index.d.ts

@@ -1,4 +1,4 @@
 export * from './wallet';
 export * from './methods';
 export { DappMetadata } from './dapp/dapp-metadata';
-export { DappSettings } from './dapp/dapp-settings';
+export { TonConnectOptions } from './ton-connect-options';

package/lib/models/methods/connect/connect-additional-request.d.ts

@@ -1,3 +1,6 @@
 export interface ConnectAdditionalRequest {
+    /**
+     * Payload for ton_proof
+     */
     tonProof: string;
 }

package/lib/models/methods/send-transaction/send-transaction-request.d.ts

@@ -1,9 +1,27 @@
 export interface SendTransactionRequest {
+    /**
+     * Sending transaction deadline in unix epoch seconds.
+     */
     valid_until: number;
+    /**
+     * Messages to send: min is 1, max is 4.
+     */
     messages: {
+        /**
+         * Receiver's address.
+         */
         address: string;
+        /**
+         * Amount to send in nanoTon.
+         */
         amount: string;
+        /**
+         * Contract specific data to add to the transaction.
+         */
         initState?: string;
+        /**
+         * Contract specific data to add to the transaction.
+         */
         payload?: string;
     }[];
 }

package/lib/models/methods/send-transaction/send-transaction-response.d.ts

@@ -1,3 +1,6 @@
 export interface SendTransactionResponse {
+    /**
+     * Signed boc
+     */
     boc: string;
 }

package/lib/models/ton-connect-options.d.ts

@@ -0,0 +1,16 @@
+import { DappMetadata } from "./dapp/dapp-metadata";
+import { IStorage } from "../storage/models/storage.interface";
+/**
+ * TonConnect constructor options
+ */
+export interface TonConnectOptions {
+    /**
+     * Dapp metadata that will be displayed in the user's wallet.
+     * Options will be merged with the [defaults]{@link ./dapp/dappMetedata.ts} if there are some empty fields.
+     */
+    dappMetedata?: Partial<DappMetadata>;
+    /**
+     * Storage to save protocol data. For browser default is `localStorage`. If you use SDK with nodeJS, you have to specify this field.
+     */
+    storage?: IStorage;
+}

package/lib/models/wallet/account.d.ts

@@ -1,5 +1,11 @@
 import { CHAIN } from '@tonconnect/protocol';
 export interface Account {
+    /**
+     * User's address in "hex" format: "<wc>:<hex>".
+     */
     address: string;
+    /**
+     * User's selected chain.
+     */
     chain: CHAIN;
 }

package/lib/models/wallet/index.d.ts

@@ -1,4 +1,4 @@
 export type { Account } from './account';
 export type { Wallet } from './wallet';
-export type { WalletConnectionSource } from './wallet-connection-source';
+export type { WalletConnectionSource, WalletConnectionSourceHTTP, WalletConnectionSourceJS } from './wallet-connection-source';
 export { WalletInfo, WalletInfoInjected, WalletInfoRemote, isWalletInfoInjected } from './wallet-info';

package/lib/models/wallet/wallet-connection-source.d.ts

@@ -1,9 +1,18 @@
 export declare type WalletConnectionSource = WalletConnectionSourceHTTP | WalletConnectionSourceJS;
 export interface WalletConnectionSourceHTTP {
+    /**
+     * Base part of the wallet universal url. The link should support [Ton Connect parameters]{@link https://github.com/ton-connect/docs/blob/main/bridge.md#universal-link}.
+     */
     universalLink: string;
+    /**
+     * Url of the wallet's implementation of the [HTTP bridge]{@link https://github.com/ton-connect/docs/blob/main/bridge.md#http-bridge}.
+     */
     bridgeUrl: string;
 }
 export interface WalletConnectionSourceJS {
+    /**
+     * If the wallet handles JS Bridge connection, specifies the binding for the bridge object accessible through window. Example: the key "tonkeeper" means the bridge can be accessed as window.tonkeeper.
+     */
     jsBridgeKey: string;
 }
 export declare function isWalletConnectionSourceJS(value: WalletConnectionSource): value is WalletConnectionSourceJS;

package/lib/models/wallet/wallet-info.d.ts

@@ -1,16 +1,43 @@
 export interface WalletInfoBase {
+    /**
+     * Name of the wallet.
+     */
     name: string;
+    /**
+     * Url to the icon of the wallet. Resolution 288×288px. On non-transparent background, without rounded corners. PNG format.
+     */
     imageUrl: string;
+    /**
+     * Will be used in the protocol later.
+     */
     tondns?: string;
+    /**
+     * Info or landing page of your wallet. May be useful for TON newcomers.
+     */
     aboutUrl: string;
 }
 export interface WalletInfoRemote extends WalletInfoBase {
+    /**
+     * Base part of the wallet universal url. The link should support [Ton Connect parameters]{@link https://github.com/ton-connect/docs/blob/main/bridge.md#universal-link}.
+     */
     universalLink: string;
+    /**
+     * Url of the wallet's implementation of the [HTTP bridge]{@link https://github.com/ton-connect/docs/blob/main/bridge.md#http-bridge}.
+     */
     bridgeUrl: string;
 }
 export interface WalletInfoInjected extends WalletInfoBase {
+    /**
+     * If the wallet handles JS Bridge connection, specifies the binding for the bridge object accessible through window. Example: the key "tonkeeper" means the bridge can be accessed as window.tonkeeper.
+     */
     jsBridgeKey: string;
+    /**
+     * Indicates if the wallet currently is injected to the webpage.
+     */
     injected: boolean;
+    /**
+     * Indicates if the dapp is opened inside this wallet's browser.
+     */
     embedded: boolean;
 }
 export declare type WalletInfo = WalletInfoRemote | WalletInfoInjected | (WalletInfoRemote & WalletInfoInjected);

package/lib/models/wallet/wallet.d.ts

@@ -1,9 +1,21 @@
 import { DeviceInfo, TonProofItemReply } from '@tonconnect/protocol';
 import { Account } from "..";
 export interface Wallet {
+    /**
+     * Information about user's wallet's device.
+     */
     device: DeviceInfo;
+    /**
+     * Provider type: http bridge or injected js.
+     */
     provider: 'http' | 'injected';
+    /**
+     * Selected account.
+     */
     account: Account;
+    /**
+     * Response for connect items request.
+     */
     connectItems?: {
         tonProof?: TonProofItemReply;
     };

package/lib/provider/bridge/bridge-gateway.js

@@ -14,8 +14,7 @@ const protocol_1 = require("@tonconnect/protocol");
 const errors_1 = require("../../errors");
 const http_bridge_gateway_storage_1 = require("../../storage/http-bridge-gateway-storage");
 const url_1 = require("../../utils/url");
-const web_api_1 = require("../../utils/web-api");
-if ((0, web_api_1.isNode)()) {
+if ((0, protocol_1.isNode)()) {
     try {
         eval("global.EventSource = require('eventsource')");
         eval("global.fetch = require('node-fetch')");

package/lib/storage/models/storage.interface.d.ts

@@ -1,5 +1,21 @@
+/**
+ * Imitation of the localStorage.
+ */
 export interface IStorage {
+    /**
+     * Saves the `value` to the storage. Value can be accessed later by the `key`. Implementation may use backend as a storage due to the fact that the function returns a promise.
+     * @param key key to access to the value later.
+     * @param value value to save.
+     */
     setItem(key: string, value: string): Promise<void>;
+    /**
+     * Reads the `value` from the storage. Implementation may use backend as a storage due to the fact that the function returns a promise.
+     * @param key key to access the value.
+     */
     getItem(key: string): Promise<string | null>;
+    /**
+     * Removes the `value` from the storage. Implementation may use backend as a storage due to the fact that the function returns a promise.
+     * @param key key to access the value.
+     */
     removeItem(key: string): Promise<void>;
 }

package/lib/ton-connect.d.ts

@@ -1,9 +1,9 @@
 import { TonConnectError } from "./errors/ton-connect.error";
-import { Account, DappMetadata, Wallet, WalletConnectionSource, WalletInfo } from "./models";
+import { Account, Wallet, WalletConnectionSource, WalletInfo } from "./models";
 import { SendTransactionRequest, SendTransactionResponse } from "./models/methods";
 import { ConnectAdditionalRequest } from "./models/methods/connect/connect-additional-request";
+import { TonConnectOptions } from "./models/ton-connect-options";
 import { WalletConnectionSourceJS } from "./models/wallet/wallet-connection-source";
-import { IStorage } from "./storage/models/storage.interface";
 import { ITonConnect } from "./ton-connect.interface";
 export declare class TonConnect implements ITonConnect {
     private readonly walletsList;
@@ -26,10 +26,7 @@ export declare class TonConnect implements ITonConnect {
      */
     get wallet(): Wallet | null;
     private set wallet(value);
-    constructor(options?: {
-        dappMetedata?: Partial<DappMetadata>;
-        storage?: IStorage;
-    });
+    constructor(options?: TonConnectOptions);
     /**
      * Returns available wallets list.
      */

package/lib/ton-connect.js

@@ -32,10 +32,10 @@ class TonConnect {
         this.statusChangeSubscriptions = [];
         this.statusChangeErrorSubscriptions = [];
         this.dappSettings = {
-            metadata: (0, options_1.mergeOptions)(options === null || options === void 0 ? void 0 : options.dappMetedata, (0, web_api_1.getWebPageMetadata)()),
+            dappMetedata: (0, options_1.mergeOptions)(options === null || options === void 0 ? void 0 : options.dappMetedata, (0, web_api_1.getWebPageMetadata)()),
             storage: (options === null || options === void 0 ? void 0 : options.storage) || new default_storage_1.DefaultStorage()
         };
-        if (!this.dappSettings.metadata.url) {
+        if (!this.dappSettings.dappMetedata.url) {
             throw new dapp_metadata_error_1.DappMetadataError('Dapp url must be specified if window.location.origin is undefined.');
         }
         this.bridgeConnectionStorage = new bridge_connection_storage_1.BridgeConnectionStorage(this.dappSettings.storage);
@@ -210,7 +210,7 @@ class TonConnect {
     }
     createConnectRequest(request) {
         const webPageMetadata = (0, web_api_1.getWebPageMetadata)();
-        const metadata = (0, options_1.mergeOptions)(this.dappSettings.metadata, webPageMetadata);
+        const metadata = (0, options_1.mergeOptions)(this.dappSettings.dappMetedata, webPageMetadata);
         const items = [
             {
                 name: 'ton_addr'

package/lib/utils/web-api.d.ts

@@ -1,5 +1,4 @@
 import { DappMetadata } from "../models";
 export declare function getWindow(): Window | undefined;
 export declare function getDocument(): Document | undefined;
-export declare function isNode(): boolean;
 export declare function getWebPageMetadata(): DappMetadata;

package/lib/utils/web-api.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getWebPageMetadata = exports.isNode = exports.getDocument = exports.getWindow = void 0;
+exports.getWebPageMetadata = exports.getDocument = exports.getWindow = void 0;
 function getWindow() {
     if (typeof window === 'undefined') {
         return undefined;
@@ -15,10 +15,6 @@ function getDocument() {
     return document;
 }
 exports.getDocument = getDocument;
-function isNode() {
-    return typeof require === 'function' && typeof global === 'object';
-}
-exports.isNode = isNode;
 function getWebPageMetadata() {
     var _a, _b;
     return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tonconnect/sdk",
-  "version": "0.0.30",
+  "version": "0.0.32",
   "scripts": {
     "build": "npx rimraf lib && ttsc",
     "build:production": "npx rimraf lib && ttsc --sourceMap false"
@@ -28,7 +28,7 @@
     "tweetnacl": "^1.0.3",
     "eventsource": "^2.0.2",
     "node-fetch": "^2.6.7",
-    "@tonconnect/protocol": "^0.0.17"
+    "@tonconnect/protocol": "^0.0.19"
   },
   "files": [
     "lib"
@@ -42,5 +42,8 @@
     "ts-loader": "^9.4.1",
     "ttypescript": "^1.5.13",
     "typescript-transform-paths": "^3.3.1"
+  },
+  "typedoc": {
+    "entryPoint": "./src/index.ts"
   }
 }

package/lib/models/dapp/dapp-settings.d.ts

@@ -1,6 +0,0 @@
-import { DappMetadata } from "..";
-import { IStorage } from "../../storage/models/storage.interface";
-export interface DappSettings {
-    metadata: DappMetadata;
-    storage: IStorage;
-}