Merge pull request #6295 from BitGo/COIN-4495

feat(sdk-coin-near): added storage deposit amount to token config

Author: ravibitgo

modules/sdk-coin-near/src/nep141Token.ts

@@ -43,6 +43,10 @@ export class Nep141Token extends Near {
     return this.tokenConfig.decimalPlaces;
   }
 
+  get storageDepositAmount(): string {
+    return this.tokenConfig.storageDepositAmount;
+  }
+
   getChain(): string {
     return this.tokenConfig.type;
   }

modules/statics/src/account.ts

@@ -143,6 +143,7 @@ export interface Sip10TokenConstructorOptions extends AccountConstructorOptions
 
 export interface Nep141TokenConstructorOptions extends AccountConstructorOptions {
   contractAddress: string;
+  storageDepositAmount: string;
 }
 
 export interface ContractAddress extends String {
@@ -591,12 +592,14 @@ export class Sip10Token extends AccountCoinToken {
  */
 export class Nep141Token extends AccountCoinToken {
   public contractAddress: string;
+  public storageDepositAmount: string;
   constructor(options: Nep141TokenConstructorOptions) {
     super({
       ...options,
     });
 
     this.contractAddress = options.contractAddress;
+    this.storageDepositAmount = options.storageDepositAmount;
   }
 }
 
@@ -2928,6 +2931,7 @@ export function tsip10Token(
  * @param fullName Complete human-readable name of the token
  * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
  * @param contractAddress Contract address of this token
+ * @param storageDepositAmount the deposit amount needed to get registered with this contract
  * @param asset Asset which this coin represents. This is the same for both mainnet and testnet variants of a coin.
  * @param features Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
  * @param prefix Optional token prefix. Defaults to empty string
@@ -2941,6 +2945,7 @@ export function nep141Token(
   fullName: string,
   decimalPlaces: number,
   contractAddress: string,
+  storageDepositAmount: string,
   asset: UnderlyingAsset,
   features: CoinFeature[] = AccountCoin.DEFAULT_FEATURES,
   prefix = '',
@@ -2956,6 +2961,7 @@ export function nep141Token(
       network,
       decimalPlaces,
       contractAddress,
+      storageDepositAmount,
       prefix,
       suffix,
       features,
@@ -2975,6 +2981,7 @@ export function nep141Token(
  * @param fullName Complete human-readable name of the token
  * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
  * @param contractAddress Contract address of this token
+ * @param storageDepositAmount the deposit amount needed to get registered with this contract
  * @param asset Asset which this coin represents. This is the same for both mainnet and testnet variants of a coin.
  * @param features Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
  * @param prefix Optional token prefix. Defaults to empty string
@@ -2987,11 +2994,24 @@ export function tnep141Token(
   fullName: string,
   decimalPlaces: number,
   contractAddress: string,
+  storageDepositAmount: string,
   asset: UnderlyingAsset,
   features: CoinFeature[] = AccountCoin.DEFAULT_FEATURES,
   prefix = '',
   suffix: string = name.toUpperCase(),
   network: AccountNetwork = Networks.test.near
 ) {
-  return nep141Token(id, name, fullName, decimalPlaces, contractAddress, asset, features, prefix, suffix, network);
+  return nep141Token(
+    id,
+    name,
+    fullName,
+    decimalPlaces,
+    contractAddress,
+    storageDepositAmount,
+    asset,
+    features,
+    prefix,
+    suffix,
+    network
+  );
 }

modules/statics/src/coins/nep141Tokens.ts

@@ -9,6 +9,7 @@ export const nep141Tokens = [
     'USD Coin',
     6,
     '17208628f84f5d6ad33f0da3bbbeb27ffcb398eac501a31bd6ad2011e36133a1',
+    '1250000000000000000000',
     UnderlyingAsset['near:usdc'],
     NEAR_TOKEN_FEATURES
   ),
@@ -18,6 +19,7 @@ export const nep141Tokens = [
     'Tether USD',
     6,
     'usdt.tether-token.near',
+    '1250000000000000000000',
     UnderlyingAsset['near:usdt'],
     NEAR_TOKEN_FEATURES
   ),
@@ -28,6 +30,7 @@ export const nep141Tokens = [
     'Test NEP141 Token 24 Decimals',
     24,
     'ft-tnep24dp.testnet',
+    '1250000000000000000000',
     UnderlyingAsset['tnear:tnep24dp'],
     NEAR_TOKEN_FEATURES
   ),

modules/statics/src/tokenConfig.ts

@@ -109,6 +109,7 @@ export type Sip10TokenConfig = BaseNetworkConfig & {
 
 export type Nep141TokenConfig = BaseNetworkConfig & {
   contractAddress: string;
+  storageDepositAmount: string;
 };
 
 export type TokenConfig =
@@ -809,6 +810,7 @@ function getNep141TokenConfig(coin: Nep141Token): Nep141TokenConfig {
     network: coin.network.type === NetworkType.MAINNET ? 'Mainnet' : 'Testnet',
     name: coin.fullName,
     contractAddress: coin.contractAddress,
+    storageDepositAmount: coin.storageDepositAmount,
     decimalPlaces: coin.decimalPlaces,
   };
 }