@bitgo-beta/sdk-coin-dot 2.2.8-beta.166 → 2.2.8-beta.1660

package/dist/esm/lib/stakingBuilder.js

@@ -0,0 +1,160 @@
+import { methods } from '@substrate/txwrapper-polkadot';
+import BigNumber from 'bignumber.js';
+import utils from './utils';
+import { InvalidTransactionError, TransactionType } from '@bitgo-beta/sdk-core';
+import { MethodNames } from './iface';
+import { TransactionBuilder } from './transactionBuilder';
+import { StakeTransactionSchema } from './txnSchema';
+export class StakingBuilder extends TransactionBuilder {
+    constructor(_coinConfig) {
+        super(_coinConfig);
+    }
+    /**
+     * Take the origin account as a stash and lock up value of its balance.
+     * Controller will be the account that controls it.
+     *
+     * @returns {UnsignedTransaction} an unsigned Dot transaction
+     *
+     * @see https://polkadot.js.org/docs/substrate/extrinsics/#staking
+     */
+    buildTransaction() {
+        const baseTxInfo = this.createBaseTxInfo();
+        if (this._addToStake) {
+            return methods.staking.bondExtra({
+                maxAdditional: this._amount,
+            }, baseTxInfo.baseTxInfo, baseTxInfo.options);
+        }
+        else {
+            return methods.staking.bond({
+                value: this._amount,
+                payee: this._payee,
+            }, baseTxInfo.baseTxInfo, baseTxInfo.options);
+        }
+    }
+    get transactionType() {
+        return TransactionType.StakingActivate;
+    }
+    /**
+     * The amount to stake.
+     *
+     * @param {string} amount
+     * @returns {StakeBuilder} This staking builder.
+     *
+     * @see https://wiki.polkadot.network/docs/learn-nominator#required-minimum-stake
+     */
+    amount(amount) {
+        this.validateValue(new BigNumber(amount));
+        this._amount = amount;
+        return this;
+    }
+    /**
+     * true if we should add to an existing stake, false otherwise.
+     *
+     * @param {boolean} addToStake
+     * @returns {StakeBuilder} This staking builder.
+     */
+    addToStake(addToStake) {
+        this._addToStake = addToStake;
+        return this;
+    }
+    /**
+     * The controller of the staked amount.
+     *
+     * @param {string} controller
+     * @returns {StakeBuilder} This staking builder.
+     *
+     * @see https://wiki.polkadot.network/docs/learn-staking#accounts
+     */
+    owner(controller) {
+        this.validateAddress(controller);
+        this._controller = controller.address;
+        return this;
+    }
+    /**
+     * The rewards destination of the staked amount.
+     * Can be set to another accounts address.
+     *
+     * @param {string} payee
+     * @returns {StakeBuilder} This staking builder.
+     *
+     * @see https://wiki.polkadot.network/docs/learn-staking#4-rewards-mechanism
+     */
+    payee(payee) {
+        if (typeof payee !== 'string') {
+            this.validateAddress({ address: payee.Account });
+            this._payee = { Account: payee.Account };
+        }
+        else {
+            this._payee = payee;
+        }
+        return this;
+    }
+    /** @inheritdoc */
+    validateDecodedTransaction(decodedTxn) {
+        if (decodedTxn.method?.name === MethodNames.Bond) {
+            const txMethod = decodedTxn.method.args;
+            const value = txMethod.value;
+            const controller = this._sender;
+            const payee = txMethod.payee;
+            const validationResult = StakeTransactionSchema.validate({ value, controller, payee });
+            if (validationResult.error) {
+                throw new InvalidTransactionError(`Transaction validation failed: ${validationResult.error.message}`);
+            }
+        }
+        else if (decodedTxn.method?.name === MethodNames.BondExtra) {
+            const txMethod = decodedTxn.method.args;
+            const value = txMethod.maxAdditional;
+            const validationResult = StakeTransactionSchema.validate({ value, addToStake: true });
+            if (validationResult.error) {
+                throw new InvalidTransactionError(`Transaction validation failed: ${validationResult.error.message}`);
+            }
+        }
+    }
+    /** @inheritdoc */
+    fromImplementation(rawTransaction) {
+        const tx = super.fromImplementation(rawTransaction);
+        if (this._method?.name === MethodNames.Bond) {
+            const txMethod = this._method.args;
+            this.amount(txMethod.value);
+            this.owner({
+                address: utils.decodeDotAddress(this._sender, utils.getAddressFormat(this._coinConfig.name)),
+            });
+            const payee = txMethod.payee;
+            if (payee.account) {
+                this.payee({
+                    Account: utils.decodeDotAddress(payee.account, utils.getAddressFormat(this._coinConfig.name)),
+                });
+            }
+            else {
+                const payeeType = utils.capitalizeFirstLetter(Object.keys(payee)[0]);
+                this.payee(payeeType);
+            }
+        }
+        else if (this._method?.name === MethodNames.BondExtra) {
+            const txMethod = this._method.args;
+            this.amount(txMethod.maxAdditional);
+            this.addToStake(true);
+        }
+        else {
+            throw new InvalidTransactionError(`Invalid Transaction Type: ${this._method?.name}. Expected bond or bondExtra`);
+        }
+        return tx;
+    }
+    /** @inheritdoc */
+    validateTransaction(_) {
+        super.validateTransaction(_);
+        this.validateFields(this._amount, this._controller, this._payee, this._addToStake);
+    }
+    validateFields(value, controller, payee, addToStake) {
+        const validationResult = StakeTransactionSchema.validate({
+            value,
+            controller,
+            payee,
+            addToStake,
+        });
+        if (validationResult.error) {
+            throw new InvalidTransactionError(`Stake Builder Transaction validation failed: ${validationResult.error.message}`);
+        }
+    }
+}
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"stakingBuilder.js","sourceRoot":"","sources":["../../../src/lib/stakingBuilder.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAC;AACxD,OAAO,SAAS,MAAM,cAAc,CAAC;AACrC,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,EAA8B,uBAAuB,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5G,OAAO,EAAE,WAAW,EAA+D,MAAM,SAAS,CAAC;AAEnG,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAErD,MAAM,OAAO,cAAe,SAAQ,kBAAkB;IAMpD,YAAY,WAAiC;QAC3C,KAAK,CAAC,WAAW,CAAC,CAAC;IACrB,CAAC;IAED;;;;;;;OAOG;IACO,gBAAgB;QACxB,MAAM,UAAU,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC3C,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,CAC9B;gBACE,aAAa,EAAE,IAAI,CAAC,OAAO;aAC5B,EACD,UAAU,CAAC,UAAU,EACrB,UAAU,CAAC,OAAO,CACnB,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CACzB;gBACE,KAAK,EAAE,IAAI,CAAC,OAAO;gBACnB,KAAK,EAAE,IAAI,CAAC,MAAM;aACnB,EACD,UAAU,CAAC,UAAU,EACrB,UAAU,CAAC,OAAO,CACnB,CAAC;QACJ,CAAC;IACH,CAAC;IAED,IAAc,eAAe;QAC3B,OAAO,eAAe,CAAC,eAAe,CAAC;IACzC,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,MAAc;QACnB,IAAI,CAAC,aAAa,CAAC,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,UAAmB;QAC5B,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,UAAuB;QAC3B,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QACjC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,OAAO,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,KAAqB;QACzB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,IAAI,CAAC,eAAe,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YACjD,IAAI,CAAC,MAAM,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;QAC3C,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACtB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kBAAkB;IAClB,0BAA0B,CAAC,UAAmD;QAC5E,IAAI,UAAU,CAAC,MAAM,EAAE,IAAI,KAAK,WAAW,CAAC,IAAI,EAAE,CAAC;YACjD,MAAM,QAAQ,GAAG,UAAU,CAAC,MAAM,CAAC,IAA4B,CAAC;YAChE,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;YAC7B,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC;YAChC,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;YAC7B,MAAM,gBAAgB,GAAG,sBAAsB,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;YACvF,IAAI,gBAAgB,CAAC,KAAK,EAAE,CAAC;gBAC3B,MAAM,IAAI,uBAAuB,CAAC,kCAAkC,gBAAgB,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YACxG,CAAC;QACH,CAAC;aAAM,IAAI,UAAU,CAAC,MAAM,EAAE,IAAI,KAAK,WAAW,CAAC,SAAS,EAAE,CAAC;YAC7D,MAAM,QAAQ,GAAG,UAAU,CAAC,MAAM,CAAC,IAAgC,CAAC;YACpE,MAAM,KAAK,GAAG,QAAQ,CAAC,aAAa,CAAC;YACrC,MAAM,gBAAgB,GAAG,sBAAsB,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;YACtF,IAAI,gBAAgB,CAAC,KAAK,EAAE,CAAC;gBAC3B,MAAM,IAAI,uBAAuB,CAAC,kCAAkC,gBAAgB,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YACxG,CAAC;QACH,CAAC;IACH,CAAC;IAED,kBAAkB;IACR,kBAAkB,CAAC,cAAsB;QACjD,MAAM,EAAE,GAAG,KAAK,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAC;QACpD,IAAI,IAAI,CAAC,OAAO,EAAE,IAAI,KAAK,WAAW,CAAC,IAAI,EAAE,CAAC;YAC5C,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAiB,CAAC;YAChD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAC5B,IAAI,CAAC,KAAK,CAAC;gBACT,OAAO,EAAE,KAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC,IAAqB,CAAC,CAAC;aAC9G,CAAC,CAAC;YAEH,MAAM,KAAK,GAAG,QAAQ,CAAC,KAA0B,CAAC;YAClD,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;gBAClB,IAAI,CAAC,KAAK,CAAC;oBACT,OAAO,EAAE,KAAK,CAAC,gBAAgB,CAC7B,KAAK,CAAC,OAAO,EACb,KAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC,IAAqB,CAAC,CAC/D;iBACF,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,MAAM,SAAS,GAAG,KAAK,CAAC,qBAAqB,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAmB,CAAC;gBACvF,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACxB,CAAC;QACH,CAAC;aAAM,IAAI,IAAI,CAAC,OAAO,EAAE,IAAI,KAAK,WAAW,CAAC,SAAS,EAAE,CAAC;YACxD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAqB,CAAC;YACpD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;YACpC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,uBAAuB,CAAC,6BAA6B,IAAI,CAAC,OAAO,EAAE,IAAI,8BAA8B,CAAC,CAAC;QACnH,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,kBAAkB;IAClB,mBAAmB,CAAC,CAAc;QAChC,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;QAC7B,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACrF,CAAC;IAEO,cAAc,CAAC,KAAa,EAAE,UAAkB,EAAE,KAAqB,EAAE,UAAmB;QAClG,MAAM,gBAAgB,GAAG,sBAAsB,CAAC,QAAQ,CAAC;YACvD,KAAK;YACL,UAAU;YACV,KAAK;YACL,UAAU;SACX,CAAC,CAAC;QAEH,IAAI,gBAAgB,CAAC,KAAK,EAAE,CAAC;YAC3B,MAAM,IAAI,uBAAuB,CAC/B,gDAAgD,gBAAgB,CAAC,KAAK,CAAC,OAAO,EAAE,CACjF,CAAC;QACJ,CAAC;IACH,CAAC;CACF","sourcesContent":["import { BaseCoin as CoinConfig } from '@bitgo-beta/statics';\nimport { DecodedSignedTx, DecodedSigningPayload, UnsignedTransaction } from '@substrate/txwrapper-core';\nimport { methods } from '@substrate/txwrapper-polkadot';\nimport BigNumber from 'bignumber.js';\nimport utils from './utils';\nimport { BaseAddress, DotAssetTypes, InvalidTransactionError, TransactionType } from '@bitgo-beta/sdk-core';\nimport { MethodNames, StakeArgs, StakeArgsPayee, StakeArgsPayeeRaw, StakeMoreArgs } from './iface';\nimport { Transaction } from './transaction';\nimport { TransactionBuilder } from './transactionBuilder';\nimport { StakeTransactionSchema } from './txnSchema';\n\nexport class StakingBuilder extends TransactionBuilder {\n  protected _amount: string;\n  protected _controller: string;\n  protected _payee: StakeArgsPayee;\n  protected _addToStake: boolean;\n\n  constructor(_coinConfig: Readonly<CoinConfig>) {\n    super(_coinConfig);\n  }\n\n  /**\n   * Take the origin account as a stash and lock up value of its balance.\n   * Controller will be the account that controls it.\n   *\n   * @returns {UnsignedTransaction} an unsigned Dot transaction\n   *\n   * @see https://polkadot.js.org/docs/substrate/extrinsics/#staking\n   */\n  protected buildTransaction(): UnsignedTransaction {\n    const baseTxInfo = this.createBaseTxInfo();\n    if (this._addToStake) {\n      return methods.staking.bondExtra(\n        {\n          maxAdditional: this._amount,\n        },\n        baseTxInfo.baseTxInfo,\n        baseTxInfo.options\n      );\n    } else {\n      return methods.staking.bond(\n        {\n          value: this._amount,\n          payee: this._payee,\n        },\n        baseTxInfo.baseTxInfo,\n        baseTxInfo.options\n      );\n    }\n  }\n\n  protected get transactionType(): TransactionType {\n    return TransactionType.StakingActivate;\n  }\n\n  /**\n   * The amount to stake.\n   *\n   * @param {string} amount\n   * @returns {StakeBuilder} This staking builder.\n   *\n   * @see https://wiki.polkadot.network/docs/learn-nominator#required-minimum-stake\n   */\n  amount(amount: string): this {\n    this.validateValue(new BigNumber(amount));\n    this._amount = amount;\n    return this;\n  }\n\n  /**\n   * true if we should add to an existing stake, false otherwise.\n   *\n   * @param {boolean} addToStake\n   * @returns {StakeBuilder} This staking builder.\n   */\n  addToStake(addToStake: boolean): this {\n    this._addToStake = addToStake;\n    return this;\n  }\n\n  /**\n   * The controller of the staked amount.\n   *\n   * @param {string} controller\n   * @returns {StakeBuilder} This staking builder.\n   *\n   * @see https://wiki.polkadot.network/docs/learn-staking#accounts\n   */\n  owner(controller: BaseAddress): this {\n    this.validateAddress(controller);\n    this._controller = controller.address;\n    return this;\n  }\n\n  /**\n   * The rewards destination of the staked amount.\n   * Can be set to another accounts address.\n   *\n   * @param {string} payee\n   * @returns {StakeBuilder} This staking builder.\n   *\n   * @see https://wiki.polkadot.network/docs/learn-staking#4-rewards-mechanism\n   */\n  payee(payee: StakeArgsPayee): this {\n    if (typeof payee !== 'string') {\n      this.validateAddress({ address: payee.Account });\n      this._payee = { Account: payee.Account };\n    } else {\n      this._payee = payee;\n    }\n    return this;\n  }\n\n  /** @inheritdoc */\n  validateDecodedTransaction(decodedTxn: DecodedSigningPayload | DecodedSignedTx): void {\n    if (decodedTxn.method?.name === MethodNames.Bond) {\n      const txMethod = decodedTxn.method.args as unknown as StakeArgs;\n      const value = txMethod.value;\n      const controller = this._sender;\n      const payee = txMethod.payee;\n      const validationResult = StakeTransactionSchema.validate({ value, controller, payee });\n      if (validationResult.error) {\n        throw new InvalidTransactionError(`Transaction validation failed: ${validationResult.error.message}`);\n      }\n    } else if (decodedTxn.method?.name === MethodNames.BondExtra) {\n      const txMethod = decodedTxn.method.args as unknown as StakeMoreArgs;\n      const value = txMethod.maxAdditional;\n      const validationResult = StakeTransactionSchema.validate({ value, addToStake: true });\n      if (validationResult.error) {\n        throw new InvalidTransactionError(`Transaction validation failed: ${validationResult.error.message}`);\n      }\n    }\n  }\n\n  /** @inheritdoc */\n  protected fromImplementation(rawTransaction: string): Transaction {\n    const tx = super.fromImplementation(rawTransaction);\n    if (this._method?.name === MethodNames.Bond) {\n      const txMethod = this._method.args as StakeArgs;\n      this.amount(txMethod.value);\n      this.owner({\n        address: utils.decodeDotAddress(this._sender, utils.getAddressFormat(this._coinConfig.name as DotAssetTypes)),\n      });\n\n      const payee = txMethod.payee as StakeArgsPayeeRaw;\n      if (payee.account) {\n        this.payee({\n          Account: utils.decodeDotAddress(\n            payee.account,\n            utils.getAddressFormat(this._coinConfig.name as DotAssetTypes)\n          ),\n        });\n      } else {\n        const payeeType = utils.capitalizeFirstLetter(Object.keys(payee)[0]) as StakeArgsPayee;\n        this.payee(payeeType);\n      }\n    } else if (this._method?.name === MethodNames.BondExtra) {\n      const txMethod = this._method.args as StakeMoreArgs;\n      this.amount(txMethod.maxAdditional);\n      this.addToStake(true);\n    } else {\n      throw new InvalidTransactionError(`Invalid Transaction Type: ${this._method?.name}. Expected bond or bondExtra`);\n    }\n    return tx;\n  }\n\n  /** @inheritdoc */\n  validateTransaction(_: Transaction): void {\n    super.validateTransaction(_);\n    this.validateFields(this._amount, this._controller, this._payee, this._addToStake);\n  }\n\n  private validateFields(value: string, controller: string, payee: StakeArgsPayee, addToStake: boolean): void {\n    const validationResult = StakeTransactionSchema.validate({\n      value,\n      controller,\n      payee,\n      addToStake,\n    });\n\n    if (validationResult.error) {\n      throw new InvalidTransactionError(\n        `Stake Builder Transaction validation failed: ${validationResult.error.message}`\n      );\n    }\n  }\n}\n"]}

