@tonconnect/sdk 3.1.0 → 3.2.0-beta.0

package/lib/types/index.d.ts

@@ -303,6 +303,12 @@ export declare function createConnectionRestoringStartedEvent(version: Version):
  */
 export declare function createConnectionStartedEvent(version: Version): ConnectionStartedEvent;
 
+export declare function createDataSentForSignatureEvent(version: Version, wallet: Wallet | null, data: SignDataPayload): DataSentForSignatureEvent;
+
+export declare function createDataSignedEvent(version: Version, wallet: Wallet | null, data: SignDataPayload, signedData: SignDataResponse): DataSignedEvent;
+
+export declare function createDataSigningFailedEvent(version: Version, wallet: Wallet | null, data: SignDataPayload, errorMessage: string, errorCode: SIGN_DATA_ERROR_CODES | void): DataSigningFailedEvent;
+
 /**
  * Create a disconnect event.
  * @param version
@@ -375,6 +381,28 @@ export declare interface DappMetadata {
     url: string;
 }
 
+export declare type DataSentForSignatureEvent = {
+    type: 'sign-data-request-initiated';
+    data: SignDataPayload;
+} & ConnectionInfo;
+
+export declare type DataSignedEvent = {
+    type: 'sign-data-request-completed';
+    is_success: true;
+    data: SignDataPayload;
+    signed_data: SignDataResponse;
+} & ConnectionInfo;
+
+export declare type DataSigningEvent = DataSentForSignatureEvent | DataSignedEvent | DataSigningFailedEvent;
+
+export declare type DataSigningFailedEvent = {
+    type: 'sign-data-request-failed';
+    is_success: false;
+    error_message: string;
+    error_code: SIGN_DATA_ERROR_CODES | null;
+    data: SignDataPayload;
+} & ConnectionInfo;
+
 export declare interface DeviceInfo {
     platform: 'iphone' | 'ipad' | 'android' | 'windows' | 'mac' | 'linux' | 'browser';
     appName: string;
@@ -427,6 +455,8 @@ export declare interface EventDispatcher<T extends {
 
 export declare type Feature = SendTransactionFeatureDeprecated | SendTransactionFeature | SignDataFeature;
 
+export declare type FeatureName = Exclude<Feature, 'SendTransaction'>['name'];
+
 /**
  * Thrown when an error occurred while fetching the wallets list.
  */
@@ -555,6 +585,10 @@ export declare interface ITonConnect {
     }): Promise<SendTransactionResponse>;
     /** @deprecated use sendTransaction(transaction, options) instead */
     sendTransaction(transaction: SendTransactionRequest, onRequestSent?: () => void): Promise<SendTransactionResponse>;
+    signData(data: SignDataPayload, options?: {
+        onRequestSent?: () => void;
+        signal?: AbortSignal;
+    }): Promise<SignDataResponse>;
 }
 
 /**
@@ -596,6 +630,7 @@ export declare type RequiredFeatures = {
      * Required features for the send transaction feature.
      */
     sendTransaction?: RequiredSendTransactionFeature;
+    signData?: RequiredSignDataFeature;
 };
 
 /**
@@ -612,6 +647,16 @@ export declare type RequiredSendTransactionFeature = {
     extraCurrencyRequired?: boolean;
 };
 
+/**
+ * Required features for the sign data feature.
+ */
+export declare type RequiredSignDataFeature = {
+    /**
+     * Supported sign data types.
+     */
+    types: SignDataType[];
+};
+
 /**
  * Response TON Connect UI version.
  */
@@ -629,7 +674,7 @@ export declare type ResponseVersionEvent = {
 /**
  * User action events.
  */
-export declare type SdkActionEvent = VersionEvent | ConnectionEvent | ConnectionRestoringEvent | DisconnectionEvent | TransactionSigningEvent;
+export declare type SdkActionEvent = VersionEvent | ConnectionEvent | ConnectionRestoringEvent | DisconnectionEvent | TransactionSigningEvent | DataSigningEvent;
 
 export declare enum SEND_TRANSACTION_ERROR_CODES {
     UNKNOWN_ERROR = 0,
@@ -696,10 +741,47 @@ export declare interface SendTransactionResponse {
     boc: string;
 }
 
+export declare enum SIGN_DATA_ERROR_CODES {
+    UNKNOWN_ERROR = 0,
+    BAD_REQUEST_ERROR = 1,
+    UNKNOWN_APP_ERROR = 100,
+    USER_REJECTS_ERROR = 300,
+    METHOD_NOT_SUPPORTED = 400
+}
+
 export declare type SignDataFeature = {
     name: 'SignData';
+    types: SignDataType[];
+};
+
+export declare type SignDataPayload = SignDataPayloadText | SignDataPayloadBinary | SignDataPayloadCell;
+
+export declare type SignDataPayloadBinary = {
+    type: 'binary';
+    bytes: string;
 };
 
+export declare type SignDataPayloadCell = {
+    type: 'cell';
+    schema: string;
+    cell: string;
+};
+
+export declare type SignDataPayloadText = {
+    type: 'text';
+    text: string;
+};
+
+export declare type SignDataResponse = {
+    signature: string;
+    address: string;
+    timestamp: number;
+    domain: string;
+    payload: SignDataPayload;
+};
+
+export declare type SignDataType = 'text' | 'binary' | 'cell';
+
 export declare interface TonAddressItem {
     name: 'ton_addr';
 }
@@ -804,6 +886,10 @@ declare class TonConnect implements ITonConnect {
     }): Promise<SendTransactionResponse>;
     /** @deprecated use sendTransaction(transaction, options) instead */
     sendTransaction(transaction: SendTransactionRequest, onRequestSent?: () => void): Promise<SendTransactionResponse>;
+    signData(data: SignDataPayload, options?: {
+        onRequestSent?: () => void;
+        signal?: AbortSignal;
+    }): Promise<SignDataResponse>;
     /**
      * Disconnect form thw connected wallet and drop current session.
      */
@@ -1220,8 +1306,21 @@ export declare class WalletNotInjectedError extends TonConnectError {
  * Thrown when wallet doesn't support requested feature method.
  */
 export declare class WalletNotSupportFeatureError extends TonConnectError {
+    cause: {
+        requiredFeature: {
+            featureName: FeatureName;
+            value?: RequiredFeatures['sendTransaction'] | RequiredFeatures['signData'];
+        };
+    };
     protected get info(): string;
-    constructor(...args: ConstructorParameters<typeof TonConnectError>);
+    constructor(message: string, options: {
+        cause: {
+            requiredFeature: {
+                featureName: FeatureName;
+                value?: RequiredFeatures['sendTransaction'] | RequiredFeatures['signData'];
+            };
+        };
+    });
 }
 
 export declare class WalletsListManager {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tonconnect/sdk",
-  "version": "3.1.0",
+  "version": "3.2.0-beta.0",
   "scripts": {
     "build": "npx rimraf types-dist && npx rimraf lib && npx rollup -c rollup.config.mjs && ttsc --project tsconfig.declarations.json && api-extractor run && npx rimraf types-dist && npx rimraf dist && npx webpack --config webpack.config.js",
     "test": "vitest run"
@@ -26,7 +26,7 @@
   "dependencies": {
     "@tonconnect/isomorphic-eventsource": "^0.0.2",
     "@tonconnect/isomorphic-fetch": "^0.0.3",
-    "@tonconnect/protocol": "^2.2.7"
+    "@tonconnect/protocol": "^2.3.0-beta.0"
   },
   "files": [
     "lib",