@bitgo-beta/sdk-coin-stx 1.4.3-alpha.31 → 1.4.3-alpha.310

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 (38) hide show
  1. package/CHANGELOG.md +601 -0
  2. package/dist/src/index.d.ts +1 -0
  3. package/dist/src/index.d.ts.map +1 -1
  4. package/dist/src/index.js +24 -9
  5. package/dist/src/lib/abstractContractBuilder.js +2 -2
  6. package/dist/src/lib/constants.d.ts +2 -1
  7. package/dist/src/lib/constants.d.ts.map +1 -1
  8. package/dist/src/lib/constants.js +5 -3
  9. package/dist/src/lib/contractBuilder.js +10 -10
  10. package/dist/src/lib/fungibleTokenTransferBuilder.d.ts +62 -0
  11. package/dist/src/lib/fungibleTokenTransferBuilder.d.ts.map +1 -0
  12. package/dist/src/lib/fungibleTokenTransferBuilder.js +131 -0
  13. package/dist/src/lib/iface.d.ts +56 -0
  14. package/dist/src/lib/iface.d.ts.map +1 -1
  15. package/dist/src/lib/iface.js +1 -1
  16. package/dist/src/lib/index.js +23 -9
  17. package/dist/src/lib/keyPair.js +18 -19
  18. package/dist/src/lib/sendmanyBuilder.js +11 -11
  19. package/dist/src/lib/transaction.d.ts.map +1 -1
  20. package/dist/src/lib/transaction.js +31 -15
  21. package/dist/src/lib/transactionBuilder.js +12 -12
  22. package/dist/src/lib/transactionBuilderFactory.d.ts +2 -0
  23. package/dist/src/lib/transactionBuilderFactory.d.ts.map +1 -1
  24. package/dist/src/lib/transactionBuilderFactory.js +9 -2
  25. package/dist/src/lib/transferBuilder.js +4 -4
  26. package/dist/src/lib/utils.d.ts +25 -2
  27. package/dist/src/lib/utils.d.ts.map +1 -1
  28. package/dist/src/lib/utils.js +141 -62
  29. package/dist/src/register.d.ts.map +1 -1
  30. package/dist/src/register.js +5 -1
  31. package/dist/src/sip10Token.d.ts +22 -0
  32. package/dist/src/sip10Token.d.ts.map +1 -0
  33. package/dist/src/sip10Token.js +128 -0
  34. package/dist/src/stx.d.ts +146 -2
  35. package/dist/src/stx.d.ts.map +1 -1
  36. package/dist/src/stx.js +420 -11
  37. package/dist/src/tstx.js +1 -1
  38. package/package.json +9 -10
