Merge pull request #3 from grindery-io/egor/wallet-address

Add getUserWalletAddress  SDK method

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Grindery Wallet SDK Changelog
 
+## v0.4.0 (2024-07-05)
+
+### Features
+
+- Added `getUserWalletAddress` SDK method, allowing to silently exchange Telegram user ID to EVM wallet address
+
 ## v0.3.0 (2024-06-18)
 
 ### Added support for BNB and opBNB chains

README.md

@@ -21,6 +21,7 @@ The SDK enables your dapp to provide a seamless user experience for Grindery use
 - [Basic usage](#basic-usage)
   - [Server connection](#server-connection)
   - [Wallet connection](#wallet-connection)
+  - [Silently getting wallet address](#silently-getting-wallet-address)
   - [Sending transactions](#sending-transactions)
   - [Signing](#signing)
   - [Chain switching](#chain-switching)
@@ -172,6 +173,31 @@ WalletSDK.on('disconnect',  => {
 WalletSDK.disconnect();
 ```
 
+## Silently getting wallet address
+
+The SDK allows dApps to exchange Telegram user ID to user's EVM wallet address.
+
+The method doesn't require user to go through the [wallet connection process](#wallet-connection), and can be executed silently in the background. However, without fully connected wallet a dApp has read-only access, and can't request message signing or transactions sending. To do this ask user to connect the wallet first.
+
+```typescript
+WalletSDK.on('connect', async () => {
+  const userId = '123456';
+  const telegramUserWallet =
+    await window.Grindery.WalletSDK.getUserWalletAddress(userId);
+});
+```
+
+This can be especially usefull for Telegram mini-apps, where user ID can be detected automatically. For example:
+
+```typescript
+WalletSDK.on('connect', async () => {
+  const telegramUserWallet =
+    await window.Grindery.WalletSDK.getUserWalletAddress(
+      window.Telegram?.WebApp?.initDataUnsafe?.user?.id
+    );
+});
+```
+
 ## Sending transactions
 
 To request transaction sending use [`sendTransaction()`](https://grindery-io.github.io/grindery-wallet-sdk/classes/classes_WalletSDK.WalletSDK.html#sendTransaction) method, once the wallet is connected:

dist/classes/Rpc.d.ts

@@ -6,7 +6,8 @@ export declare enum RpcMethodNames {
     waitForPairingResult = "waitForPairingResult",
     request = "request",
     waitForRequestResult = "waitForRequestResult",
-    'disconnect' = "disconnect"
+    'disconnect' = "disconnect",
+    getUserWalletAddress = "getUserWalletAddress"
 }
 /**
  * @summary The Grindery RPC API request results
@@ -53,6 +54,10 @@ export declare namespace RpcRequestResults {
      * @summary `disconnect` method result
      */
     type disconnect = boolean;
+    /**
+     * @summary `getUserWalletAddress` method result
+     */
+    type getUserWalletAddress = string;
 }
 /**
  * @summary The Grindery RPC API wrapper class

dist/classes/WalletSDK.d.ts

@@ -1,5 +1,6 @@
 import { ProviderEventName } from './EventEmitter';
 import { Provider } from './Provider';
+import { RpcRequestResults } from './Rpc';
 export type WalletSDKConfig = {
     appId?: string;
 };
@@ -81,6 +82,14 @@ export declare class WalletSDK {
      * @returns {string} Returns chain id in CAIP-2 format
      */
     getChain(): string;
+    /**
+     * @summary Exchange Telegram user ID to Grindery Wallet address
+     * @public
+     * @since 0.4.0
+     * @param {string} userId Telegram user ID
+     * @returns {Promise<string>} Grindery Wallet address
+     */
+    getUserWalletAddress(userId: string): Promise<RpcRequestResults.getUserWalletAddress>;
     /**
      * @summary Adds a listener to the event
      * @public