package/dist/esm/lib/transaction.d.ts

@@ -0,0 +1,83 @@
+import { BaseKey, BaseTransaction, TransactionType } from '@bitgo-beta/sdk-core';
+import { BaseCoin as CoinConfig } from '@bitgo-beta/statics';
+import { UnsignedTransaction } from '@substrate/txwrapper-core';
+import { TypeRegistry } from '@substrate/txwrapper-core/lib/types';
+import { KeyPair } from './keyPair';
+import { TransactionExplanation, TxData } from './iface';
+/**
+ * Use a dummy address as the destination of a bond or bondExtra because our inputs and outputs model
+ * doesn't seem to handle the concept of locking funds within a wallet as a method of transferring coins.
+ */
+export declare const STAKING_DESTINATION: string;
+export declare class Transaction extends BaseTransaction {
+    protected _dotTransaction: UnsignedTransaction;
+    private _signedTransaction?;
+    private _registry;
+    private _chainName;
+    private _sender;
+    private static FAKE_SIGNATURE;
+    constructor(coinConfig: Readonly<CoinConfig>);
+    /** @inheritdoc */
+    canSign({ key }: BaseKey): boolean;
+    /**
+     * Sign a polkadot transaction and update the transaction hex
+     *
+     * @param {KeyPair} keyPair - ed signature
+     */
+    sign(keyPair: KeyPair): void;
+    /**
+     * Adds the signature to the DOT Transaction
+     * @param {string} signature
+     */
+    addSignature(signature: string): void;
+    /**
+     * Returns a serialized representation of this transaction with a fake signature attached which
+     * can be used to estimate transaction fees.
+     */
+    fakeSign(): string;
+    registry(registry: TypeRegistry): void;
+    chainName(chainName: string): void;
+    sender(sender: string): void;
+    /** @inheritdoc */
+    toBroadcastFormat(): string;
+    transactionSize(): number;
+    /** @inheritdoc */
+    toJson(): TxData;
+    explainTransferTransaction(json: TxData, explanationResult: TransactionExplanation): TransactionExplanation;
+    explainStakingActivateTransaction(json: TxData, explanationResult: TransactionExplanation): TransactionExplanation;
+    explainAddressInitializationTransaction(json: TxData, explanationResult: TransactionExplanation): TransactionExplanation;
+    explainStakingUnlockTransaction(json: TxData, explanationResult: TransactionExplanation): TransactionExplanation;
+    /** @inheritdoc */
+    explainTransaction(): TransactionExplanation;
+    /**
+     * Load the input and output data on this transaction.
+     */
+    loadInputsAndOutputs(): void;
+    private decodeInputsAndOutputsForSend;
+    private decodeInputsAndOutputsForBatch;
+    private getRemoveProxyCost;
+    private getAddProxyCost;
+    private getConstant;
+    private decodeInputsAndOutputsForBond;
+    private decodeInputsAndOutputsForUnbond;
+    private decodeInputsAndOutputsForWithdrawUnbond;
+    /**
+     * Constructs a signed payload using construct.signTx
+     * This method will be called during the build step if a TSS signature
+     * is added and will set the signTransaction which is the txHex that will be broadcasted
+     * As well as add the signature used to sign to the signature array in hex format
+     *
+     * @param {Buffer} signature The signature to be added to a dot transaction
+     */
+    constructSignedPayload(signature: Buffer): void;
+    setTransaction(tx: UnsignedTransaction): void;
+    /** @inheritdoc **/
+    get signablePayload(): Buffer;
+    /**
+     * Set the transaction type.
+     *
+     * @param {TransactionType} transactionType The transaction type to be set.
+     */
+    transactionType(transactionType: TransactionType): void;
+}
+//# sourceMappingURL=transaction.d.ts.map