@@ -0,0 +1,22 @@
1
+ import { BitGoBase, CoinConstructor, NamedCoinConstructor, VerifyTransactionOptions } from '@bitgo-beta/sdk-core';
2
+ import { BaseCoin as StaticsBaseCoin, Sip10TokenConfig } from '@bitgo-beta/statics';
3
+ import { Stx } from './stx';
4
+ import { TransactionBuilder } from './lib/transactionBuilder';
5
+ export declare class Sip10Token extends Stx {
6
+ readonly tokenConfig: Sip10TokenConfig;
7
+ constructor(bitgo: BitGoBase, tokenConfig: Sip10TokenConfig);
8
+ static createTokenConstructor(config: Sip10TokenConfig): CoinConstructor;
9
+ static createTokenConstructors(tokenConfigs?: Sip10TokenConfig[]): NamedCoinConstructor[];
10
+ get name(): string;
11
+ get coin(): string;
12
+ get network(): string;
13
+ get assetId(): string;
14
+ get decimalPlaces(): number;
15
+ getChain(): string;
16
+ getBaseChain(): string;
17
+ getFullName(): string;
18
+ getBaseFactor(): number;
19
+ getTransaction(coinConfig: Readonly<StaticsBaseCoin>): TransactionBuilder;
20
+ verifyTransaction(params: VerifyTransactionOptions): Promise<boolean>;
21
+ }
22
+ //# sourceMappingURL=sip10Token.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sip10Token.d.ts","sourceRoot":"","sources":["../../src/sip10Token.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AAClH,OAAO,EAAE,QAAQ,IAAI,eAAe,EAAsB,gBAAgB,EAAU,MAAM,qBAAqB,CAAC;AAEhH,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAE5B,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAG9D,qBAAa,UAAW,SAAQ,GAAG;IACjC,SAAgB,WAAW,EAAE,gBAAgB,CAAC;gBAElC,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,gBAAgB;IAM3D,MAAM,CAAC,sBAAsB,CAAC,MAAM,EAAE,gBAAgB,GAAG,eAAe;IAIxE,MAAM,CAAC,uBAAuB,CAC5B,YAAY,GAAE,gBAAgB,EAAiE,GAC9F,oBAAoB,EAAE;IASzB,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,IAAI,aAAa,IAAI,MAAM,CAE1B;IAED,QAAQ,IAAI,MAAM;IAIlB,YAAY,IAAI,MAAM;IAItB,WAAW,IAAI,MAAM;IAIrB,aAAa,IAAI,MAAM;IAIvB,cAAc,CAAC,UAAU,EAAE,QAAQ,CAAC,eAAe,CAAC,GAAG,kBAAkB;IAInE,iBAAiB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,OAAO,CAAC;CAmE5E"}
@@ -0,0 +1,128 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.Sip10Token = void 0;
7
+ const lodash_1 = __importDefault(require("lodash"));
8
+ const bignumber_js_1 = __importDefault(require("bignumber.js"));
9
+ const statics_1 = require("@bitgo-beta/statics");
10
+ const stx_1 = require("./stx");
11
+ const lib_1 = require("./lib");
12
+ const utils_1 = require("./lib/utils");
13
+ class Sip10Token extends stx_1.Stx {
14
+ constructor(bitgo, tokenConfig) {
15
+ const staticsCoin = tokenConfig.network === statics_1.NetworkType.MAINNET ? statics_1.coins.get('stx') : statics_1.coins.get('tstx');
16
+ super(bitgo, staticsCoin);
17
+ this.tokenConfig = tokenConfig;
18
+ }
19
+ static createTokenConstructor(config) {
20
+ return (bitgo) => new Sip10Token(bitgo, config);
21
+ }
22
+ static createTokenConstructors(tokenConfigs = [...statics_1.tokens.bitcoin.stx.tokens, ...statics_1.tokens.testnet.stx.tokens]) {
23
+ const tokensCtors = [];
24
+ for (const token of tokenConfigs) {
25
+ const tokenConstructor = Sip10Token.createTokenConstructor(token);
26
+ tokensCtors.push({ name: token.type, coinConstructor: tokenConstructor });
27
+ }
28
+ return tokensCtors;
29
+ }
30
+ get name() {
31
+ return this.tokenConfig.name;
32
+ }
33
+ get coin() {
34
+ return this.tokenConfig.coin;
35
+ }
36
+ get network() {
37
+ return this.tokenConfig.network;
38
+ }
39
+ get assetId() {
40
+ return this.tokenConfig.assetId;
41
+ }
42
+ get decimalPlaces() {
43
+ return this.tokenConfig.decimalPlaces;
44
+ }
45
+ getChain() {
46
+ return this.tokenConfig.type;
47
+ }
48
+ getBaseChain() {
49
+ return this.coin;
50
+ }
51
+ getFullName() {
52
+ return 'Sip10 Token';
53
+ }
54
+ getBaseFactor() {
55
+ return Math.pow(10, this.tokenConfig.decimalPlaces);
56
+ }
57
+ getTransaction(coinConfig) {
58
+ return new lib_1.TransactionBuilderFactory(coinConfig).getFungibleTokenTransferBuilder();
59
+ }
60
+ async verifyTransaction(params) {
61
+ const { txPrebuild: txPrebuild, txParams: txParams } = params;
62
+ const { memo } = txParams;
63
+ if (Array.isArray(txParams.recipients) && txParams.recipients.length > 1) {
64
+ throw new Error(`${this.getChain()} doesn't support sending to more than 1 destination address within a single transaction. Try again, using only a single recipient.`);
65
+ }
66
+ const rawTx = txPrebuild.txHex;
67
+ if (!rawTx) {
68
+ throw new Error('missing required tx prebuild property txHex');
69
+ }
70
+ const coinConfig = statics_1.coins.get(this.getChain());
71
+ const transaction = this.getTransaction(coinConfig);
72
+ transaction.from(rawTx);
73
+ const explainedTx = await this.explainTransaction({ txHex: rawTx, feeInfo: { fee: '' } });
74
+ if (txParams.recipients !== undefined && explainedTx) {
75
+ const filteredRecipients = txParams.recipients?.map((recipient) => {
76
+ const addressDetails = (0, utils_1.getMemoIdAndBaseAddressFromAddress)(recipient.address);
77
+ const recipientData = {
78
+ address: addressDetails.address,
79
+ amount: BigInt(recipient.amount),
80
+ };
81
+ if (recipient.tokenName) {
82
+ recipientData['tokenName'] = recipient.tokenName;
83
+ }
84
+ return recipientData;
85
+ });
86
+ const filteredOutputs = explainedTx.outputs.map((output) => {
87
+ const recipientData = {
88
+ address: output.address,
89
+ amount: BigInt(output.amount),
90
+ };
91
+ if (output.tokenName) {
92
+ recipientData['tokenName'] = output.tokenName;
93
+ }
94
+ return recipientData;
95
+ });
96
+ if (!lodash_1.default.isEqual(filteredOutputs, filteredRecipients)) {
97
+ throw new Error('Tx outputs does not match with expected txParams recipients');
98
+ }
99
+ // compare memo
100
+ let memoInput = '';
101
+ let memoOutput = '';
102
+ if (memo && memo.value) {
103
+ memoInput = memo.value;
104
+ }
105
+ else if (txParams.recipients.length) {
106
+ const addressDetails = (0, utils_1.getMemoIdAndBaseAddressFromAddress)(txParams.recipients[0].address);
107
+ memoInput = addressDetails.memoId ? addressDetails.memoId : '';
108
+ }
109
+ if (explainedTx.memo) {
110
+ memoOutput = explainedTx.memo;
111
+ }
112
+ if (!lodash_1.default.isEqual(memoInput, memoOutput)) {
113
+ throw new Error('Tx memo does not match with expected txParams recipient memo');
114
+ }
115
+ // compare send amount
116
+ let totalAmount = new bignumber_js_1.default(0);
117
+ for (const recipients of txParams.recipients) {
118
+ totalAmount = totalAmount.plus(recipients.amount);
119
+ }
120
+ if (!totalAmount.isEqualTo(explainedTx.outputAmount)) {
121
+ throw new Error('Tx total amount does not match with expected total amount field');
122
+ }
123
+ }
124
+ return true;
125
+ }
126
+ }
127
+ exports.Sip10Token = Sip10Token;
128
+ //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"sip10Token.js","sourceRoot":"","sources":["../../src/sip10Token.ts"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AACvB,gEAAqC;AAGrC,iDAAgH;AAEhH,+BAA4B;AAC5B,+BAAkD;AAElD,uCAAiE;AAEjE,MAAa,UAAW,SAAQ,SAAG;IAGjC,YAAY,KAAgB,EAAE,WAA6B;QACzD,MAAM,WAAW,GAAG,WAAW,CAAC,OAAO,KAAK,qBAAW,CAAC,OAAO,CAAC,CAAC,CAAC,eAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,eAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACvG,KAAK,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;QAC1B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAED,MAAM,CAAC,sBAAsB,CAAC,MAAwB;QACpD,OAAO,CAAC,KAAgB,EAAE,EAAE,CAAC,IAAI,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAC7D,CAAC;IAED,MAAM,CAAC,uBAAuB,CAC5B,eAAmC,CAAC,GAAG,gBAAM,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,gBAAM,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC;QAE/F,MAAM,WAAW,GAA2B,EAAE,CAAC;QAC/C,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE,CAAC;YACjC,MAAM,gBAAgB,GAAG,UAAU,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;YAClE,WAAW,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,eAAe,EAAE,gBAAgB,EAAE,CAAC,CAAC;QAC5E,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IAC/B,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IAC/B,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;IAClC,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;IAClC,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC;IACxC,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IAC/B,CAAC;IAED,YAAY;QACV,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,WAAW;QACT,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,aAAa;QACX,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;IACtD,CAAC;IAED,cAAc,CAAC,UAAqC;QAClD,OAAO,IAAI,+BAAyB,CAAC,UAAU,CAAC,CAAC,+BAA+B,EAAE,CAAC;IACrF,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,MAAgC;QACtD,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAC9D,MAAM,EAAE,IAAI,EAAE,GAAG,QAAQ,CAAC;QAC1B,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,QAAQ,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzE,MAAM,IAAI,KAAK,CACb,GAAG,IAAI,CAAC,QAAQ,EAAE,oIAAoI,CACvJ,CAAC;QACJ,CAAC;QACD,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;QAC/B,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;QACjE,CAAC;QACD,MAAM,UAAU,GAAG,eAAK,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC9C,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QACpD,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAC1F,IAAI,QAAQ,CAAC,UAAU,KAAK,SAAS,IAAI,WAAW,EAAE,CAAC;YACrD,MAAM,kBAAkB,GAAG,QAAQ,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE;gBAChE,MAAM,cAAc,GAAG,IAAA,0CAAkC,EAAC,SAAS,CAAC,OAAO,CAAC,CAAC;gBAC7E,MAAM,aAAa,GAAG;oBACpB,OAAO,EAAE,cAAc,CAAC,OAAO;oBAC/B,MAAM,EAAE,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC;iBACjC,CAAC;gBACF,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC;oBACxB,aAAa,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC;gBACnD,CAAC;gBACD,OAAO,aAAa,CAAC;YACvB,CAAC,CAAC,CAAC;YACH,MAAM,eAAe,GAAG,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;gBACzD,MAAM,aAAa,GAAG;oBACpB,OAAO,EAAE,MAAM,CAAC,OAAO;oBACvB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;iBAC9B,CAAC;gBACF,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;oBACrB,aAAa,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC;gBAChD,CAAC;gBACD,OAAO,aAAa,CAAC;YACvB,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,eAAe,EAAE,kBAAkB,CAAC,EAAE,CAAC;gBACpD,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAC;YACjF,CAAC;YACD,eAAe;YACf,IAAI,SAAS,GAAG,EAAE,CAAC;YACnB,IAAI,UAAU,GAAG,EAAE,CAAC;YACpB,IAAI,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACvB,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC;YACzB,CAAC;iBAAM,IAAI,QAAQ,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;gBACtC,MAAM,cAAc,GAAG,IAAA,0CAAkC,EAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;gBAC1F,SAAS,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;YACjE,CAAC;YACD,IAAI,WAAW,CAAC,IAAI,EAAE,CAAC;gBACrB,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC;YAChC,CAAC;YACD,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,SAAS,EAAE,UAAU,CAAC,EAAE,CAAC;gBACtC,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAC;YAClF,CAAC;YACD,sBAAsB;YACtB,IAAI,WAAW,GAAG,IAAI,sBAAS,CAAC,CAAC,CAAC,CAAC;YACnC,KAAK,MAAM,UAAU,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC;gBAC7C,WAAW,GAAG,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YACpD,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,EAAE,CAAC;gBACrD,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAC;YACrF,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAnID,gCAmIC","sourcesContent":["import _ from 'lodash';\nimport BigNumber from 'bignumber.js';\n\nimport { BitGoBase, CoinConstructor, NamedCoinConstructor, VerifyTransactionOptions } from '@bitgo-beta/sdk-core';\nimport { BaseCoin as StaticsBaseCoin, coins, NetworkType, Sip10TokenConfig, tokens } from '@bitgo-beta/statics';\n\nimport { Stx } from './stx';\nimport { TransactionBuilderFactory } from './lib';\nimport { TransactionBuilder } from './lib/transactionBuilder';\nimport { getMemoIdAndBaseAddressFromAddress } from './lib/utils';\n\nexport class Sip10Token extends Stx {\n  public readonly tokenConfig: Sip10TokenConfig;\n\n  constructor(bitgo: BitGoBase, tokenConfig: Sip10TokenConfig) {\n    const staticsCoin = tokenConfig.network === NetworkType.MAINNET ? coins.get('stx') : coins.get('tstx');\n    super(bitgo, staticsCoin);\n    this.tokenConfig = tokenConfig;\n  }\n\n  static createTokenConstructor(config: Sip10TokenConfig): CoinConstructor {\n    return (bitgo: BitGoBase) => new Sip10Token(bitgo, config);\n  }\n\n  static createTokenConstructors(\n    tokenConfigs: Sip10TokenConfig[] = [...tokens.bitcoin.stx.tokens, ...tokens.testnet.stx.tokens]\n  ): NamedCoinConstructor[] {\n    const tokensCtors: NamedCoinConstructor[] = [];\n    for (const token of tokenConfigs) {\n      const tokenConstructor = Sip10Token.createTokenConstructor(token);\n      tokensCtors.push({ name: token.type, coinConstructor: tokenConstructor });\n    }\n    return tokensCtors;\n  }\n\n  get name(): string {\n    return this.tokenConfig.name;\n  }\n\n  get coin(): string {\n    return this.tokenConfig.coin;\n  }\n\n  get network(): string {\n    return this.tokenConfig.network;\n  }\n\n  get assetId(): string {\n    return this.tokenConfig.assetId;\n  }\n\n  get decimalPlaces(): number {\n    return this.tokenConfig.decimalPlaces;\n  }\n\n  getChain(): string {\n    return this.tokenConfig.type;\n  }\n\n  getBaseChain(): string {\n    return this.coin;\n  }\n\n  getFullName(): string {\n    return 'Sip10 Token';\n  }\n\n  getBaseFactor(): number {\n    return Math.pow(10, this.tokenConfig.decimalPlaces);\n  }\n\n  getTransaction(coinConfig: Readonly<StaticsBaseCoin>): TransactionBuilder {\n    return new TransactionBuilderFactory(coinConfig).getFungibleTokenTransferBuilder();\n  }\n\n  async verifyTransaction(params: VerifyTransactionOptions): Promise<boolean> {\n    const { txPrebuild: txPrebuild, txParams: txParams } = params;\n    const { memo } = txParams;\n    if (Array.isArray(txParams.recipients) && txParams.recipients.length > 1) {\n      throw new Error(\n        `${this.getChain()} doesn't support sending to more than 1 destination address within a single transaction. Try again, using only a single recipient.`\n      );\n    }\n    const rawTx = txPrebuild.txHex;\n    if (!rawTx) {\n      throw new Error('missing required tx prebuild property txHex');\n    }\n    const coinConfig = coins.get(this.getChain());\n    const transaction = this.getTransaction(coinConfig);\n    transaction.from(rawTx);\n    const explainedTx = await this.explainTransaction({ txHex: rawTx, feeInfo: { fee: '' } });\n    if (txParams.recipients !== undefined && explainedTx) {\n      const filteredRecipients = txParams.recipients?.map((recipient) => {\n        const addressDetails = getMemoIdAndBaseAddressFromAddress(recipient.address);\n        const recipientData = {\n          address: addressDetails.address,\n          amount: BigInt(recipient.amount),\n        };\n        if (recipient.tokenName) {\n          recipientData['tokenName'] = recipient.tokenName;\n        }\n        return recipientData;\n      });\n      const filteredOutputs = explainedTx.outputs.map((output) => {\n        const recipientData = {\n          address: output.address,\n          amount: BigInt(output.amount),\n        };\n        if (output.tokenName) {\n          recipientData['tokenName'] = output.tokenName;\n        }\n        return recipientData;\n      });\n      if (!_.isEqual(filteredOutputs, filteredRecipients)) {\n        throw new Error('Tx outputs does not match with expected txParams recipients');\n      }\n      // compare memo\n      let memoInput = '';\n      let memoOutput = '';\n      if (memo && memo.value) {\n        memoInput = memo.value;\n      } else if (txParams.recipients.length) {\n        const addressDetails = getMemoIdAndBaseAddressFromAddress(txParams.recipients[0].address);\n        memoInput = addressDetails.memoId ? addressDetails.memoId : '';\n      }\n      if (explainedTx.memo) {\n        memoOutput = explainedTx.memo;\n      }\n      if (!_.isEqual(memoInput, memoOutput)) {\n        throw new Error('Tx memo does not match with expected txParams recipient memo');\n      }\n      // compare send amount\n      let totalAmount = new BigNumber(0);\n      for (const recipients of txParams.recipients) {\n        totalAmount = totalAmount.plus(recipients.amount);\n      }\n      if (!totalAmount.isEqualTo(explainedTx.outputAmount)) {\n        throw new Error('Tx total amount does not match with expected total amount field');\n      }\n    }\n    return true;\n  }\n}\n"]}
package/dist/src/stx.d.ts CHANGED
@@ -1,7 +1,10 @@
1
- /// <reference types="node" />
2
- import { BaseCoin, BitGoBase, KeyPair, SignedTransaction, VerifyAddressOptions, VerifyTransactionOptions } from '@bitgo-beta/sdk-core';
1
+ import { BaseCoin, BaseTransaction, BitGoBase, KeyPair, MultisigType, SignedTransaction, VerifyAddressOptions, VerifyTransactionOptions } from '@bitgo-beta/sdk-core';
3
2
  import { BaseCoin as StaticsBaseCoin, CoinFamily } from '@bitgo-beta/statics';
