Merge pull request #7 from grindery-io/egor/user-methods

Add Wallet API methods

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Grindery Wallet SDK Changelog
 
+## v0.5.0 (2024-09-27)
+
+### Added
+
+- [`WalletAPI` class](https://grindery-io.github.io/grindery-wallet-sdk/classes/classes_WalletAPI.WalletAPI.html), a simple wrapper for Grindery Wallet API
+- [`getUser` SDK method](https://github.com/grindery-io/grindery-wallet-sdk#getting-user-information), allowing to get information about connected Grindery user
+
+### Fixed
+
+- Pairing redirect [issue](https://github.com/grindery-io/grindery-wallet-sdk/issues/8) when SDK used in the Telegram Mini App
+
 ## v0.4.2 (2024-08-03)
 
 - Added client events tracking

README.md

@@ -25,6 +25,7 @@ The SDK enables your dapp to provide a seamless user experience for Grindery use
   - [Sending transactions](#sending-transactions)
   - [Signing](#signing)
   - [Chain switching](#chain-switching)
+  - [Getting user information](#getting-user-information)
 - [Advanced usage](#advanced-usage)
   - [Full documentation](#full-documentation)
   - [Injected Ethereum Provider](#injected-ethereum-provider)
@@ -239,6 +240,16 @@ WalletSDK.on('accountsChanged', () => {
 });
 ```
 
+## Getting user information
+
+To get information about connected Grindery Wallet User use [`getUser()`](https://grindery-io.github.io/grindery-wallet-sdk/classes/classes_WalletSDK.WalletSDK.html#getUser) method, once the wallet is connected:
+
+```typescript
+WalletSDK.on('accountsChanged', async () => {
+  console.log('user', await WalletSDK.getUser());
+});
+```
+
 # Advanced usage
 
 ## Full documentation

dist/classes/WalletAPI.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @summary The Grindery Wallet API wrapper class
+ * @since 0.5.0
+ */
+export declare class WalletAPI {
+    /**
+     * @summary Sends a request to the Grindery Wallet API
+     * @public
+     * @param {string} method JSON-RPC method name
+     * @param {object} params JSON-RPC method parameters, optional
+     * @returns {T} The result of the API request
+     */
+    sendApiRequest<T>(method: string, params?: object): Promise<T>;
+}

dist/classes/WalletSDK.d.ts

@@ -1,6 +1,7 @@
 import { ProviderEventName } from './EventEmitter';
 import { Provider } from './Provider';
 import { RpcRequestResults } from './Rpc';
+import { User } from '../utils/user';
 export type WalletSDKConfig = {
     appId?: string;
     appUrl?: string;
@@ -107,11 +108,23 @@ export declare class WalletSDK {
      * @returns {EventEmitter} The instance of the class itself
      */
     removeListener(event: ProviderEventName, callback: Function): this;
+    /**
+     * @summary Gets the Grindery user information
+     * @public
+     * @since 0.5.0
+     * @returns {Promise<User>} The Grindery user information
+     */
+    getUser(): Promise<User>;
     /**
      * @summary SdkStorage class instance
      * @private
      */
     private storage;
+    /**
+     * @summary The Grindery Wallet user
+     * @private
+     */
+    private user;
     /**
      * @summary Gets the Grindery Wallet ethereum provider
      * @returns {Provider} The Grindery Wallet ethereum provider