package/dist/esm/lib/transaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../../../src/lib/transaction.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,eAAe,EAOf,eAAe,EAChB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,QAAQ,IAAI,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAI7D,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,qCAAqC,CAAC;AACnE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAeL,sBAAsB,EACtB,MAAM,EAGP,MAAM,SAAS,CAAC;AASjB;;;GAGG;AACH,eAAO,MAAM,mBAAmB,QAAsF,CAAC;AAEvH,qBAAa,WAAY,SAAQ,eAAe;IAC9C,SAAS,CAAC,eAAe,EAAE,mBAAmB,CAAC;IAC/C,OAAO,CAAC,kBAAkB,CAAC,CAAS;IACpC,OAAO,CAAC,SAAS,CAAe;IAChC,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,OAAO,CAAS;IAExB,OAAO,CAAC,MAAM,CAAC,cAAc,CAAmE;gBAEpF,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC;IAI5C,kBAAkB;IAClB,OAAO,CAAC,EAAE,GAAG,EAAE,EAAE,OAAO,GAAG,OAAO;IAMlC;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IA0B5B;;;OAGG;IACH,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IASrC;;;OAGG;IACH,QAAQ,IAAI,MAAM;IASlB,QAAQ,CAAC,QAAQ,EAAE,YAAY,GAAG,IAAI;IAItC,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAIlC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAI5B,kBAAkB;IAClB,iBAAiB,IAAI,MAAM;IAa3B,eAAe,IAAI,MAAM;IAIzB,kBAAkB;IAClB,MAAM,IAAI,MAAM;IA0IhB,0BAA0B,CAAC,IAAI,EAAE,MAAM,EAAE,iBAAiB,EAAE,sBAAsB,GAAG,sBAAsB;IAe3G,iCAAiC,CAAC,IAAI,EAAE,MAAM,EAAE,iBAAiB,EAAE,sBAAsB,GAAG,sBAAsB;IAelH,uCAAuC,CACrC,IAAI,EAAE,MAAM,EACZ,iBAAiB,EAAE,sBAAsB,GACxC,sBAAsB;IAUzB,+BAA+B,CAAC,IAAI,EAAE,MAAM,EAAE,iBAAiB,EAAE,sBAAsB,GAAG,sBAAsB;IAYhH,kBAAkB;IAClB,kBAAkB,IAAI,sBAAsB;IAgC5C;;OAEG;IACH,oBAAoB,IAAI,IAAI;IAuB5B,OAAO,CAAC,6BAA6B;IAqDrC,OAAO,CAAC,8BAA8B;IA6GtC,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,eAAe;IAcvB,OAAO,CAAC,WAAW;IAYnB,OAAO,CAAC,6BAA6B;IA4BrC,OAAO,CAAC,+BAA+B;IAKvC,OAAO,CAAC,uCAAuC;IAK/C;;;;;;;OAOG;IACH,sBAAsB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAgB/C,cAAc,CAAC,EAAE,EAAE,mBAAmB,GAAG,IAAI;IAI7C,mBAAmB;IACnB,IAAI,eAAe,IAAI,MAAM,CAK5B;IAED;;;;OAIG;IACH,eAAe,CAAC,eAAe,EAAE,eAAe,GAAG,IAAI;CAGxD"}