@bitgo-beta/sdk-coin-trx 1.2.3-alpha.398 → 1.2.3-alpha.399

package/dist/src/trx.d.ts

@@ -1,262 +0,0 @@
-import { CoinFamily, BaseCoin as StaticsBaseCoin } from '@bitgo-beta/statics';
-import { BaseCoin, BitGoBase, KeyPair, ParsedTransaction, ParseTransactionOptions, SignedTransaction, SignTransactionOptions, TransactionExplanation, TransactionFee, TransactionPrebuild as BaseTransactionPrebuild, TransactionRecipient as Recipient, VerifyAddressOptions, VerifyTransactionOptions, BaseTransaction, MultisigType, AuditDecryptedKeyParams } from '@bitgo-beta/sdk-core';
-import { Interface } from './lib';
-import { TransactionReceipt } from './lib/iface';
-export declare const MINIMUM_TRON_MSIG_TRANSACTION_FEE = 1000000;
-export declare const SAFE_TRON_TRANSACTION_FEE: number;
-export declare const SAFE_TRON_TOKEN_TRANSACTION_FEE: number;
-export declare const RECOVER_TRANSACTION_EXPIRY = 86400000;
-export declare const DEFAULT_SCAN_FACTOR = 20;
-export interface TronSignTransactionOptions extends SignTransactionOptions {
-    txPrebuild: TransactionPrebuild;
-    prv: string;
-}
-export interface TxInfo {
-    recipients: Recipient[];
-    from: string;
-    txid: string;
-}
-export interface AddressInfo {
-    address: string;
-    chain: number;
-    index: number;
-}
-export interface TronTransactionExplanation extends TransactionExplanation {
-    expiration: number;
-    timestamp: number;
-}
-export interface TransactionPrebuild extends BaseTransactionPrebuild {
-    txHex: string;
-    txInfo: TxInfo;
-    addressInfo?: AddressInfo;
-    feeInfo: TransactionFee;
-}
-export interface ExplainTransactionOptions {
-    txHex?: string;
-    halfSigned?: {
-        txHex: string;
-    };
-    feeInfo: TransactionFee;
-}
-export interface RecoveryOptions {
-    userKey: string;
-    backupKey: string;
-    bitgoKey: string;
-    recoveryDestination: string;
-    krsProvider?: string;
-    tokenContractAddress?: string;
-    walletPassphrase?: string;
-    startingScanIndex?: number;
-    scan?: number;
-}
-export interface ConsolidationRecoveryOptions {
-    userKey: string;
-    backupKey: string;
-    bitgoKey: string;
-    tokenContractAddress?: string;
-    startingScanIndex?: number;
-    endingScanIndex?: number;
-}
-export interface ConsolidationRecoveryBatch {
-    transactions: RecoveryTransaction[];
-}
-export interface FeeInfo {
-    fee: string;
-}
-export interface RecoveryTransaction {
-    txHex?: string;
-    feeInfo?: FeeInfo;
-    coin?: string;
-    tx?: TransactionPrebuild;
-    recoveryAmount?: number;
-    tokenTxs?: TransactionReceipt[];
-    addressInfo?: AddressInfo;
-}
-export declare enum NodeTypes {
-    Full = 0,
-    Solidity = 1
-}
-/**
- * This structure is not a complete model of the AccountResponse from a node.
- */
-export interface AccountResponse {
-    data: [Interface.AccountInfo];
-}
-export declare class Trx extends BaseCoin {
-    protected readonly _staticsCoin: Readonly<StaticsBaseCoin>;
-    constructor(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>);
-    getChain(): string;
-    getFamily(): CoinFamily;
-    getFullName(): string;
-    getBaseFactor(): number;
-    /** @inheritdoc */
-    transactionDataAllowed(): boolean;
-    /** inherited doc */
-    getDefaultMultisigType(): MultisigType;
-    static createInstance(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>): BaseCoin;
-    /**
-     * Flag for sending value of 0
-     * @returns {boolean} True if okay to send 0 value, false otherwise
-     */
-    valuelessTransferAllowed(): boolean;
-    /** @inheritDoc */
-    allowsAccountConsolidations(): boolean;
-    /**
-     * Checks if this is a valid base58
-     * @param address
-     */
-    isValidAddress(address: string): boolean;
-    /**
-     * Checks if this is a valid hex address
-     * @param address hex address
-     */
-    isValidHexAddress(address: string): boolean;
-    /**
-     * Generate ed25519 key pair
-     *
-     * @param seed
-     * @returns {Object} object with generated pub, prv
-     */
-    generateKeyPair(seed?: Buffer): KeyPair;
-    isValidXpub(xpub: string): boolean;
-    isValidPub(pub: string): boolean;
-    parseTransaction(params: ParseTransactionOptions): Promise<ParsedTransaction>;
-    isWalletAddress(params: VerifyAddressOptions): Promise<boolean>;
-    verifyTransaction(params: VerifyTransactionOptions): Promise<boolean>;
-    /**
-     * Derive a user key using the chain path of the address
-     * @param key
-     * @param path
-     * @returns {string} derived private key
-     */
-    deriveKeyWithPath({ key, path }: {
-        key: string;
-        path: string;
-    }): string;
-    /**
-     * Assemble keychain and half-sign prebuilt transaction
-     *
-     * @param params
-     * @param params.txPrebuild {Object} prebuild object returned by platform
-     * @param params.prv {String} user prv
-     * @returns Bluebird<SignedTransaction>
-     */
-    signTransaction(params: TronSignTransactionOptions): Promise<SignedTransaction>;
-    /**
-     * Return boolean indicating whether input is valid seed for the coin
-     *
-     * @param prv - the prv to be checked
-     */
-    isValidXprv(prv: string): boolean;
-    /**
-     * Convert a message to string in hexadecimal format.
-     *
-     * @param message {Buffer|String} message to sign
-     * @return the message as a hexadecimal string
-     */
-    toHexString(message: string | Buffer): string;
-    /**
-     * Sign message with private key
-     *
-     * @param key
-     * @param message
-     */
-    signMessage(key: KeyPair, message: string | Buffer): Promise<Buffer>;
-    /**
-     * Converts an xpub to a uncompressed pub
-     * @param xpub
-     */
-    xpubToUncompressedPub(xpub: string): string;
-    /**
-     * Modify prebuild before sending it to the server.
-     * @param buildParams The whitelisted parameters for this prebuild
-     */
-    getExtraPrebuildParams(buildParams: any): Promise<any>;
-    pubToHexAddress(pub: string): string;
-    xprvToCompressedPrv(xprv: string): string;
-    private getNodeUrl;
-    /**
-     * Make a query to Trongrid for information such as balance, token balance, solidity calls
-     * @param query {Object} key-value pairs of parameters to append after /api
-     * @returns {Object} response from Trongrid
-     */
-    private recoveryPost;
-    /**
-     * Make a query to Trongrid for information such as balance, token balance, solidity calls
-     * @param query {Object} key-value pairs of parameters to append after /api
-     * @returns {Object} response from Trongrid
-     */
-    private recoveryGet;
-    /**
-     * Query our explorer for the balance of an address
-     * @param address {String} the address encoded in hex
-     * @returns {BigNumber} address balance
-     */
-    private getAccountBalancesFromNode;
-    /**
-     * Retrieves our build transaction from a node.
-     * @param toAddr hex-encoded address
-     * @param fromAddr hex-encoded address
-     * @param amount
-     */
-    private getBuildTransaction;
-    /**
-     * Retrieves our build transaction from a node.
-     * @param toAddr hex-encoded address
-     * @param fromAddr hex-encoded address
-     * @param amount
-     */
-    private getTriggerSmartContractTransaction;
-    /**
-     * Throws an error if any keys in the ownerKeys collection don't match the keys array we pass
-     * @param ownerKeys
-     * @param keys
-     */
-    checkPermissions(ownerKeys: {
-        address: string;
-        weight: number;
-    }[], keys: string[]): void;
-    /**
-     * Format for offline vault signing
-     * @param {BaseTransaction} tx
-     * @param {number} fee
-     * @param {number} recoveryAmount
-     * @returns {RecoveryTransaction}
-     */
-    formatForOfflineVault(tx: BaseTransaction, fee: number, recoveryAmount: number, addressInfo?: AddressInfo): RecoveryTransaction;
-    /**
-     * Builds a funds recovery transaction without BitGo.
-     * We need to do three queries during this:
-     * 1) Node query - how much money is in the account
-     * 2) Build transaction - build our transaction for the amount
-     * 3) Send signed build - send our signed build to a public node
-     *
-     * Note 1: for base address recoveries, fund will be recovered to recovery destination if base address balance is
-     * more than 2.1 TRX for native TRX recovery and 100 TRX for token recover. For receive addresses, fund will be
-     * recovered to base address first then swept to base address(decided as the universal pattern in team meeting).
-     *
-     * Note 2: the function supports token sweep from base address.
-     * TODO: support token sweep from receive address.
-     *
-     * @param params
-     */
-    recover(params: RecoveryOptions): Promise<RecoveryTransaction>;
-    /**
-     * Builds native TRX recoveries of receive addresses in batch without BitGo.
-     * Funds will be recovered to base address first. You need to initiate another sweep txn after that.
-     * Note: there will be another recoverTokenConsolidations function to support token recover from receive addresses.
-     *
-     * @param {ConsolidationRecoveryOptions} params - options for consolidation recovery.
-     * @param {string} [params.startingScanIndex] - receive address index to start scanning from. default to 1 (inclusive).
-     * @param {string} [params.endingScanIndex] - receive address index to end scanning at. default to startingScanIndex + 20 (exclusive).
-     */
-    recoverConsolidations(params: ConsolidationRecoveryOptions): Promise<ConsolidationRecoveryBatch>;
-    /**
-     * Explain a Tron transaction from txHex
-     * @param params
-     */
-    explainTransaction(params: ExplainTransactionOptions): Promise<TronTransactionExplanation>;
-    /** @inheritDoc */
-    auditDecryptedKey(params: AuditDecryptedKeyParams): void;
-}
-//# sourceMappingURL=trx.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"trx.d.ts","sourceRoot":"","sources":["../../src/trx.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,UAAU,EAAE,QAAQ,IAAI,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAG9E,OAAO,EACL,QAAQ,EACR,SAAS,EAKT,OAAO,EAEP,iBAAiB,EACjB,uBAAuB,EACvB,iBAAiB,EACjB,sBAAsB,EACtB,sBAAsB,EACtB,cAAc,EACd,mBAAmB,IAAI,uBAAuB,EAC9C,oBAAoB,IAAI,SAAS,EACjC,oBAAoB,EACpB,wBAAwB,EACxB,eAAe,EACf,YAAY,EAEZ,uBAAuB,EACxB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,SAAS,EAAyB,MAAM,OAAO,CAAC;AAEzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAGjD,eAAO,MAAM,iCAAiC,UAAM,CAAC;AACrD,eAAO,MAAM,yBAAyB,QAAY,CAAC;AACnD,eAAO,MAAM,+BAA+B,QAAY,CAAC;AACzD,eAAO,MAAM,0BAA0B,WAAW,CAAC;AACnD,eAAO,MAAM,mBAAmB,KAAK,CAAC;AAEtC,MAAM,WAAW,0BAA2B,SAAQ,sBAAsB;IACxE,UAAU,EAAE,mBAAmB,CAAC;IAChC,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,MAAM;IACrB,UAAU,EAAE,SAAS,EAAE,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,0BAA2B,SAAQ,sBAAsB;IACxE,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,mBAAoB,SAAQ,uBAAuB;IAClE,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,OAAO,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,WAAW,yBAAyB;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE;QACX,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;IACF,OAAO,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,4BAA4B;IAC3C,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,0BAA0B;IACzC,YAAY,EAAE,mBAAmB,EAAE,CAAC;CACrC;AAED,MAAM,WAAW,OAAO;IACtB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,mBAAmB,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAChC,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED,oBAAY,SAAS;IACnB,IAAI,IAAA;IACJ,QAAQ,IAAA;CACT;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;CAC/B;AAED,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,QAAQ;IAIR,SAAS,IAAI,UAAU;IAIvB,WAAW;IAIX,aAAa;IAIb,kBAAkB;IAClB,sBAAsB;IAItB,oBAAoB;IACpB,sBAAsB,IAAI,YAAY;IAItC,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC,GAAG,QAAQ;IAI1F;;;OAGG;IACH,wBAAwB,IAAI,OAAO;IAInC,kBAAkB;IAClB,2BAA2B,IAAI,OAAO;IAItC;;;OAGG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAQxC;;;OAGG;IACH,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAI3C;;;;;OAKG;IACH,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO;IAcvC,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAQlC,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAQ1B,gBAAgB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI7E,eAAe,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAI/D,iBAAiB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,OAAO,CAAC;IAI3E;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM;IAMvE;;;;;;;OAOG;IACG,eAAe,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,iBAAiB,CAAC;IA0BrF;;;;OAIG;IACH,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAQjC;;;;;OAKG;IACH,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM;IAU7C;;;;;OAKG;IACG,WAAW,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAmB1E;;;OAGG;IACH,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAS3C;;;OAGG;IACG,sBAAsB,CAAC,WAAW,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAM5D,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAMpC,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAYzC,OAAO,CAAC,UAAU;IAUlB;;;;OAIG;YACW,YAAY;IAgB1B;;;;OAIG;YACW,WAAW;IAgBzB;;;;OAIG;YACW,0BAA0B;IAQxC;;;;;OAKG;YACW,mBAAmB;IAiBjC;;;;;OAKG;YACW,kCAAkC;IAuBhD;;;;OAIG;IACH,gBAAgB,CAAC,SAAS,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;IAejF;;;;;;OAMG;IACH,qBAAqB,CACnB,EAAE,EAAE,eAAe,EACnB,GAAG,EAAE,MAAM,EACX,cAAc,EAAE,MAAM,EACtB,WAAW,CAAC,EAAE,WAAW,GACxB,mBAAmB;IActB;;;;;;;;;;;;;;;OAeG;IACG,OAAO,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA+LpE;;;;;;;;OAQG;IACG,qBAAqB,CAAC,MAAM,EAAE,4BAA4B,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAwGtG;;;OAGG;IACG,kBAAkB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAsChG,kBAAkB;IAClB,iBAAiB,CAAC,MAAM,EAAE,uBAAuB;CAGlD"}