@bitgo-beta/statics 10.0.1-alpha.4 → 10.0.1-alpha.41

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/CHANGELOG.md +118 -0
  2. package/dist/src/account.d.ts +132 -32
  3. package/dist/src/account.d.ts.map +1 -1
  4. package/dist/src/account.js +212 -51
  5. package/dist/src/ada.d.ts +3 -1
  6. package/dist/src/ada.d.ts.map +1 -1
  7. package/dist/src/ada.js +5 -2
  8. package/dist/src/avaxp.d.ts +3 -1
  9. package/dist/src/avaxp.d.ts.map +1 -1
  10. package/dist/src/avaxp.js +9 -3
  11. package/dist/src/base.d.ts +264 -7
  12. package/dist/src/base.d.ts.map +1 -1
  13. package/dist/src/base.js +307 -8
  14. package/dist/src/coins.d.ts +1 -0
  15. package/dist/src/coins.d.ts.map +1 -1
  16. package/dist/src/coins.js +1375 -996
  17. package/dist/src/constants.d.ts +2 -0
  18. package/dist/src/constants.d.ts.map +1 -0
  19. package/dist/src/constants.js +5 -0
  20. package/dist/src/errors.d.ts +6 -0
  21. package/dist/src/errors.d.ts.map +1 -1
  22. package/dist/src/errors.js +16 -2
  23. package/dist/src/index.d.ts +1 -1
  24. package/dist/src/index.d.ts.map +1 -1
  25. package/dist/src/index.js +3 -2
  26. package/dist/src/map.d.ts +1 -0
  27. package/dist/src/map.d.ts.map +1 -1
  28. package/dist/src/map.js +8 -3
  29. package/dist/src/networks.d.ts +14 -0
  30. package/dist/src/networks.d.ts.map +1 -1
  31. package/dist/src/networks.js +29 -10
  32. package/dist/src/ofc.d.ts +111 -4
  33. package/dist/src/ofc.d.ts.map +1 -1
  34. package/dist/src/ofc.js +225 -6
  35. package/dist/src/tokenConfig.d.ts +18 -0
  36. package/dist/src/tokenConfig.d.ts.map +1 -1
  37. package/dist/src/tokenConfig.js +41 -1
  38. package/dist/src/utxo.d.ts +3 -1
  39. package/dist/src/utxo.d.ts.map +1 -1
  40. package/dist/src/utxo.js +5 -2
  41. package/dist/tsconfig.tsbuildinfo +453 -426
  42. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -3,6 +3,124 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # [14.4.0](https://github.com/BitGo/BitGoJS/compare/@bitgo/statics@14.3.0...@bitgo/statics@14.4.0) (2023-02-17)
