@bitgo-beta/sdk-coin-stx 1.1.1-beta.232 → 1.1.1-beta.2321

package/dist/src/register.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"register.d.ts","sourceRoot":"","sources":["../../src/register.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAIjD,eAAO,MAAM,QAAQ,QAAS,SAAS,KAAG,IAGzC,CAAC"}
+{"version":3,"file":"register.d.ts","sourceRoot":"","sources":["../../src/register.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAMjD,eAAO,MAAM,QAAQ,QAAS,SAAS,KAAG,IAOzC,CAAC"}

package/dist/src/register.js

@@ -3,9 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.register = void 0;
 const stx_1 = require("./stx");
 const tstx_1 = require("./tstx");
+const tstxsignet_1 = require("./tstxsignet");
+const sip10Token_1 = require("./sip10Token");
 const register = (sdk) => {
     sdk.register('stx', stx_1.Stx.createInstance);
     sdk.register('tstx', tstx_1.Tstx.createInstance);
+    sdk.register('tstxsignet', tstxsignet_1.Tstxsignet.createInstance);
+    sip10Token_1.Sip10Token.createTokenConstructors().forEach(({ name, coinConstructor }) => {
+        sdk.register(name, coinConstructor);
+    });
 };
 exports.register = register;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVnaXN0ZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvcmVnaXN0ZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQ0EsK0JBQTRCO0FBQzVCLGlDQUE4QjtBQUV2QixNQUFNLFFBQVEsR0FBRyxDQUFDLEdBQWMsRUFBUSxFQUFFO0lBQy9DLEdBQUcsQ0FBQyxRQUFRLENBQUMsS0FBSyxFQUFFLFNBQUcsQ0FBQyxjQUFjLENBQUMsQ0FBQztJQUN4QyxHQUFHLENBQUMsUUFBUSxDQUFDLE1BQU0sRUFBRSxXQUFJLENBQUMsY0FBYyxDQUFDLENBQUM7QUFDNUMsQ0FBQyxDQUFDO0FBSFcsUUFBQSxRQUFRLFlBR25CIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgQml0R29CYXNlIH0gZnJvbSAnQGJpdGdvLWJldGEvc2RrLWNvcmUnO1xuaW1wb3J0IHsgU3R4IH0gZnJvbSAnLi9zdHgnO1xuaW1wb3J0IHsgVHN0eCB9IGZyb20gJy4vdHN0eCc7XG5cbmV4cG9ydCBjb25zdCByZWdpc3RlciA9IChzZGs6IEJpdEdvQmFzZSk6IHZvaWQgPT4ge1xuICBzZGsucmVnaXN0ZXIoJ3N0eCcsIFN0eC5jcmVhdGVJbnN0YW5jZSk7XG4gIHNkay5yZWdpc3RlcigndHN0eCcsIFRzdHguY3JlYXRlSW5zdGFuY2UpO1xufTtcbiJdfQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVnaXN0ZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvcmVnaXN0ZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQ0EsK0JBQTRCO0FBQzVCLGlDQUE4QjtBQUM5Qiw2Q0FBMEM7QUFDMUMsNkNBQTBDO0FBRW5DLE1BQU0sUUFBUSxHQUFHLENBQUMsR0FBYyxFQUFRLEVBQUU7SUFDL0MsR0FBRyxDQUFDLFFBQVEsQ0FBQyxLQUFLLEVBQUUsU0FBRyxDQUFDLGNBQWMsQ0FBQyxDQUFDO0lBQ3hDLEdBQUcsQ0FBQyxRQUFRLENBQUMsTUFBTSxFQUFFLFdBQUksQ0FBQyxjQUFjLENBQUMsQ0FBQztJQUMxQyxHQUFHLENBQUMsUUFBUSxDQUFDLFlBQVksRUFBRSx1QkFBVSxDQUFDLGNBQWMsQ0FBQyxDQUFDO0lBQ3RELHVCQUFVLENBQUMsdUJBQXVCLEVBQUUsQ0FBQyxPQUFPLENBQUMsQ0FBQyxFQUFFLElBQUksRUFBRSxlQUFlLEVBQUUsRUFBRSxFQUFFO1FBQ3pFLEdBQUcsQ0FBQyxRQUFRLENBQUMsSUFBSSxFQUFFLGVBQWUsQ0FBQyxDQUFDO0lBQ3RDLENBQUMsQ0FBQyxDQUFDO0FBQ0wsQ0FBQyxDQUFDO0FBUFcsUUFBQSxRQUFRLFlBT25CIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgQml0R29CYXNlIH0gZnJvbSAnQGJpdGdvLWJldGEvc2RrLWNvcmUnO1xuaW1wb3J0IHsgU3R4IH0gZnJvbSAnLi9zdHgnO1xuaW1wb3J0IHsgVHN0eCB9IGZyb20gJy4vdHN0eCc7XG5pbXBvcnQgeyBUc3R4c2lnbmV0IH0gZnJvbSAnLi90c3R4c2lnbmV0JztcbmltcG9ydCB7IFNpcDEwVG9rZW4gfSBmcm9tICcuL3NpcDEwVG9rZW4nO1xuXG5leHBvcnQgY29uc3QgcmVnaXN0ZXIgPSAoc2RrOiBCaXRHb0Jhc2UpOiB2b2lkID0+IHtcbiAgc2RrLnJlZ2lzdGVyKCdzdHgnLCBTdHguY3JlYXRlSW5zdGFuY2UpO1xuICBzZGsucmVnaXN0ZXIoJ3RzdHgnLCBUc3R4LmNyZWF0ZUluc3RhbmNlKTtcbiAgc2RrLnJlZ2lzdGVyKCd0c3R4c2lnbmV0JywgVHN0eHNpZ25ldC5jcmVhdGVJbnN0YW5jZSk7XG4gIFNpcDEwVG9rZW4uY3JlYXRlVG9rZW5Db25zdHJ1Y3RvcnMoKS5mb3JFYWNoKCh7IG5hbWUsIGNvaW5Db25zdHJ1Y3RvciB9KSA9PiB7XG4gICAgc2RrLnJlZ2lzdGVyKG5hbWUsIGNvaW5Db25zdHJ1Y3Rvcik7XG4gIH0pO1xufTtcbiJdfQ==

package/dist/src/sip10Token.d.ts

@@ -0,0 +1,22 @@
+import { BitGoBase, CoinConstructor, NamedCoinConstructor, VerifyTransactionOptions } from '@bitgo-beta/sdk-core';
+import { BaseCoin as StaticsBaseCoin, Sip10TokenConfig } from '@bitgo-beta/statics';
+import { Stx } from './stx';
+import { TransactionBuilder } from './lib/transactionBuilder';
+export declare class Sip10Token extends Stx {
+    readonly tokenConfig: Sip10TokenConfig;
+    constructor(bitgo: BitGoBase, tokenConfig: Sip10TokenConfig);
+    static createTokenConstructor(config: Sip10TokenConfig): CoinConstructor;
+    static createTokenConstructors(tokenConfigs?: Sip10TokenConfig[]): NamedCoinConstructor[];
+    get name(): string;
+    get coin(): string;
+    get network(): string;
+    get assetId(): string;
+    get decimalPlaces(): number;
+    getChain(): string;
+    getBaseChain(): string;
+    getFullName(): string;
+    getBaseFactor(): number;
+    getTransaction(coinConfig: Readonly<StaticsBaseCoin>): TransactionBuilder;
+    verifyTransaction(params: VerifyTransactionOptions): Promise<boolean>;
+}
+//# sourceMappingURL=sip10Token.d.ts.map

package/dist/src/sip10Token.d.ts.map

@@ -0,0 +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,EAAS,gBAAgB,EAAU,MAAM,qBAAqB,CAAC;AAEnG,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;IAQ3D,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"}

package/dist/src/sip10Token.js

@@ -0,0 +1,130 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Sip10Token = void 0;
+const lodash_1 = __importDefault(require("lodash"));
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const statics_1 = require("@bitgo-beta/statics");
+const stx_1 = require("./stx");
+const lib_1 = require("./lib");
+const utils_1 = require("./lib/utils");
+class Sip10Token extends stx_1.Stx {
+    constructor(bitgo, tokenConfig) {
+        // tokenConfig.coin is derived by statics from the token's network, so it stays correct for
+        // deployments beyond the stock mainnet/testnet pair (e.g. tstxsignet, chain ID 1280).
+        const staticsCoin = statics_1.coins.get(tokenConfig.coin);
+        super(bitgo, staticsCoin);
+        this.tokenConfig = tokenConfig;
+    }
+    static createTokenConstructor(config) {
+        return (bitgo) => new Sip10Token(bitgo, config);
+    }
+    static createTokenConstructors(tokenConfigs = [...statics_1.tokens.bitcoin.stx.tokens, ...statics_1.tokens.testnet.stx.tokens]) {
+        const tokensCtors = [];
+        for (const token of tokenConfigs) {
+            const tokenConstructor = Sip10Token.createTokenConstructor(token);
+            tokensCtors.push({ name: token.type, coinConstructor: tokenConstructor });
+        }
+        return tokensCtors;
+    }
+    get name() {
+        return this.tokenConfig.name;
+    }
+    get coin() {
+        return this.tokenConfig.coin;
+    }
+    get network() {
+        return this.tokenConfig.network;
+    }
+    get assetId() {
+        return this.tokenConfig.assetId;
+    }
+    get decimalPlaces() {
+        return this.tokenConfig.decimalPlaces;
+    }
+    getChain() {
+        return this.tokenConfig.type;
+    }
+    getBaseChain() {
+        return this.coin;
+    }
+    getFullName() {
+        return 'Sip10 Token';
+    }
+    getBaseFactor() {
+        return Math.pow(10, this.tokenConfig.decimalPlaces);
+    }
+    getTransaction(coinConfig) {
+        return new lib_1.TransactionBuilderFactory(coinConfig).getFungibleTokenTransferBuilder();
+    }
+    async verifyTransaction(params) {
+        const { txPrebuild: txPrebuild, txParams: txParams } = params;
+        const { memo } = txParams;
+        if (Array.isArray(txParams.recipients) && txParams.recipients.length > 1) {
+            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.`);
+        }
+        const rawTx = txPrebuild.txHex;
+        if (!rawTx) {
+            throw new Error('missing required tx prebuild property txHex');
+        }
+        const coinConfig = statics_1.coins.get(this.getChain());
+        const transaction = this.getTransaction(coinConfig);
+        transaction.from(rawTx);
+        const explainedTx = await this.explainTransaction({ txHex: rawTx, feeInfo: { fee: '' } });
+        if (txParams.recipients !== undefined && explainedTx) {
+            const filteredRecipients = txParams.recipients?.map((recipient) => {
+                const addressDetails = (0, utils_1.getMemoIdAndBaseAddressFromAddress)(recipient.address);
+                const recipientData = {
+                    address: addressDetails.address,
+                    amount: BigInt(recipient.amount),
+                };
+                if (recipient.tokenName) {
+                    recipientData['tokenName'] = recipient.tokenName;
+                }
+                return recipientData;
+            });
+            const filteredOutputs = explainedTx.outputs.map((output) => {
+                const recipientData = {
+                    address: output.address,
+                    amount: BigInt(output.amount),
+                };
+                if (output.tokenName) {
+                    recipientData['tokenName'] = output.tokenName;
+                }
+                return recipientData;
+            });
+            if (!lodash_1.default.isEqual(filteredOutputs, filteredRecipients)) {
+                throw new Error('Tx outputs does not match with expected txParams recipients');
+            }
+            // compare memo
+            let memoInput = '';
+            let memoOutput = '';
+            if (memo && memo.value) {
+                memoInput = memo.value;
+            }
+            else if (txParams.recipients.length) {
+                const addressDetails = (0, utils_1.getMemoIdAndBaseAddressFromAddress)(txParams.recipients[0].address);
+                memoInput = addressDetails.memoId ? addressDetails.memoId : '';
+            }
+            if (explainedTx.memo) {
+                memoOutput = explainedTx.memo;
+            }
+            if (!lodash_1.default.isEqual(memoInput, memoOutput)) {
+                throw new Error('Tx memo does not match with expected txParams recipient memo');
+            }
+            // compare send amount
+            let totalAmount = new bignumber_js_1.default(0);
+            for (const recipients of txParams.recipients) {
+                totalAmount = totalAmount.plus(recipients.amount);
+            }
+            if (!totalAmount.isEqualTo(explainedTx.outputAmount)) {
+                throw new Error('Tx total amount does not match with expected total amount field');
+            }
+        }
+        return true;
+    }
+}
+exports.Sip10Token = Sip10Token;
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"sip10Token.js","sourceRoot":"","sources":["../../src/sip10Token.ts"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AACvB,gEAAqC;AAGrC,iDAAmG;AAEnG,+BAA4B;AAC5B,+BAAkD;AAElD,uCAAiE;AAEjE,MAAa,UAAW,SAAQ,SAAG;IAGjC,YAAY,KAAgB,EAAE,WAA6B;QACzD,2FAA2F;QAC3F,sFAAsF;QACtF,MAAM,WAAW,GAAG,eAAK,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAChD,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;AArID,gCAqIC","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, 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    // tokenConfig.coin is derived by statics from the token's network, so it stays correct for\n    // deployments beyond the stock mainnet/testnet pair (e.g. tstxsignet, chain ID 1280).\n    const staticsCoin = coins.get(tokenConfig.coin);\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

@@ -1,7 +1,10 @@
-/// <reference types="node" />
-import { BaseCoin, BitGoBase, KeyPair, SignedTransaction, VerifyAddressOptions, VerifyTransactionOptions } from '@bitgo-beta/sdk-core';
+import { AuditDecryptedKeyParams, BaseCoin, BaseTransaction, BitGoBase, KeyPair, MultisigType, SignedTransaction, VerifyAddressOptions, VerifyTransactionOptions } from '@bitgo-beta/sdk-core';
 import { BaseCoin as StaticsBaseCoin, CoinFamily } from '@bitgo-beta/statics';
 import { ExplainTransactionOptions, StxSignTransactionOptions, StxTransactionExplanation } from './types';
+import { TransactionBuilder } from './lib/transactionBuilder';
+import { AddressDetails, NativeStxBalance, RecoveryInfo, RecoveryOptions, RecoveryTransaction, SingleFungibleTokenBalance, StxNonceResponse } from './lib/iface';
+import { TransferBuilder } from './lib/transferBuilder';
+import { FungibleTokenTransferBuilder } from './lib/fungibleTokenTransferBuilder';
 export declare class Stx extends BaseCoin {
     protected readonly _staticsCoin: Readonly<StaticsBaseCoin>;
     constructor(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>);
@@ -10,7 +13,18 @@ export declare class Stx extends BaseCoin {
     getFamily(): CoinFamily;
     getFullName(): string;
     getBaseFactor(): string | number;
+    getTransaction(coinConfig: Readonly<StaticsBaseCoin>): TransactionBuilder;
+    /** inherited doc */
+    getDefaultMultisigType(): MultisigType;
     verifyTransaction(params: VerifyTransactionOptions): Promise<boolean>;
+    private hasSbtcWithdrawParams;
+    /**
+     * Verify an sBTC withdrawal (burn) transaction matches the expected withdrawal params.
+     *
+     * @param rawTx - the raw (built) transaction hex from txPrebuild
+     * @param expected - the sbtcWithdrawParams supplied by the caller in txParams
+     */
+    private verifySbtcWithdrawTransaction;
     /**
      * Check if address is valid, then make sure it matches the base address.
      *
@@ -52,5 +66,143 @@ export declare class Stx extends BaseCoin {
      * @param params
      */
     explainTransaction(params: ExplainTransactionOptions): Promise<StxTransactionExplanation | undefined>;
+    /**
+     * Get URLs of some active public nodes
+     * @returns {String} node url
+     */
+    getPublicNodeUrl(): string;
+    /**
+     * Get native stacks balance for an account
+     * @param {String} address - stacks address
+     * @returns {Promise<NativeStxBalance>}
+     */
+    protected getNativeStxBalanceFromNode({ address }: {
+        address: string;
+    }): Promise<NativeStxBalance>;
+    /**
+     * Get single fungible token balance for an account
+     * @param {String} address - stacks address
+     * @param {String} assetId - fungible token asset id
+     * @returns {Promise<SingleFungibleTokenBalance>}
+     */
+    protected getSingleFungibleTokenBalanceFromNode({ address, assetId, }: {
+        address: string;
+        assetId: string;
+    }): Promise<SingleFungibleTokenBalance>;
+    /**
+     * Get nonce data specific to an account from a public node
+     * @param {String} address - stacks address
+     * @returns {Promise<StxNonceResponse>}
+     */
+    protected getAccountNonceFromNode({ address }: {
+        address: string;
+    }): Promise<StxNonceResponse>;
+    /**
+     * Get stacks transaction estimated fee
+     * @param {String} txHex - hex of stacks transaction payload
+     * @param {Number} txHexLength - length of built serialized transaction
+     * @returns {Promise<Number>} - fee estimate (taking the lowest)
+     */
+    protected getTransactionFeeEstimation({ txHex, txHexLength, }: {
+        txHex: string;
+        txHexLength: number;
+    }): Promise<number>;
+    /**
+     * Format for offline vault signing
+     * @param {BaseTransaction} tx - base transaction
+     * @returns {Promise<RecoveryInfo>}
+     */
+    protected formatForOfflineVault(tx: BaseTransaction): Promise<RecoveryInfo>;
+    /**
+     * Get the recoverable amount & fee after subtracting the txn fee
+     * @param {String} serializedHex - serialized txn hex
+     * @param {Number} txHexLength - deserialized txn length
+     * @param {String} balance - total account balance
+     * @param {String} tokenBalance - total token balance
+     * @returns {Promise<Record<string, string>>}
+     */
+    protected getRecoverableAmountAndFee(serializedHex: string, txHexLength: number, balance: string, tokenBalance?: string): Promise<Record<string, string>>;
+    /**
+     * Method to find the right builder for token or native coin transfer
+     * @param {String} contractAddress - token contract address
+     * @param {String} contractName - token contract name
+     * @returns {TransferBuilder|FungibleTokenTransferBuilder}
+     */
+    protected getTokenOrNativeTransferBuilder(contractAddress?: string, contractName?: string): TransferBuilder | FungibleTokenTransferBuilder;
+    /**
+     * Method to build fungible token transfer transaction
+     * @param {FungibleTokenTransferBuilder} builder - fungible token transfer builder
+     * @param {String} contractAddress - token contract address
+     * @param {String} contractName - token contract name
+     * @param {String[]} pubs - account public keys
+     * @param {Number} nonce - account nonce
+     * @param {AddressDetails} rootAddressDetails - root address details
+     * @param {AddressDetails} destinationAddressDetails - receive address details
+     * @param {String} stxBalance - native stx balance
+     * @returns {Promise<BaseTransaction>} - built transaction
+     */
+    protected buildTokenTransferTransaction({ builder, contractAddress, contractName, pubs, nonce, rootAddressDetails, destinationAddressDetails, stxBalance, }: {
+        builder: FungibleTokenTransferBuilder;
+        contractAddress: string;
+        contractName: string;
+        pubs: string[];
+        nonce: number;
+        rootAddressDetails: AddressDetails;
+        destinationAddressDetails: AddressDetails;
+        stxBalance: string;
+    }): Promise<BaseTransaction>;
+    /**
+     * Method to build native transfer transaction
+     * @param {TransferBuilder} builder - transfer builder
+     * @param {String[]} pubs - account public keys
+     * @param {Number} nonce - account nonce
+     * @param {AddressDetails} destinationAddressDetails - receive address details
+     * @param {String} stxBalance - native stx balance
+     * @returns {Promise<BaseTransaction>} - built transaction
+     */
+    protected buildNativeTransferTransaction({ builder, pubs, nonce, destinationAddressDetails, stxBalance, }: {
+        builder: TransferBuilder;
+        pubs: string[];
+        nonce: number;
+        destinationAddressDetails: AddressDetails;
+        stxBalance: string;
+    }): Promise<BaseTransaction>;
+    /**
+     * Method that uses appropriate builder and builds transaction depending on token or native coin
+     * @param {String[]} pubs - public keys
+     * @param {AddressDetails} rootAddressDetails - sender address detail
+     * @param {AddressDetails} destinationAddressDetails - receiver address detail
+     * @param {Number} nonce - wallet nonce
+     * @param {String} balance - wallet balance
+     * @param {String | undefined} contractAddress - token contract address
+     * @param {String | undefined} contractName - token contract name
+     * @returns {Promise<BaseTransaction>} built transaction
+     */
+    protected getNativeOrTokenTransaction({ pubs, rootAddressDetails, destinationAddressDetails, nonce, stxBalance, contractAddressInput, contractName, }: {
+        pubs: string[];
+        rootAddressDetails: AddressDetails;
+        destinationAddressDetails: AddressDetails;
+        nonce: number;
+        stxBalance: string;
+        contractAddressInput?: string;
+        contractName?: string;
+    }): Promise<{
+        tx: BaseTransaction;
+        builder: TransferBuilder | FungibleTokenTransferBuilder;
+    }>;
+    /**
+     * Method to recover native stx or sip10 tokens from bitgo hot & cold wallets
+     * @param {String} params.backupKey - encrypted wallet backup key (public or private)
+     * @param {String} params.userKey - encrypted wallet user key (public or private)
+     * @param {String} params.rootAddress - wallet root address
+     * @param {String} params.recoveryDestination - receive address
+     * @param {String} params.bitgoKey - encrypted bitgo public key
+     * @param {String} params.walletPassphrase - wallet password
+     * @param {String} params.contractId - contract id of the token (mandatory for token recovery)
+     * @returns {Promise<RecoveryInfo|RecoveryTransaction>} RecoveryTransaction.txHex - hex of serialized transaction (signed or unsigned)
+     */
+    recover(params: RecoveryOptions): Promise<RecoveryInfo | RecoveryTransaction>;
+    /** @inheritDoc */
+    auditDecryptedKey(params: AuditDecryptedKeyParams): void;
 }
 //# sourceMappingURL=stx.d.ts.map

package/dist/src/stx.d.ts.map

@@ -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"}
+{"version":3,"file":"stx.d.ts","sourceRoot":"","sources":["../../src/stx.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EACvB,QAAQ,EACR,eAAe,EACf,SAAS,EAIT,OAAO,EAEP,YAAY,EAEZ,iBAAiB,EAIjB,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;AAO9D,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,oBAAoB;IACpB,sBAAsB,IAAI,YAAY;IAIhC,iBAAiB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,OAAO,CAAC;IAoD3E,OAAO,CAAC,qBAAqB;IAM7B;;;;;OAKG;YACW,6BAA6B;IAoC3C;;;;;;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;IA0EnF,kBAAkB;IAClB,iBAAiB,CAAC,MAAM,EAAE,uBAAuB;CAGlD"}