4
3
  import { ExplainTransactionOptions, StxSignTransactionOptions, StxTransactionExplanation } from './types';
4
+ import { TransactionBuilder } from './lib/transactionBuilder';
5
+ import { AddressDetails, NativeStxBalance, RecoveryInfo, RecoveryOptions, RecoveryTransaction, SingleFungibleTokenBalance, StxNonceResponse } from './lib/iface';
6
+ import { TransferBuilder } from './lib/transferBuilder';
7
+ import { FungibleTokenTransferBuilder } from './lib/fungibleTokenTransferBuilder';
5
8
  export declare class Stx extends BaseCoin {
6
9
  protected readonly _staticsCoin: Readonly<StaticsBaseCoin>;
7
10
  constructor(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>);
@@ -10,6 +13,11 @@ export declare class Stx extends BaseCoin {
10
13
  getFamily(): CoinFamily;
11
14
  getFullName(): string;
12
15
  getBaseFactor(): string | number;
16
+ getTransaction(coinConfig: Readonly<StaticsBaseCoin>): TransactionBuilder;
17
+ /** {@inheritDoc } **/
18
+ supportsMultisig(): boolean;
19
+ /** inherited doc */
20
+ getDefaultMultisigType(): MultisigType;
13
21
  verifyTransaction(params: VerifyTransactionOptions): Promise<boolean>;
14
22
  /**
15
23
  * Check if address is valid, then make sure it matches the base address.
@@ -52,5 +60,141 @@ export declare class Stx extends BaseCoin {
52
60
  * @param params
53
61
  */
54
62
  explainTransaction(params: ExplainTransactionOptions): Promise<StxTransactionExplanation | undefined>;
63
+ /**
64
+ * Get URLs of some active public nodes
65
+ * @returns {String} node url
66
+ */
67
+ getPublicNodeUrl(): string;
68
+ /**
69
+ * Get native stacks balance for an account
70
+ * @param {String} address - stacks address
71
+ * @returns {Promise<NativeStxBalance>}
72
+ */
73
+ protected getNativeStxBalanceFromNode({ address }: {
74
+ address: string;
75
+ }): Promise<NativeStxBalance>;
76
+ /**
77
+ * Get single fungible token balance for an account
78
+ * @param {String} address - stacks address
79
+ * @param {String} assetId - fungible token asset id
80
+ * @returns {Promise<SingleFungibleTokenBalance>}
81
+ */
82
+ protected getSingleFungibleTokenBalanceFromNode({ address, assetId, }: {
83
+ address: string;
84
+ assetId: string;
85
+ }): Promise<SingleFungibleTokenBalance>;
86
+ /**
87
+ * Get nonce data specific to an account from a public node
88
+ * @param {String} address - stacks address
89
+ * @returns {Promise<StxNonceResponse>}
90
+ */
91
+ protected getAccountNonceFromNode({ address }: {
92
+ address: string;
93
+ }): Promise<StxNonceResponse>;
94
+ /**
95
+ * Get stacks transaction estimated fee
96
+ * @param {String} txHex - hex of stacks transaction payload
97
+ * @param {Number} txHexLength - length of built serialized transaction
98
+ * @returns {Promise<Number>} - fee estimate (taking the lowest)
99
+ */
100
+ protected getTransactionFeeEstimation({ txHex, txHexLength, }: {
101
+ txHex: string;
102
+ txHexLength: number;
103
+ }): Promise<number>;
104
+ /**
105
+ * Format for offline vault signing
106
+ * @param {BaseTransaction} tx - base transaction
107
+ * @returns {Promise<RecoveryInfo>}
108
+ */
109
+ protected formatForOfflineVault(tx: BaseTransaction): Promise<RecoveryInfo>;
110
+ /**
111
+ * Get the recoverable amount & fee after subtracting the txn fee
112
+ * @param {String} serializedHex - serialized txn hex
113
+ * @param {Number} txHexLength - deserialized txn length
114
+ * @param {String} balance - total account balance
115
+ * @param {String} tokenBalance - total token balance
116
+ * @returns {Promise<Record<string, string>>}
117
+ */
118
+ protected getRecoverableAmountAndFee(serializedHex: string, txHexLength: number, balance: string, tokenBalance?: string): Promise<Record<string, string>>;
119
+ /**
120
+ * Method to find the right builder for token or native coin transfer
121
+ * @param {String} contractAddress - token contract address
122
+ * @param {String} contractName - token contract name
123
+ * @returns {TransferBuilder|FungibleTokenTransferBuilder}
124
+ */
125
+ protected getTokenOrNativeTransferBuilder(contractAddress?: string, contractName?: string): TransferBuilder | FungibleTokenTransferBuilder;
126
+ /**
127
+ * Method to build fungible token transfer transaction
128
+ * @param {FungibleTokenTransferBuilder} builder - fungible token transfer builder
129
+ * @param {String} contractAddress - token contract address
130
+ * @param {String} contractName - token contract name
131
+ * @param {String[]} pubs - account public keys
132
+ * @param {Number} nonce - account nonce
133
+ * @param {AddressDetails} rootAddressDetails - root address details
134
+ * @param {AddressDetails} destinationAddressDetails - receive address details
135
+ * @param {String} stxBalance - native stx balance
136
+ * @returns {Promise<BaseTransaction>} - built transaction
137
+ */
138
+ protected buildTokenTransferTransaction({ builder, contractAddress, contractName, pubs, nonce, rootAddressDetails, destinationAddressDetails, stxBalance, }: {
139
+ builder: FungibleTokenTransferBuilder;
140
+ contractAddress: string;
141
+ contractName: string;
142
+ pubs: string[];
143
+ nonce: number;
144
+ rootAddressDetails: AddressDetails;
145
+ destinationAddressDetails: AddressDetails;
146
+ stxBalance: string;
147
+ }): Promise<BaseTransaction>;
148
+ /**
149
+ * Method to build native transfer transaction
150
+ * @param {TransferBuilder} builder - transfer builder
151
+ * @param {String[]} pubs - account public keys
152
+ * @param {Number} nonce - account nonce
153
+ * @param {AddressDetails} destinationAddressDetails - receive address details
154
+ * @param {String} stxBalance - native stx balance
155
+ * @returns {Promise<BaseTransaction>} - built transaction
156
+ */
157
+ protected buildNativeTransferTransaction({ builder, pubs, nonce, destinationAddressDetails, stxBalance, }: {
158
+ builder: TransferBuilder;
159
+ pubs: string[];
160
+ nonce: number;
161
+ destinationAddressDetails: AddressDetails;
162
+ stxBalance: string;
163
+ }): Promise<BaseTransaction>;
164
+ /**
165
+ * Method that uses appropriate builder and builds transaction depending on token or native coin
166
+ * @param {String[]} pubs - public keys
167
+ * @param {AddressDetails} rootAddressDetails - sender address detail
168
+ * @param {AddressDetails} destinationAddressDetails - receiver address detail
169
+ * @param {Number} nonce - wallet nonce
170
+ * @param {String} balance - wallet balance
171
+ * @param {String | undefined} contractAddress - token contract address
172
+ * @param {String | undefined} contractName - token contract name
173
+ * @returns {Promise<BaseTransaction>} built transaction
174
+ */
175
+ protected getNativeOrTokenTransaction({ pubs, rootAddressDetails, destinationAddressDetails, nonce, stxBalance, contractAddressInput, contractName, }: {
176
+ pubs: string[];
177
+ rootAddressDetails: AddressDetails;
178
+ destinationAddressDetails: AddressDetails;
179
+ nonce: number;
180
+ stxBalance: string;
181
+ contractAddressInput?: string;
182
+ contractName?: string;
183
+ }): Promise<{
184
+ tx: BaseTransaction;
185
+ builder: TransferBuilder | FungibleTokenTransferBuilder;
186
+ }>;
187
+ /**
188
+ * Method to recover native stx or sip10 tokens from bitgo hot & cold wallets
189
+ * @param {String} params.backupKey - encrypted wallet backup key (public or private)
190
+ * @param {String} params.userKey - encrypted wallet user key (public or private)
191
+ * @param {String} params.rootAddress - wallet root address
192
+ * @param {String} params.recoveryDestination - receive address
193
+ * @param {String} params.bitgoKey - encrypted bitgo public key
194
+ * @param {String} params.walletPassphrase - wallet password
195
+ * @param {String} params.contractId - contract id of the token (mandatory for token recovery)
196
+ * @returns {Promise<RecoveryInfo|RecoveryTransaction>} RecoveryTransaction.txHex - hex of serialized transaction (signed or unsigned)
197
+ */
198
+ recover(params: RecoveryOptions): Promise<RecoveryInfo | RecoveryTransaction>;
55
199
  }
56
200
  //# sourceMappingURL=stx.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"stx.d.ts","sourceRoot":"","sources":["../../src/stx.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,QAAQ,EACR,SAAS,EACT,OAAO,EACP,iBAAiB,EAGjB,oBAAoB,EACpB,wBAAwB,EACzB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,QAAQ,IAAI,eAAe,EAAE,UAAU,EAAS,MAAM,qBAAqB,CAAC;AACrF,OAAO,EAAE,yBAAyB,EAAE,yBAAyB,EAAE,yBAAyB,EAAE,MAAM,SAAS,CAAC;AAG1G,qBAAa,GAAI,SAAQ,QAAQ;IAC/B,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;gBAE/C,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC;IAUrE,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC,GAAG,QAAQ;IAI1F,QAAQ,IAAI,MAAM;IAIlB,SAAS,IAAI,UAAU;IAIvB,WAAW,IAAI,MAAM;IAIrB,aAAa,IAAI,MAAM,GAAG,MAAM;IAI1B,iBAAiB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,OAAO,CAAC;IAK3E;;;;;;OAMG;IACG,eAAe,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAWrE;;;;;OAKG;IACH,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO;IAcvC;;;;;OAKG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAQhC;;;;;OAKG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAQhC,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAQxC;;;OAGG;IACG,eAAe,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAkB9E,gBAAgB,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAIjD;;;OAGG;IACG,kBAAkB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,yBAAyB,GAAG,SAAS,CAAC;CAqE5G"}
1
+ {"version":3,"file":"stx.d.ts","sourceRoot":"","sources":["../../src/stx.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EACR,eAAe,EACf,SAAS,EAIT,OAAO,EACP,YAAY,EAEZ,iBAAiB,EAGjB,oBAAoB,EACpB,wBAAwB,EACzB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,QAAQ,IAAI,eAAe,EAAE,UAAU,EAAS,MAAM,qBAAqB,CAAC;AAoBrF,OAAO,EAAE,yBAAyB,EAAE,yBAAyB,EAAE,yBAAyB,EAAE,MAAM,SAAS,CAAC;AAG1G,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAE9D,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,YAAY,EACZ,eAAe,EACf,mBAAmB,EACnB,0BAA0B,EAC1B,gBAAgB,EAGjB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,4BAA4B,EAAE,MAAM,oCAAoC,CAAC;AAElF,qBAAa,GAAI,SAAQ,QAAQ;IAC/B,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;gBAE/C,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC;IAUrE,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC,GAAG,QAAQ;IAI1F,QAAQ,IAAI,MAAM;IAIlB,SAAS,IAAI,UAAU;IAIvB,WAAW,IAAI,MAAM;IAIrB,aAAa,IAAI,MAAM,GAAG,MAAM;IAIhC,cAAc,CAAC,UAAU,EAAE,QAAQ,CAAC,eAAe,CAAC,GAAG,kBAAkB;IAIzE,sBAAsB;IACtB,gBAAgB,IAAI,OAAO;IAI3B,oBAAoB;IACpB,sBAAsB,IAAI,YAAY;IAIhC,iBAAiB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,OAAO,CAAC;IAU3E;;;;;;OAMG;IACG,eAAe,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAWrE;;;;;OAKG;IACH,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO;IAcvC;;;;;OAKG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAQhC;;;;;OAKG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAQhC,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAQxC;;;OAGG;IACG,eAAe,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAoB9E,gBAAgB,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAIjD;;;OAGG;IACG,kBAAkB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,yBAAyB,GAAG,SAAS,CAAC;IA2F3G;;;OAGG;IACH,gBAAgB,IAAI,MAAM;IAI1B;;;;OAIG;cACa,2BAA2B,CAAC,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAcxG;;;;;OAKG;cACa,qCAAqC,CAAC,EACpD,OAAO,EACP,OAAO,GACR,EAAE;QACD,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAcvC;;;;OAIG;cACa,uBAAuB,CAAC,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAcpG;;;;;OAKG;cACa,2BAA2B,CAAC,EAC1C,KAAK,EACL,WAAW,GACZ,EAAE;QACD,KAAK,EAAE,MAAM,CAAC;QACd,WAAW,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,MAAM,CAAC;IAqBnB;;;;OAIG;cACa,qBAAqB,CAAC,EAAE,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,CAAC;IAYjF;;;;;;;OAOG;cACa,0BAA0B,CACxC,aAAa,EAAE,MAAM,EACrB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EACf,YAAY,CAAC,EAAE,MAAM,GACpB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAgBlC;;;;;OAKG;IACH,SAAS,CAAC,+BAA+B,CACvC,eAAe,CAAC,EAAE,MAAM,EACxB,YAAY,CAAC,EAAE,MAAM,GACpB,eAAe,GAAG,4BAA4B;IAqBjD;;;;;;;;;;;OAWG;cACa,6BAA6B,CAAC,EAC5C,OAAO,EACP,eAAe,EACf,YAAY,EACZ,IAAI,EACJ,KAAK,EACL,kBAAkB,EAClB,yBAAyB,EACzB,UAAU,GACX,EAAE;QACD,OAAO,EAAE,4BAA4B,CAAC;QACtC,eAAe,EAAE,MAAM,CAAC;QACxB,YAAY,EAAE,MAAM,CAAC;QACrB,IAAI,EAAE,MAAM,EAAE,CAAC;QACf,KAAK,EAAE,MAAM,CAAC;QACd,kBAAkB,EAAE,cAAc,CAAC;QACnC,yBAAyB,EAAE,cAAc,CAAC;QAC1C,UAAU,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,eAAe,CAAC;IAuD5B;;;;;;;;OAQG;cACa,8BAA8B,CAAC,EAC7C,OAAO,EACP,IAAI,EACJ,KAAK,EACL,yBAAyB,EACzB,UAAU,GACX,EAAE;QACD,OAAO,EAAE,eAAe,CAAC;QACzB,IAAI,EAAE,MAAM,EAAE,CAAC;QACf,KAAK,EAAE,MAAM,CAAC;QACd,yBAAyB,EAAE,cAAc,CAAC;QAC1C,UAAU,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,eAAe,CAAC;IAyB5B;;;;;;;;;;OAUG;cACa,2BAA2B,CAAC,EAC1C,IAAI,EACJ,kBAAkB,EAClB,yBAAyB,EACzB,KAAK,EACL,UAAU,EACV,oBAAoB,EACpB,YAAY,GACb,EAAE;QACD,IAAI,EAAE,MAAM,EAAE,CAAC;QACf,kBAAkB,EAAE,cAAc,CAAC;QACnC,yBAAyB,EAAE,cAAc,CAAC;QAC1C,KAAK,EAAE,MAAM,CAAC;QACd,UAAU,EAAE,MAAM,CAAC;QACnB,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAC9B,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,GAAG,OAAO,CAAC;QAAE,EAAE,EAAE,eAAe,CAAC;QAAC,OAAO,EAAE,eAAe,GAAG,4BAA4B,CAAA;KAAE,CAAC;IA+B7F;;;;;;;;;;OAUG;IACG,OAAO,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,GAAG,mBAAmB,CAAC;CAyEpF"}