7
+
8
+ ### Features
9
+
10
+ - **statics:** add ofc erc20 tokens ([d05e69f](https://github.com/BitGo/BitGoJS/commit/d05e69fb6d47dc629286b2815ecd9435e3854db0))
11
+ - **statics:** enable getting asset by id ([b96fbaf](https://github.com/BitGo/BitGoJS/commit/b96fbaf36f676400ed2ec2fa66d2a3931aabdf42))
12
+
13
+ # [14.3.0](https://github.com/BitGo/BitGoJS/compare/@bitgo/statics@14.0.0...@bitgo/statics@14.3.0) (2023-02-16)
14
+
15
+ ### Features
16
+
17
+ - **statics:** add a unique id to every asset ([f96e4d3](https://github.com/BitGo/BitGoJS/commit/f96e4d3bb5515ca52a78387c5c75811abd39c802))
18
+ - **statics:** add custody coin features for avaxc ([d67a9d9](https://github.com/BitGo/BitGoJS/commit/d67a9d932f30d48853ad7e4c20388b60ae269529))
19
+ - **statics:** add ofc algorand usdc token ([9450360](https://github.com/BitGo/BitGoJS/commit/9450360e828253ee633acaae8cc0ec57d386a7dc))
20
+ - **statics:** add ofc hedera usdc token ([67f1c5d](https://github.com/BitGo/BitGoJS/commit/67f1c5da5b92f228e02451071bacdcbe482c06fd))
21
+
22
+ # [14.2.0](https://github.com/BitGo/BitGoJS/compare/@bitgo/statics@14.0.0...@bitgo/statics@14.2.0) (2023-02-08)
23
+
24
+ ### Features
25
+
26
+ - **statics:** add custody coin features for avaxc ([d67a9d9](https://github.com/BitGo/BitGoJS/commit/d67a9d932f30d48853ad7e4c20388b60ae269529))
27
+ - **statics:** add ofc algorand usdc token ([9450360](https://github.com/BitGo/BitGoJS/commit/9450360e828253ee633acaae8cc0ec57d386a7dc))
28
+
29
+ # [14.1.0](https://github.com/BitGo/BitGoJS/compare/@bitgo/statics@14.0.0...@bitgo/statics@14.1.0) (2023-01-30)
30
+
31
+ ### Features
32
+
33
+ - **statics:** add ofc algorand usdc token ([9450360](https://github.com/BitGo/BitGoJS/commit/9450360e828253ee633acaae8cc0ec57d386a7dc))
34
+
35
+ # [14.0.0](https://github.com/BitGo/BitGoJS/compare/@bitgo/statics@13.1.0...@bitgo/statics@14.0.0) (2023-01-25)
36
+
37
+ ### Bug Fixes
38
+
39
+ - **statics:** fix mismatched erc20 token config ([8875873](https://github.com/BitGo/BitGoJS/commit/8875873aaf5a7dbc8b2117c5ea29ac0141c9310b))
40
+
41
+ - Revert "fix(statics)!: Fix mismatched erc20 token config" ([b84b273](https://github.com/BitGo/BitGoJS/commit/b84b273a1d9cdd5140c05299bb2416d46806454c))
42
+
43
+ ### Features
44
+
45
+ - **statics:** add ATOM coin config ([c3a5282](https://github.com/BitGo/BitGoJS/commit/c3a52823f7a2750ebf3e5c2e0f35925d09704087))
46
+ - **statics:** add EVM_WALLET coin feature ([c31332c](https://github.com/BitGo/BitGoJS/commit/c31332c5ee085fafca47dcd47b0c10c108cb9686))
47
+ - **statics:** add new batch of tokens ([19b584d](https://github.com/BitGo/BitGoJS/commit/19b584ddf90d38aad5ff30e867f1c83ea462d930))
48
+ - **statics:** add new coin features for custody ([59a7fde](https://github.com/BitGo/BitGoJS/commit/59a7fde734af0fdb863f6b730cd0702e7c863615))
49
+ - **statics:** add ofc stellar usdc token ([2c2735d](https://github.com/BitGo/BitGoJS/commit/2c2735d602c09cbbbeda78ef27a050ca08d3dc42))
50
+
51
+ ### BREAKING CHANGES
52
+
53
+ - changes existing config for TUSD and REEF
54
+ - **statics:** changes existing config for TUSD and REEF
55
+
56
+ # [13.1.0](https://github.com/BitGo/BitGoJS/compare/@bitgo/statics@13.0.0...@bitgo/statics@13.1.0) (2022-12-23)
57
+
58
+ ### Features
59
+
60
+ - **sdk-coin-trx:** export TronErc20Coin class ([0528cb0](https://github.com/BitGo/BitGoJS/commit/0528cb0939047b5fd38a8a3baa494bafba76d0ed))
61
+
62
+ # [13.0.0](https://github.com/BitGo/BitGoJS/compare/@bitgo/statics@12.1.1...@bitgo/statics@13.0.0) (2022-12-20)
63
+
64
+ ### Bug Fixes
65
+
66
+ - **sdk-coin-trx:** fix tron tokens in statics ([79459c9](https://github.com/BitGo/BitGoJS/commit/79459c982e07d7ec6b9e720b0ad325a00ed59e8f))
67
+ - **statics:** add missing backing erc20 for fil ([8bea5bf](https://github.com/BitGo/BitGoJS/commit/8bea5bf02b51856e6c65ce55cca657c7246f1562))
68
+
69
+ ### BREAKING CHANGES
70
+
71
+ - **sdk-coin-trx:** TrxCoin & factory methods removed from statics due to existing class TronErc20Coin
72
+
73
+ ## [12.1.1](https://github.com/BitGo/BitGoJS/compare/@bitgo/statics@12.1.0...@bitgo/statics@12.1.1) (2022-12-09)
74
+
75
+ **Note:** Version bump only for package @bitgo/statics
76
+
77
+ # [12.1.0](https://github.com/BitGo/BitGoJS/compare/@bitgo/statics@12.0.0...@bitgo/statics@12.1.0) (2022-12-01)
78
+
79
+ ### Features
80
+
81
+ - **statics:** add TSS feature flag to ETH ([9226ca9](https://github.com/BitGo/BitGoJS/commit/9226ca9ebf23b2171bffaf05b5090d8189110d56))
82
+
83
+ # [12.0.0](https://github.com/BitGo/BitGoJS/compare/@bitgo/statics@8.2.0...@bitgo/statics@12.0.0) (2022-11-29)
84
+
85
+ ### Bug Fixes
86
+
87
+ - fix typo in Everscale, add Everscale as Offchain / Prime token ([21bf769](https://github.com/BitGo/BitGoJS/commit/21bf769fa6e2165797d3d9562955b7bd371ad0e6))
88
+ - **statics:** change cardano testnet url to preprod testnet ([6bc09c4](https://github.com/BitGo/BitGoJS/commit/6bc09c4c2306d792e1ed522c3e828a34597c842d))
89
+ - update explorer url for test mysten ([3d21e88](https://github.com/BitGo/BitGoJS/commit/3d21e885e5883e3cf8259a1142ef4a31de1408a9))
90
+ - update XLM USD token name ([62c8d37](https://github.com/BitGo/BitGoJS/commit/62c8d37bb52620f11d3ff5a7cc73f7a9cca07ffe))
91
+
92
+ ### Features
93
+
94
+ - add new erc20s and sol tokens ([354a429](https://github.com/BitGo/BitGoJS/commit/354a4296c682f6d3a787309ddb7d196b1cbf9e11))
95
+ - add tokens to trading ([8105e05](https://github.com/BitGo/BitGoJS/commit/8105e052bbdf914bcd749c87bd78e5db4e1bf4ce))
96
+ - onboard new sol tokens ([0ada8c4](https://github.com/BitGo/BitGoJS/commit/0ada8c4caa1e97b6f46557af3676c32ea531b55d))
97
+ - **sdk-coin-dot:** add support for staking transactions ([b67eaa0](https://github.com/BitGo/BitGoJS/commit/b67eaa06723b1a235cb2c6f948ece34cc42a9256))
98
+ - **sdk-coin-trx:** add tron token skeleton ([03198b0](https://github.com/BitGo/BitGoJS/commit/03198b0e23e6c87ce2d34d08973abca301f88252))
99
+ - **statics:** add base unit for coins ([b2950e9](https://github.com/BitGo/BitGoJS/commit/b2950e9f5fd71d1f8e29189fd1fa5193c4afc76f))
100
+ - **statics:** add erc20 tokens to ofc support ([7ac56af](https://github.com/BitGo/BitGoJS/commit/7ac56af6b842e81d3c0bc0ee80889efcd4dc8385))
101
+ - **statics:** add ofc coins for dogecoin ([8052caf](https://github.com/BitGo/BitGoJS/commit/8052caf2ab7aeff9610d59473efe1859678870ca))
102
+ - **statics:** add polygon tokens ([ea32562](https://github.com/BitGo/BitGoJS/commit/ea32562ed4ae553418a8e75eb2e63a47415e047e))
103
+ - **statics:** add SOLEND (SLND) Solana token to statics ([e39edb4](https://github.com/BitGo/BitGoJS/commit/e39edb4fcb6694bf9b75710d4434e7a0d35f0d62))
104
+ - **statics:** add twdoge ([bc7a68a](https://github.com/BitGo/BitGoJS/commit/bc7a68aac9eb1a41b59c0eccff0412bbd9d3cfa0))
105
+ - **statics:** add wdoge ([842a8da](https://github.com/BitGo/BitGoJS/commit/842a8da1bac398606a3b4ee00861885e3a8748d3))
106
+ - **statics:** onboard select erc20 and sol tokens ([640e273](https://github.com/BitGo/BitGoJS/commit/640e273e9c264ea9b515cb6e6123c9ae103e18dd))
107
+ - **statics:** use eCash instead of BitcoinABC in networks ([cf9cdbb](https://github.com/BitGo/BitGoJS/commit/cf9cdbbe76da587ba7c3c8d7d85faa640fac1000))
108
+
109
+ ### BREAKING CHANGES
110
+
111
+ - updated name of XLM USD token
112
+ - **sdk-coin-dot:** Uddate the 'westendMetadataRpc' constant to
113
+ spec version 9320. Update PolkadotTestnet.specVersion to
114
+ 9320 and PolkadotTestnet.txVersion to 14.
115
+ Ticket: BOS-469
116
+ - **statics:** new fields are all required, so needs to be filled in
117
+ Ticket: BG-53493
118
+ - **statics:** Removing Bitcoin ABC terminology because it has
119
+ been rebranded to eCash. Updating its network here so that it's
120
+ consistent with the terms used in other modules.
121
+ - Adds Everscale as Offchain / Prime token
122
+ BG-59397
123
+
6
124
  # [11.0.0](https://github.com/BitGo/BitGoJS/compare/@bitgo/statics@8.2.0...@bitgo/statics@11.0.0) (2022-11-04)
7
125
 
8
126
  ### Bug Fixes
@@ -1,6 +1,7 @@
1
1
  import { BaseCoin, BaseUnit, CoinFeature, KeyCurve, UnderlyingAsset } from './base';
2
2
  import { AccountNetwork, BaseNetwork, EthereumNetwork, TronNetwork } from './networks';
3
3
  export interface AccountConstructorOptions {
4
+ id: string;
4
5
  fullName: string;
5
6
  name: string;
6
7
  alias?: string;
@@ -54,6 +55,11 @@ export interface AdaCoinConstructorOptions extends AccountConstructorOptions {
54
55
  policyId: string;
55
56
  assetName: string;
56
57
  }
58
+ export interface XrpCoinConstructorOptions extends AccountConstructorOptions {
59
+ issuerAddress: string;
60
+ currencyCode: string;
61
+ domain: string;
62
+ }
57
63
  declare type FiatCoinName = `fiat${string}` | `tfiat${string}`;
58
64
  export interface FiatCoinConstructorOptions extends AccountConstructorOptions {
59
65
  name: FiatCoinName;
@@ -205,6 +211,18 @@ export declare class AvaxERC20Token extends ContractAddressDefinedToken {
205
211
  export declare class PolygonERC20Token extends ContractAddressDefinedToken {
206
212
  constructor(options: Erc20ConstructorOptions);
207
213
  }
214
+ /**
215
+ * The Xrp network supports tokens
216
+ * Xrp tokens are identified by their issuer address
217
+ * Naming format is similar to XLM
218
+ * <network>:<token>-<issuer>
219
+ */
220
+ export declare class XrpCoin extends AccountCoinToken {
221
+ issuerAddress: string;
222
+ currencyCode: string;
223
+ domain: string;
224
+ constructor(options: XrpCoinConstructorOptions);
225
+ }
208
226
  /**
209
227
  * Fiat currencies, such as USD, EUR, or YEN.
210
228
  */
@@ -218,6 +236,7 @@ export declare class FiatCoin extends BaseCoin {
218
236
  /**
219
237
  * Factory function for account coin instances.
220
238
  *
239
+ * @param id uuid v4
221
240
  * @param name unique identifier of the coin
222
241
  * @param fullName Complete human-readable name of the coin
223
242
  * @param network Network object for this coin
@@ -229,10 +248,11 @@ export declare class FiatCoin extends BaseCoin {
229
248
  * @param suffix? Optional coin suffix. Defaults to coin name.
230
249
  * @param isToken? Whether or not this account coin is a token of another coin
231
250
  */
232
- export declare function account(name: string, fullName: string, network: AccountNetwork, decimalPlaces: number, asset: UnderlyingAsset, baseUnit: BaseUnit, features?: CoinFeature[], primaryKeyCurve?: KeyCurve, prefix?: string, suffix?: string, isToken?: boolean): Readonly<AccountCoin>;
251
+ export declare function account(id: string, name: string, fullName: string, network: AccountNetwork, decimalPlaces: number, asset: UnderlyingAsset, baseUnit: BaseUnit, features?: CoinFeature[], primaryKeyCurve?: KeyCurve, prefix?: string, suffix?: string, isToken?: boolean): Readonly<AccountCoin>;
233
252
  /**
234
253
  * Factory function for erc20 token instances.
235
254
  *
255
+ * @param id uuid v4
236
256
  * @param name unique identifier of the token
237
257
  * @param fullName Complete human-readable name of the token
238
258
  * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
@@ -244,10 +264,11 @@ export declare function account(name: string, fullName: string, network: Account
244
264
  * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
245
265
  * @param primaryKeyCurve The elliptic curve for this chain/token
246
266
  */
247
- export declare function erc20(name: string, fullName: string, decimalPlaces: number, contractAddress: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: EthereumNetwork, primaryKeyCurve?: KeyCurve): Readonly<Erc20Coin>;
267
+ export declare function erc20(id: string, name: string, fullName: string, decimalPlaces: number, contractAddress: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: EthereumNetwork, primaryKeyCurve?: KeyCurve): Readonly<Erc20Coin>;
248
268
  /**
249
269
  * Factory function for testnet erc20 token instances.
250
270
  *
271
+ * @param id uuid v4
251
272
  * @param name unique identifier of the token
252
273
  * @param fullName Complete human-readable name of the token
253
274
  * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
@@ -258,10 +279,11 @@ export declare function erc20(name: string, fullName: string, decimalPlaces: num
258
279
  * @param network? Optional token network. Defaults to the Kovan test network.
259
280
  * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
260
281
  */
261
- export declare function terc20(name: string, fullName: string, decimalPlaces: number, contractAddress: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: EthereumNetwork): Readonly<Erc20Coin>;
282
+ export declare function terc20(id: string, name: string, fullName: string, decimalPlaces: number, contractAddress: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: EthereumNetwork): Readonly<Erc20Coin>;
262
283
  /**
263
284
  * Factory function for erc721 token instances.
264
285
  *
286
+ * @param id uuid v4
265
287
  * @param name unique identifier of the token
266
288
  * @param fullName Complete human-readable name of the token
267
289
  * @param contractAddress Contract address of this token
@@ -272,10 +294,11 @@ export declare function terc20(name: string, fullName: string, decimalPlaces: nu
272
294
  * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
273
295
  * @param primaryKeyCurve The elliptic curve for this chain/token
274
296
  */
275
- export declare function erc721(name: string, fullName: string, contractAddress: string, features?: CoinFeature[], prefix?: string, suffix?: string, network?: EthereumNetwork, primaryKeyCurve?: KeyCurve): Readonly<Erc721Coin>;
297
+ export declare function erc721(id: string, name: string, fullName: string, contractAddress: string, features?: CoinFeature[], prefix?: string, suffix?: string, network?: EthereumNetwork, primaryKeyCurve?: KeyCurve): Readonly<Erc721Coin>;
276
298
  /**
277
299
  * Factory function for testnet erc721 token instances.
278
300
  *
301
+ * @param id uuid v4
279
302
  * @param name unique identifier of the token
280
303
  * @param fullName Complete human-readable name of the token
281
304
  * @param contractAddress Contract address of this token
@@ -285,10 +308,26 @@ export declare function erc721(name: string, fullName: string, contractAddress:
285
308
  * @param network? Optional token network. Defaults to Goerli test network.
286
309
  * @param primaryKeyCurve The elliptic curve for this chain/token
287
310
  */
288
- export declare function terc721(name: string, fullName: string, contractAddress: string, features?: CoinFeature[], prefix?: string, suffix?: string, network?: EthereumNetwork, primaryKeyCurve?: KeyCurve): Readonly<Erc721Coin>;
311
+ export declare function terc721(id: string, name: string, fullName: string, contractAddress: string, features?: CoinFeature[], prefix?: string, suffix?: string, network?: EthereumNetwork, primaryKeyCurve?: KeyCurve): Readonly<Erc721Coin>;
312
+ /**
313
+ * Factory function for nonstandard token instances.
314
+ *
315
+ * @param id uuid v4
316
+ * @param name unique identifier of the token
317
+ * @param fullName Complete human-readable name of the token
318
+ * @param contractAddress Contract address of this token
319
+ * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
320
+ * @param prefix? Optional token prefix. Defaults to empty string
321
+ * @param suffix? Optional token suffix. Defaults to token name.
322
+ * @param network? Optional token network. Defaults to Ethereum main network.
323
+ * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
324
+ * @param primaryKeyCurve The elliptic curve for this chain/token
325
+ */
326
+ export declare function nonstandardToken(id: string, name: string, fullName: string, contractAddress: string, features?: CoinFeature[], prefix?: string, suffix?: string, network?: EthereumNetwork, primaryKeyCurve?: KeyCurve): Readonly<ContractAddressDefinedToken>;
289
327
  /**
290
328
  * Factory function for erc1155 token instances.
291
329
  *
330
+ * @param id uuid v4
292
331
  * @param name unique identifier of the token
293
332
  * @param fullName Complete human-readable name of the token
294
333
  * @param contractAddress Contract address of this token
@@ -299,10 +338,11 @@ export declare function terc721(name: string, fullName: string, contractAddress:
299
338
  * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
300
339
  * @param primaryKeyCurve The elliptic curve for this chain/token
301
340
  */
302
- export declare function erc1155(name: string, fullName: string, contractAddress: string, features?: CoinFeature[], prefix?: string, suffix?: string, network?: EthereumNetwork, primaryKeyCurve?: KeyCurve): Readonly<Erc1155Coin>;
341
+ export declare function erc1155(id: string, name: string, fullName: string, contractAddress: string, features?: CoinFeature[], prefix?: string, suffix?: string, network?: EthereumNetwork, primaryKeyCurve?: KeyCurve): Readonly<Erc1155Coin>;
303
342
  /**
304
343
  * Factory function for testnet erc1155 token instances.
305
344
  *
345
+ * @param id uuid v4
306
346
  * @param name unique identifier of the token
307
347
  * @param fullName Complete human-readable name of the token
308
348
  * @param contractAddress Contract address of this token
@@ -312,10 +352,11 @@ export declare function erc1155(name: string, fullName: string, contractAddress:
312
352
  * @param network? Optional token network. Defaults to Goerli test network.
313
353
  * @param primaryKeyCurve The elliptic curve for this chain/token
314
354
  */
315
- export declare function terc1155(name: string, fullName: string, contractAddress: string, features?: CoinFeature[], prefix?: string, suffix?: string, network?: EthereumNetwork, primaryKeyCurve?: KeyCurve): Readonly<Erc1155Coin>;
355
+ export declare function terc1155(id: string, name: string, fullName: string, contractAddress: string, features?: CoinFeature[], prefix?: string, suffix?: string, network?: EthereumNetwork, primaryKeyCurve?: KeyCurve): Readonly<Erc1155Coin>;
316
356
  /**
317
357
  * Factory function for ERC20-compatible account coin instances.
318
358
  *
359
+ * @param id uuid v4
319
360
  * @param name unique identifier of the token
320
361
  * @param fullName Complete human-readable name of the token
321
362
  * @param network Network object for this coin
@@ -327,10 +368,11 @@ export declare function terc1155(name: string, fullName: string, contractAddress
327
368
  * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
328
369
  * @param primaryKeyCurve The elliptic curve for this chain/token
329
370
  */
330
- export declare function erc20CompatibleAccountCoin(name: string, fullName: string, network: EthereumNetwork, decimalPlaces: number, contractAddress: string, asset: UnderlyingAsset, baseUnit: BaseUnit, features?: CoinFeature[], prefix?: string, suffix?: string, primaryKeyCurve?: KeyCurve): Readonly<Erc20CompatibleAccountCoin>;
371
+ export declare function erc20CompatibleAccountCoin(id: string, name: string, fullName: string, network: EthereumNetwork, decimalPlaces: number, contractAddress: string, asset: UnderlyingAsset, baseUnit: BaseUnit, features?: CoinFeature[], prefix?: string, suffix?: string, primaryKeyCurve?: KeyCurve): Readonly<Erc20CompatibleAccountCoin>;
331
372
  /**
332
373
  * Factory function for celo token instances.
333
374
  *
375
+ * @param id uuid v4
334
376
  * @param name unique identifier of the token
335
377
  * @param fullName Complete human-readable name of the token
336
378
  * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
@@ -342,10 +384,11 @@ export declare function erc20CompatibleAccountCoin(name: string, fullName: strin
342
384
  * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
343
385
  * @param primaryKeyCurve The elliptic curve for this chain/token
344
386
  */
345
- export declare function celoToken(name: string, fullName: string, decimalPlaces: number, contractAddress: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: EthereumNetwork, primaryKeyCurve?: KeyCurve): Readonly<CeloCoin>;
387
+ export declare function celoToken(id: string, name: string, fullName: string, decimalPlaces: number, contractAddress: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: EthereumNetwork, primaryKeyCurve?: KeyCurve): Readonly<CeloCoin>;
346
388
  /**
347
389
  * Factory function for testnet celo token instances.
348
390
  *
391
+ * @param id uuid v4
349
392
  * @param name unique identifier of the token
350
393
  * @param fullName Complete human-readable name of the token
351
394
  * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
@@ -356,10 +399,11 @@ export declare function celoToken(name: string, fullName: string, decimalPlaces:
356
399
  * @param network? Optional token network. Defaults to the testnet CELO network.
357
400
  * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
358
401
  */
359
- export declare function tceloToken(name: string, fullName: string, decimalPlaces: number, contractAddress: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: EthereumNetwork): Readonly<CeloCoin>;
402
+ export declare function tceloToken(id: string, name: string, fullName: string, decimalPlaces: number, contractAddress: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: EthereumNetwork): Readonly<CeloCoin>;
360
403
  /**
361
404
  * Factory function for celo token instances.
362
405
  *
406
+ * @param id uuid v4
363
407
  * @param name unique identifier of the token
364
408
  * @param fullName Complete human-readable name of the token
365
409
  * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
@@ -371,10 +415,11 @@ export declare function tceloToken(name: string, fullName: string, decimalPlaces
371
415
  * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
372
416
  * @param primaryKeyCurve The elliptic curve for this chain/token
373
417
  */
374
- export declare function bscToken(name: string, fullName: string, decimalPlaces: number, contractAddress: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: EthereumNetwork, primaryKeyCurve?: KeyCurve): Readonly<BscCoin>;
418
+ export declare function bscToken(id: string, name: string, fullName: string, decimalPlaces: number, contractAddress: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: EthereumNetwork, primaryKeyCurve?: KeyCurve): Readonly<BscCoin>;
375
419
  /**
376
420
  * Factory function for testnet bsc token instances.
377
421
  *
422
+ * @param id uuid v4
378
423
  * @param name unique identifier of the token
379
424
  * @param fullName Complete human-readable name of the token
380
425
  * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
@@ -385,10 +430,11 @@ export declare function bscToken(name: string, fullName: string, decimalPlaces:
385
430
  * @param network? Optional token network. Defaults to the testnet BSC network.
386
431
  * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
387
432
  */
388
- export declare function tbscToken(name: string, fullName: string, decimalPlaces: number, contractAddress: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: EthereumNetwork): Readonly<BscCoin>;
433
+ export declare function tbscToken(id: string, name: string, fullName: string, decimalPlaces: number, contractAddress: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: EthereumNetwork): Readonly<BscCoin>;
389
434
  /**
390
435
  * Factory function for Stellar token instances.
391
436
  *
437
+ * @param id uuid v4
392
438
  * @param name unique identifier of the token
393
439
  * @param fullName Complete human-readable name of the token
394
440
  * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
@@ -401,10 +447,11 @@ export declare function tbscToken(name: string, fullName: string, decimalPlaces:
401
447
  * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
402
448
  * @param primaryKeyCurve The elliptic curve for this chain/token
403
449
  */
404
- export declare function stellarToken(name: string, fullName: string, decimalPlaces: number, asset: UnderlyingAsset, domain?: string, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork, primaryKeyCurve?: KeyCurve): Readonly<StellarCoin>;
450
+ export declare function stellarToken(id: string, name: string, fullName: string, decimalPlaces: number, asset: UnderlyingAsset, domain?: string, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork, primaryKeyCurve?: KeyCurve): Readonly<StellarCoin>;
405
451
  /**
406
452
  * Factory function for testnet Stellar token instances.
407
453
  *
454
+ * @param id uuid v4
408
455
  * @param name unique identifier of the token
409
456
  * @param fullName Complete human-readable name of the token
410
457
  * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
@@ -416,10 +463,11 @@ export declare function stellarToken(name: string, fullName: string, decimalPlac
416
463
  * @param network? Optional token network. Defaults to Stellar testnet.
417
464
  * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
418
465
  */
419
- export declare function tstellarToken(name: string, fullName: string, decimalPlaces: number, asset: UnderlyingAsset, domain?: string, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork): Readonly<StellarCoin>;
466
+ export declare function tstellarToken(id: string, name: string, fullName: string, decimalPlaces: number, asset: UnderlyingAsset, domain?: string, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork): Readonly<StellarCoin>;
420
467
  /**
421
468
  * Factory function for tron token instances.
422
469
  *
470
+ * @param id uuid v4
423
471
  * @param name unique identifier of the token
424
472
  * @param fullName Complete human-readable name of the token
425
473
  * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
@@ -431,10 +479,11 @@ export declare function tstellarToken(name: string, fullName: string, decimalPla
431
479
  * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
432
480
  * @param primaryKeyCurve The elliptic curve for this chain/token
433
481
  */
434
- export declare function tronToken(name: string, fullName: string, decimalPlaces: number, contractAddress: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: TronNetwork, primaryKeyCurve?: KeyCurve): Readonly<TronErc20Coin>;
482
+ export declare function tronToken(id: string, name: string, fullName: string, decimalPlaces: number, contractAddress: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: TronNetwork, primaryKeyCurve?: KeyCurve): Readonly<TronErc20Coin>;
435
483
  /**
436
484
  * Factory function for testnet tron token instances.
437
485
  *
486
+ * @param id uuid v4
438
487
  * @param name unique identifier of the token
439
488
  * @param fullName Complete human-readable name of the token
440
489
  * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
@@ -446,10 +495,11 @@ export declare function tronToken(name: string, fullName: string, decimalPlaces:
446
495
  * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
447
496
  * @param primaryKeyCurve The elliptic curve for this chain/token
448
497
  */
449
- export declare function ttronToken(name: string, fullName: string, decimalPlaces: number, contractAddress: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: TronNetwork, primaryKeyCurve?: KeyCurve): Readonly<TronErc20Coin>;
498
+ export declare function ttronToken(id: string, name: string, fullName: string, decimalPlaces: number, contractAddress: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: TronNetwork, primaryKeyCurve?: KeyCurve): Readonly<TronErc20Coin>;
450
499
  /**
451
500
  * Factory function for Hedera coin instances
452
501
  *
502
+ * @param id uuid v4
453
503
  * @param name unique identifier of the coin
454
504
  * @param fullName Complete human-readable name of the token
455
505
  * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
@@ -461,10 +511,11 @@ export declare function ttronToken(name: string, fullName: string, decimalPlaces
461
511
  * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
462
512
  * @param primaryKeyCurve The elliptic curve for this chain/token
463
513
  */
464
- export declare function hederaCoin(name: string, fullName: string, network: AccountNetwork, decimalPlaces: number, asset: UnderlyingAsset, nodeAccountId?: string, features?: CoinFeature[], prefix?: string, suffix?: string, primaryKeyCurve?: KeyCurve): Readonly<HederaCoin>;
514
+ export declare function hederaCoin(id: string, name: string, fullName: string, network: AccountNetwork, decimalPlaces: number, asset: UnderlyingAsset, nodeAccountId?: string, features?: CoinFeature[], prefix?: string, suffix?: string, primaryKeyCurve?: KeyCurve): Readonly<HederaCoin>;
465
515
  /**
466
516
  * Factory function for Hedera token instances
467
517
  *
518
+ * @param id uuid v4
468
519
  * @param name unique identifier of the coin
469
520
  * @param fullName Complete human-readable name of the token
470
521
  * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
@@ -477,11 +528,13 @@ export declare function hederaCoin(name: string, fullName: string, network: Acco
477
528
  * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
478
529
  * @param primaryKeyCurve The elliptic curve for this chain/token
479
530
  */
480
- export declare function hederaToken(name: string, fullName: string, network: AccountNetwork, decimalPlaces: number, asset: UnderlyingAsset, nodeAccountId: string | undefined, tokenId: string, features?: CoinFeature[], prefix?: string, suffix?: string, primaryKeyCurve?: KeyCurve): Readonly<HederaToken>;
531
+ export declare function hederaToken(id: string, name: string, fullName: string, network: AccountNetwork, decimalPlaces: number, asset: UnderlyingAsset, nodeAccountId: string | undefined, tokenId: string, features?: CoinFeature[], prefix?: string, suffix?: string, primaryKeyCurve?: KeyCurve): Readonly<HederaToken>;
481
532
  /**
482
533
  * Factory function for ALGO token instances.
483
534
  *
535
+ * @param id uuid v4
484
536
  * @param name unique identifier of the token
537
+
485
538
  * @param alias (optional) alternative identifier of the token
486
539
  * @param fullName Complete human-readable name of the token
487
540
  * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
@@ -494,10 +547,11 @@ export declare function hederaToken(name: string, fullName: string, network: Acc
494
547
  * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
495
548
  * @param primaryKeyCurve The elliptic curve for this chain/token
496
549
  */
497
- export declare function algoToken(name: string, alias: string | undefined, fullName: string, decimalPlaces: number, asset: UnderlyingAsset, tokenURL?: string, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork, primaryKeyCurve?: KeyCurve): Readonly<AlgoCoin>;
550
+ export declare function algoToken(id: string, name: string, alias: string | undefined, fullName: string, decimalPlaces: number, asset: UnderlyingAsset, tokenURL?: string, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork, primaryKeyCurve?: KeyCurve): Readonly<AlgoCoin>;
498
551
  /**
499
552
  * Factory function for testnet ALGO token instances.
500
553
  *
554
+ * @param id uuid v4
501
555
  * @param name unique identifier of the token
502
556
  * @param alias (optional) alternative identifier of the token
503
557
  * @param fullName Complete human-readable name of the token
@@ -510,10 +564,11 @@ export declare function algoToken(name: string, alias: string | undefined, fullN
510
564
  * @param network? Optional token network. Defaults to Algo testnet.
511
565
  * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
512
566
  */
513
- export declare function talgoToken(name: string, alias: string | undefined, fullName: string, decimalPlaces: number, asset: UnderlyingAsset, tokenURL?: string, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork): Readonly<AlgoCoin>;
567
+ export declare function talgoToken(id: string, name: string, alias: string | undefined, fullName: string, decimalPlaces: number, asset: UnderlyingAsset, tokenURL?: string, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork): Readonly<AlgoCoin>;
514
568
  /**
515
569
  * Factory function for eos token instances.
516
570
  *
571
+ * @param id uuid v4
517
572
  * @param name unique identifier of the token
518
573
  * @param fullName Complete human-readable name of the token
519
574
  * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
@@ -525,10 +580,11 @@ export declare function talgoToken(name: string, alias: string | undefined, full
525
580
  * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
526
581
  * @param primaryKeyCurve The elliptic curve for this chain/token
527
582
  */
528
- export declare function eosToken(name: string, fullName: string, decimalPlaces: number, contractName: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork, primaryKeyCurve?: KeyCurve): Readonly<EosCoin>;
583
+ export declare function eosToken(id: string, name: string, fullName: string, decimalPlaces: number, contractName: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork, primaryKeyCurve?: KeyCurve): Readonly<EosCoin>;
529
584
  /**
530
585
  * Factory function for testnet eos token instances.
531
586
  *
587
+ * @param id uuid v4
532
588
  * @param name unique identifier of the token
533
589
  * @param fullName Complete human-readable name of the token
534
590
  * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
@@ -539,10 +595,11 @@ export declare function eosToken(name: string, fullName: string, decimalPlaces:
539
595
  * @param network? Optional token network. Defaults to the testnet EOS network.
540
596
  * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
541
597
  */
542
- export declare function teosToken(name: string, fullName: string, decimalPlaces: number, contractName: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork): Readonly<EosCoin>;
598
+ export declare function teosToken(id: string, name: string, fullName: string, decimalPlaces: number, contractName: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork): Readonly<EosCoin>;
543
599
  /**
544
600
  * Factory function for sol token instances.
545
601
  *
602
+ * @param id uuid v4
546
603
  * @param name unique identifier of the token
547
604
  * @param fullName Complete human-readable name of the token
548
605
  * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
@@ -554,10 +611,11 @@ export declare function teosToken(name: string, fullName: string, decimalPlaces:
554
611
  * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES and REQUIRES_RESERVE defined in `AccountCoin`
555
612
  * @param primaryKeyCurve The elliptic curve for this chain/token
556
613
  */
557
- export declare function solToken(name: string, fullName: string, decimalPlaces: number, tokenAddress: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork, primaryKeyCurve?: KeyCurve): Readonly<SolCoin>;
614
+ export declare function solToken(id: string, name: string, fullName: string, decimalPlaces: number, tokenAddress: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork, primaryKeyCurve?: KeyCurve): Readonly<SolCoin>;
558
615
  /**
559
616
  * Factory function for testnet solana token instances.
560
617
  *
618
+ * @param id uuid v4
561
619
  * @param name unique identifier of the token
562
620
  * @param fullName Complete human-readable name of the token
563
621
  * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
@@ -568,10 +626,11 @@ export declare function solToken(name: string, fullName: string, decimalPlaces:
568
626
  * @param network? Optional token network. Defaults to the testnet Solana network.
569
627
  * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES and REQUIRES_RESERVE defined in `AccountCoin`
570
628
  */
571
- export declare function tsolToken(name: string, fullName: string, decimalPlaces: number, tokenAddress: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork): Readonly<SolCoin>;
629
+ export declare function tsolToken(id: string, name: string, fullName: string, decimalPlaces: number, tokenAddress: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork): Readonly<SolCoin>;
572
630
  /**
573
631
  * Factory function for ada token instances.
574
632
  *
633
+ * @param id uuid v4
575
634
  * @param name unique identifier of the token
576
635
  * @param fullName Complete human-readable name of the token
577
636
  * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
@@ -583,10 +642,11 @@ export declare function tsolToken(name: string, fullName: string, decimalPlaces:
583
642
  * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES and REQUIRES_RESERVE defined in `AccountCoin`
584
643
  * @param primaryKeyCurve The elliptic curve for this chain/token
585
644
  */
586
- export declare function adaToken(name: string, fullName: string, decimalPlaces: number, policyId: string, assetName: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork, primaryKeyCurve?: KeyCurve): Readonly<AdaCoin>;
645
+ export declare function adaToken(id: string, name: string, fullName: string, decimalPlaces: number, policyId: string, assetName: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork, primaryKeyCurve?: KeyCurve): Readonly<AdaCoin>;
587
646
  /**
588
647
  * Factory function for testnet cardano token instances.
589
648
  *
649
+ * @param id uuid v4
590
650
  * @param name unique identifier of the token
591
651
  * @param fullName Complete human-readable name of the token
592
652
  * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
@@ -597,10 +657,11 @@ export declare function adaToken(name: string, fullName: string, decimalPlaces:
597
657
  * @param network? Optional token network. Defaults to the testnet Cardano network.
598
658
  * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES and REQUIRES_RESERVE defined in `AccountCoin`
599
659
  */
600
- export declare function tadaToken(name: string, fullName: string, decimalPlaces: number, policyId: string, assetName: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork): Readonly<AdaCoin>;
660
+ export declare function tadaToken(id: string, name: string, fullName: string, decimalPlaces: number, policyId: string, assetName: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork): Readonly<AdaCoin>;
601
661
  /**
602
662
  * Factory function for avaxErc20 token instances.
603
663
  *
664
+ * @param id uuid v4
604
665
  * @param name unique identifier of the token
605
666
  * @param fullName Complete human-readable name of the token
606
667
  * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
@@ -612,10 +673,11 @@ export declare function tadaToken(name: string, fullName: string, decimalPlaces:
612
673
  * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
613
674
  * @param primaryKeyCurve The elliptic curve for this chain/token
614
675
  */
615
- export declare function avaxErc20(name: string, fullName: string, decimalPlaces: number, contractAddress: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork, primaryKeyCurve?: KeyCurve): Readonly<AvaxERC20Token>;
676
+ export declare function avaxErc20(id: string, name: string, fullName: string, decimalPlaces: number, contractAddress: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork, primaryKeyCurve?: KeyCurve): Readonly<AvaxERC20Token>;
616
677
  /**
617
678
  * Factory function for testnet avaxErc20 token instances.
618
679
  *
680
+ * @param id uuid v4
619
681
  * @param name unique identifier of the token
620
682
  * @param fullName Complete human-readable name of the token
621
683
  * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
@@ -627,10 +689,11 @@ export declare function avaxErc20(name: string, fullName: string, decimalPlaces:
627
689
  * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
628
690
  * @param primaryKeyCurve The elliptic curve for this chain/token
629
691
  */
630
- export declare function tavaxErc20(name: string, fullName: string, decimalPlaces: number, contractAddress: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork, primaryKeyCurve?: KeyCurve): Readonly<AvaxERC20Token>;
692
+ export declare function tavaxErc20(id: string, name: string, fullName: string, decimalPlaces: number, contractAddress: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork, primaryKeyCurve?: KeyCurve): Readonly<AvaxERC20Token>;
631
693
  /**
632
694
  * Factory function for polygonErc20 token instances.
633
695
  *
696
+ * @param id uuid v4
634
697
  * @param name unique identifier of the token
635
698
  * @param fullName Complete human-readable name of the token
636
699
  * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
@@ -642,10 +705,11 @@ export declare function tavaxErc20(name: string, fullName: string, decimalPlaces
642
705
  * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
643
706
  * @param primaryKeyCurve The elliptic curve for this chain/token
644
707
  */
645
- export declare function polygonErc20(name: string, fullName: string, decimalPlaces: number, contractAddress: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork, primaryKeyCurve?: KeyCurve): Readonly<PolygonERC20Token>;
708
+ export declare function polygonErc20(id: string, name: string, fullName: string, decimalPlaces: number, contractAddress: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork, primaryKeyCurve?: KeyCurve): Readonly<PolygonERC20Token>;
646
709
  /**
647
710
  * Factory function for Mumbai testnet polygonErc20 token instances.
648
711
  *
712
+ * @param id uuid v4
649
713
  * @param name unique identifier of the token
650
714
  * @param fullName Complete human-readable name of the token
651
715
  * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
@@ -657,11 +721,47 @@ export declare function polygonErc20(name: string, fullName: string, decimalPlac
657
721
  * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
658
722
  * @param primaryKeyCurve The elliptic curve for this chain/token
659
723
  */
660
- export declare function tpolygonErc20(name: string, fullName: string, decimalPlaces: number, contractAddress: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork, primaryKeyCurve?: KeyCurve): Readonly<PolygonERC20Token>;
724
+ export declare function tpolygonErc20(id: string, name: string, fullName: string, decimalPlaces: number, contractAddress: string, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork, primaryKeyCurve?: KeyCurve): Readonly<PolygonERC20Token>;
725
+ /**
726
+ * Factory function for xrp token instances.
727
+ *
728
+ * @param id uuid v4
729
+ * @param name unique identifier of the token
730
+ * @param fullName Complete human-readable name of the token
731
+ * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
732
+ * @param issuerAddress: The address of the issuer of the token,
733
+ * @param currencyCode The token symbol. Example: USD, BTC, ETH, etc.
734
+ * @param domain? the domain of the issuer of the token,
735
+ * @param asset Asset which this coin represents. This is the same for both mainnet and testnet variants of a coin.
736
+ * @param prefix? Optional token prefix. Defaults to empty string
737
+ * @param suffix? Optional token suffix. Defaults to token name.
738
+ * @param network? Optional token network. Defaults to Cardano main network.
739
+ * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
740
+ * @param primaryKeyCurve The elliptic curve for this chain/token
741
+ */
742
+ export declare function xrpToken(id: string, name: string, fullName: string, decimalPlaces: number, issuerAddress: string, currencyCode: string, domain: string | undefined, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork, primaryKeyCurve?: KeyCurve): Readonly<XrpCoin>;
743
+ /**
744
+ * Factory function for testnet cardano token instances.
745
+ *
746
+ * @param id uuid v4
747
+ * @param name unique identifier of the token
748
+ * @param fullName Complete human-readable name of the token
749
+ * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
750
+ * @param issuerAddress: The address of the issuer of the token,
751
+ * @param currencyCode The token symbol. Example: USD, BTC, ETH, etc.
752
+ * @param domain? the domain of the issuer of the token,
753
+ * @param asset Asset which this coin represents. This is the same for both mainnet and testnet variants of a coin.
754
+ * @param prefix? Optional token prefix. Defaults to empty string
755
+ * @param suffix? Optional token suffix. Defaults to token name.
756
+ * @param network? Optional token network. Defaults to the testnet Cardano network.
757
+ * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `AccountCoin`
758
+ */
759
+ export declare function txrpToken(id: string, name: string, fullName: string, decimalPlaces: number, issuerAddress: string, currencyCode: string, domain: string | undefined, asset: UnderlyingAsset, features?: CoinFeature[], prefix?: string, suffix?: string, network?: AccountNetwork): Readonly<XrpCoin>;
661
760
  /**
662
761
  * Factory function for fiat coin instances.
663
762
  *
664
- * @param name unique identifier of the coin, should start with 'fiat' or 'tfiat'
763
+ * @param id uuid v4
764
+ * @param name unique identifier of the coin, should start with 'fiat' or 'tfiat' followed by the 3-char ISO-4217 alphabetical code
665
765
  * @param fullName Complete human-readable name of the coin
666
766
  * @param network Network object for this coin
667
767
  * @param decimalPlaces Number of decimal places this coin supports (divisibility exponent)
@@ -672,6 +772,6 @@ export declare function tpolygonErc20(name: string, fullName: string, decimalPla
672
772
  * @param suffix? Optional coin suffix. Defaults to coin name.
673
773
  * @param isToken? Whether or not this coin is a token of another coin
674
774
  */
675
- export declare function fiat(name: FiatCoinName, fullName: string, network: BaseNetwork, decimalPlaces: number, asset: UnderlyingAsset, features?: CoinFeature[], primaryKeyCurve?: KeyCurve, prefix?: string, suffix?: string, isToken?: boolean): Readonly<FiatCoin>;
775
+ export declare function fiat(id: string, name: FiatCoinName, fullName: string, network: BaseNetwork, decimalPlaces: number, asset: UnderlyingAsset, features?: CoinFeature[], primaryKeyCurve?: KeyCurve, prefix?: string, suffix?: string, isToken?: boolean): Readonly<FiatCoin>;
676
776
  export {};
677
777
  //# sourceMappingURL=account.d.ts.map