feat: support BN params, return BN instead of strings and signers rework

Author: matusbalascak

README.md

@@ -52,8 +52,6 @@ import { Gasp } from 'gasp-sdk';
 
 const sdk = await Gasp.create('wss://rollup-prod-rpc.gasp.xyz/', {
     debug: true,
-    // Optionally, pass a signer so it's not required in every call
-    signer,
     // Optionally, pass a custom logger instance if needed
     logger,
 }).catch((e) => {
@@ -65,20 +63,19 @@ const sdk = await Gasp.create('wss://rollup-prod-rpc.gasp.xyz/', {
 
 #### Signer
 
-The SDK allows you to pass a signer instance during initialization. This is useful if you want to avoid passing the signer for every call. The signer should implement the necessary methods for signing transactions.
+The SDK allows you to pass a signer instance after the initialization. This is useful if you want to avoid passing the signer for every call. The signer should implement the necessary methods for signing transactions.
 
 To use signer provided by the SDK, you can initialize it as follows:
 
 ```ts
 import { Gasp } from 'gasp-sdk';
 
 const pk = '...';
-const signer = Gasp.defaultSigner.create(pk);
-
-const sdk = await Gasp.create('...', { signer });
+const sdk = await Gasp.create('wss://rollup-prod-rpc.gasp.xyz/');
+sdk.setSigner(sdk.signers.ethers.create(pk))
 ```
 
-In case you want to use your own signer, you can implement the `Signer` interface and pass it to the SDK. Example implementation can be found [here](./packages/sdk/src/modules/core/EthersSigner.ts).
+In case you want to use your own signer, you can implement the `Signer` interface and pass it to the SDK. Example implementation can be found [here](./packages/sdk/src/modules/signer/EthersSigner.ts).
 
 #### Logger
 
@@ -130,9 +127,9 @@ The Pool module enables operations related to liquidity pools
 ```ts
 import { Gasp, PoolType } from 'gasp-sdk';
 
-const sdk = await Gasp.create('wss://rollup-prod-rpc.gasp.xyz/', {
-    signer: Gasp.defaultSigner.create('...'),
-});
+const sdk = await Gasp.create('wss://rollup-prod-rpc.gasp.xyz/');
+
+sdk.setSigner(sdk.signers.ethers.create('...'));
 
 // Retrieve pools information
 const pools = await sdk.pool.getPools();
@@ -166,7 +163,7 @@ import { Gasp, PoolType } from 'gasp-sdk';
 
 const sdk = await Gasp.create('wss://rollup-prod-rpc.gasp.xyz/');
 
-const signer = Gasp.defaultSigner.create('...');
+const signer = sdk.signers.ethers.create('...');
 
 // Create a new pool
 const result = await sdk.rewards

packages/sdk/README.md

@@ -52,8 +52,6 @@ import { Gasp } from 'gasp-sdk';
 
 const sdk = await Gasp.create('wss://rollup-prod-rpc.gasp.xyz/', {
     debug: true,
-    // Optionally, pass a signer so it's not required in every call
-    signer,
     // Optionally, pass a custom logger instance if needed
     logger,
 }).catch((e) => {
@@ -65,20 +63,19 @@ const sdk = await Gasp.create('wss://rollup-prod-rpc.gasp.xyz/', {
 
 #### Signer
 
-The SDK allows you to pass a signer instance during initialization. This is useful if you want to avoid passing the signer for every call. The signer should implement the necessary methods for signing transactions.
+The SDK allows you to pass a signer instance after the initialization. This is useful if you want to avoid passing the signer for every call. The signer should implement the necessary methods for signing transactions.
 
 To use signer provided by the SDK, you can initialize it as follows:
 
 ```ts
 import { Gasp } from 'gasp-sdk';
 
 const pk = '...';
-const signer = Gasp.defaultSigner.create(pk);
-
-const sdk = await Gasp.create('...', { signer });
+const sdk = await Gasp.create('wss://rollup-prod-rpc.gasp.xyz/');
+sdk.setSigner(sdk.signers.ethers.create(pk));
 ```
 
-In case you want to use your own signer, you can implement the `Signer` interface and pass it to the SDK. Example implementation can be found [here](./src/modules/core/EthersSigner.ts).
+In case you want to use your own signer, you can implement the `Signer` interface and pass it to the SDK. Example implementation can be found [here](./src/modules/signer/EthersSigner.ts).
 
 #### Logger
 
@@ -130,9 +127,9 @@ The Pool module enables operations related to liquidity pools
 ```ts
 import { Gasp, PoolType } from 'gasp-sdk';
 
-const sdk = await Gasp.create('wss://rollup-prod-rpc.gasp.xyz/', {
-    signer: Gasp.defaultSigner.create('...'),
-});
+const sdk = await Gasp.create('wss://rollup-prod-rpc.gasp.xyz/');
+
+sdk.setSigner(sdk.signers.ethers.create('...'));
 
 // Retrieve pools information
 const pools = await sdk.pool.getPools();
@@ -166,7 +163,7 @@ import { Gasp, PoolType } from 'gasp-sdk';
 
 const sdk = await Gasp.create('wss://rollup-prod-rpc.gasp.xyz/');
 
-const signer = Gasp.defaultSigner.create('...');
+const signer = sdk.signers.ethers.create('...');
 
 // Create a new pool
 const result = await sdk.rewards

packages/sdk/package.json

@@ -22,6 +22,7 @@
   "dependencies": {
     "@polkadot/api": "11.1.1",
     "big.js": "6.2.1",
+    "bn.js": "^5.2.1",
     "ethers": "^6.13.5",
     "gasp-type-definitions": "0.0.2-feat-new-chains-integration-GASP-2054.8",
     "gasp-types": "0.0.2-feat-new-chains-integration-GASP-2054.8",
@@ -40,5 +41,8 @@
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
-  "private": false
+  "private": false,
+  "optionalDependencies": {
+    "@wagmi/core": "^2.16.7"
+  }
 }

packages/sdk/src/instance.ts

@@ -8,13 +8,12 @@ import { RewardsModule } from './modules/rewards/Rewards';
 import { RolldownModule } from './modules/rolldown/Rolldown';
 import { Signer } from './types/common';
 import { GaspLogger, Logger, emptyLogger } from './modules/core/Logger';
-import { TxModule } from './modules/core/TxModule';
-import { EthersSigner } from './modules/core/EthersSigner';
+import { TxModule } from './modules/tx/TxModule';
 import { GaspError } from './error/GaspError';
+import { SignerModule } from './modules/signer/Signer';
 
 interface SDKConfig {
   debug?: boolean;
-  signer?: Signer;
   logger?: Logger;
 }
 
@@ -27,12 +26,13 @@ export class Gasp {
   public readonly rolldown: RolldownModule;
 
   public readonly tx: TxModule;
+  public readonly signers: SignerModule;
 
   public readonly api: ApiPromise;
 
-  static readonly defaultSigner = EthersSigner;
+  public signer?: Signer;
 
-  constructor(api: ApiPromise, logger: Logger, readonly signer?: Signer) {
+  private constructor(api: ApiPromise, logger: Logger) {
     this.pool = new PoolModule(this, api, logger);
     this.account = new AccountModule(this, api, logger);
     this.asset = new AssetModule(this, api, logger);
@@ -41,10 +41,15 @@ export class Gasp {
     this.rolldown = new RolldownModule(this, api, logger);
 
     this.tx = new TxModule(this, api, logger);
+    this.signers = new SignerModule(this, api, logger);
 
     this.api = api;
   }
 
+  setSigner(signer: Signer) {
+    this.signer = signer;
+  }
+
   static async create(_urls: string[] | string, config?: SDKConfig) {
     const urls = Array.isArray(_urls) ? _urls : [_urls];
 
@@ -60,6 +65,6 @@ export class Gasp {
       ? config?.logger ?? new GaspLogger()
       : emptyLogger;
 
-    return new Gasp(api, logger, config?.signer);
+    return new Gasp(api, logger);
   }
 }

packages/sdk/src/modules/account/getAssetBalance.ts

@@ -1,6 +1,7 @@
 import { GaspError } from '../../error/GaspError';
 import { Balance } from './types';
 import { ModuleContext } from '../core/BaseModule';
+import { BN } from 'bn.js';
 
 export interface GetAssetBalanceParams {
   account: string;
@@ -22,9 +23,9 @@ export const getAssetBalance = async (
   return {
     asset,
     balance: {
-      free: res.free.toString(),
-      reserved: res.reserved.toString(),
-      frozen: res.frozen.toString(),
+      free: new BN(res.free),
+      reserved: new BN(res.reserved),
+      frozen: new BN(res.frozen),
     },
   };
 };

packages/sdk/src/modules/account/getBalances.ts

@@ -1,6 +1,7 @@
 import { Balance } from './types';
 import { ModuleContext } from '../core/BaseModule';
 import { GaspError } from '../../error/GaspError';
+import BN from 'bn.js';
 
 export interface GetBalancesParams {
   account: string;
@@ -22,9 +23,9 @@ export const getBalances = async (
     return {
       asset: key.args[1].toString(),
       balance: {
-        free: value.free.toString(),
-        reserved: value.reserved.toString(),
-        frozen: value.frozen.toString(),
+        free: new BN(value.free),
+        reserved: new BN(value.reserved),
+        frozen: new BN(value.frozen),
       },
     };
   });

packages/sdk/src/modules/account/types.ts

@@ -1,8 +1,10 @@
+import BN from 'bn.js';
+
 export interface Balance {
   asset: string;
   balance: {
-    free: string;
-    reserved: string;
-    frozen: string;
+    free: BN;
+    reserved: BN;
+    frozen: BN;
   };
 }

packages/sdk/src/modules/asset/Asset.ts

@@ -86,7 +86,12 @@ export class AssetModule extends BaseModule {
    * console.log(result);
    *  ```
    */
-  transfer(params: TransferParams, signer: Signer) {
-    return transfer(this.context, params, signer, this.submitTx);
+  transfer(params: TransferParams, signer?: Signer) {
+    return transfer(
+      this.context,
+      params,
+      this.getSigner(signer),
+      this.submitTx
+    );
   }
 }

packages/sdk/src/modules/asset/getIssuance.ts

@@ -1,5 +1,6 @@
 import { GaspError } from '../../error/GaspError';
 import { ModuleContext } from '../core/BaseModule';
+import BN from 'bn.js';
 
 export interface GetIssuanceParams {
   asset: string;
@@ -8,7 +9,7 @@ export interface GetIssuanceParams {
 export const getIssuance = async (
   { api }: ModuleContext,
   { asset }: GetIssuanceParams
-): Promise<string> => {
+): Promise<BN> => {
   const issuance = await api.query.tokens.totalIssuance(asset).catch((e) => {
     throw new GaspError(
       'Unable to fetch asset metadata',
@@ -17,5 +18,5 @@ export const getIssuance = async (
     );
   });
 
-  return issuance.toString();
+  return new BN(issuance);
 };

packages/sdk/src/modules/asset/transfer.ts

@@ -5,19 +5,20 @@ import {
   SubmitHandler,
   SubmittableTx,
 } from '../core/BaseModule';
+import BN from 'bn.js';
 
 export interface TransferParams {
   sender: string;
   recipient: string;
   asset: string;
-  amount: string;
+  amount: BN | string;
 }
 
 export interface TransferResult extends FeeMetadata {
   asset: string;
   from: string;
   to: string;
-  amount: string;
+  amount: BN;
 }
 
 export const transfer = (
@@ -36,7 +37,7 @@ export const transfer = (
       asset: data.currencyId.toString(),
       from: data.from.toString(),
       to: data.to.toString(),
-      amount: data.amount.toString(),
+      amount: new BN(data.amount),
     }),
     eventType: api.events.tokens.Transfer,
   });