@bitgo-beta/sdk-coin-eos 1.3.19-beta.122 → 1.3.19-beta.1221

package/dist/src/eos.d.ts

@@ -1,280 +0,0 @@
-/// <reference types="node" />
-import { BIP32Interface } from '@bitgo-beta/utxo-lib';
-import * as request from 'superagent';
-import { BaseCoin, BitGoBase, HalfSignedAccountTransaction as BaseHalfSignedTransaction, KeyPair, ParsedTransaction, ParseTransactionOptions, RequestTracer, SignTransactionOptions as BaseSignTransactionOptions, TransactionExplanation, VerificationOptions, VerifyAddressOptions as BaseVerifyAddressOptions, VerifyTransactionOptions as BaseVerifyTransactionOptions, Wallet } from '@bitgo-beta/sdk-core';
-interface AddressDetails {
-    address: string;
-    memoId?: string;
-}
-export interface EosTx {
-    signatures: string[];
-    packed_trx: string;
-    compression: string;
-}
-export interface Recipient {
-    address: string;
-    amount: string;
-}
-interface EosTransactionHeaders {
-    ref_block_prefix: number;
-    ref_block_num: number;
-    expiration?: string;
-}
-interface EosTransactionAction {
-    account: string;
-    name: string;
-    authorization: [{
-        actor: string;
-        permission: string;
-    }];
-    data: TransferActionData | StakeActionData | VoteActionData;
-}
-interface EosTransactionPrebuild {
-    recipients: Recipient[];
-    headers: EosTransactionHeaders;
-    txHex: string;
-    transaction: EosTx;
-    txid: string;
-    coin: string;
-    token?: string;
-}
-export interface EosSignTransactionParams extends BaseSignTransactionOptions {
-    prv: string;
-    txPrebuild: EosTransactionPrebuild;
-    recipients: Recipient[];
-}
-export interface EosVerifyTransactionOptions extends BaseVerifyTransactionOptions {
-    txPrebuild: EosTransactionPrebuild;
-    txParams: EosSignTransactionParams;
-    wallet: Wallet;
-    verification?: VerificationOptions;
-    reqId?: RequestTracer;
-}
-export interface EosHalfSigned {
-    recipients: Recipient[];
-    headers: EosTransactionHeaders;
-    txHex: string;
-    transaction: EosTx;
-    txid: string;
-}
-export interface EosSignedTransaction extends BaseHalfSignedTransaction {
-    halfSigned: EosHalfSigned;
-}
-interface TransferActionData {
-    from: string;
-    to: string;
-    quantity: string;
-    memo?: string;
-}
-interface StakeActionData {
-    address: string;
-    amount: string;
-    from: string;
-    receiver: string;
-    transfer: number;
-    stake_cpu_quantity: string;
-}
-interface VoteActionData {
-    address: string;
-    proxy: string;
-    producers: string[];
-    voter: string;
-}
-interface ExplainTransactionOptions {
-    transaction: {
-        packed_trx: string;
-    };
-    headers: EosTransactionHeaders;
-}
-interface RecoveryTransaction {
-    transaction: EosTx;
-    txid: string;
-    recoveryAmount: number;
-}
-interface RecoveryOptions {
-    userKey: string;
-    backupKey: string;
-    bitgoKey?: string;
-    recoveryDestination: string;
-    krsProvider?: string;
-    walletPassphrase?: string;
-    rootAddress?: string;
-}
-interface VerifyAddressOptions extends BaseVerifyAddressOptions {
-    rootAddress: string;
-}
-export declare class Eos extends BaseCoin {
-    static VALID_ADDRESS_CHARS: string[];
-    static ADDRESS_LENGTH: number;
-    static createInstance(bitgo: BitGoBase): BaseCoin;
-    getChainId(): string;
-    getChain(): string;
-    getFamily(): string;
-    getFullName(): string;
-    getBaseFactor(): number;
-    get decimalPlaces(): number;
-    /**
-     * Flag for sending value of 0
-     * @returns {boolean} True if okay to send 0 value, false otherwise
-     */
-    valuelessTransferAllowed(): boolean;
-    /**
-     * Get URLs of some active public nodes
-     */
-    getPublicNodeUrls(): string[];
-    /**
-     * Generate secp256k1 key pair
-     *
-     * @param seed - Seed from which the new keypair should be generated, otherwise a random seed is used
-     */
-    generateKeyPair(seed?: Buffer): KeyPair;
-    /**
-     * Return boolean indicating whether input is valid public key for the coin.
-     *
-     * @param pub - the pub to be checked
-     */
-    isValidPub(pub: string): boolean;
-    /**
-     * Return boolean indicating whether input is valid seed for the coin
-     *
-     * @param prv - the prv to be checked
-     */
-    isValidPrv(prv: string): boolean;
-    /**
-     * Evaluates whether a memo is valid
-     *
-     * @param value - the memo to be checked
-     */
-    isValidMemo({ value }: {
-        value: string;
-    }): boolean;
-    /**
-     * Return boolean indicating whether a memo id is valid
-     *
-     * @param memoId - the memo id to be checked
-     */
-    isValidMemoId(memoId: string): boolean;
-    /**
-     * Process address into address and memo id
-     * @param address - the address
-     */
-    getAddressDetails(address: string): AddressDetails;
-    /**
-     * Convert a currency amount represented in base units (satoshi, wei, atoms, drops, stroops)
-     * to big units (btc, eth, xrp, xlm)
-     */
-    baseUnitsToBigUnits(baseUnits: string | number): string;
-    /**
-     * Validate and return address with appended memo id
-     *
-     * @param address
-     * @param memoId
-     */
-    normalizeAddress({ address, memoId }: AddressDetails): string;
-    /**
-     * Return boolean indicating whether input is valid public key for the coin
-     *
-     * @param address - the address to be checked
-     */
-    isValidAddress(address: string): boolean;
-    /**
-     * @param address - the address to verify
-     * @param rootAddress - the wallet's root address
-     * @return true iff address is a wallet address (based on rootAddress)
-     */
-    isWalletAddress({ address, rootAddress }: VerifyAddressOptions): Promise<boolean>;
-    /**
-     * 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 {Promise<EosSignedTransaction>}
-     */
-    signTransaction(params: EosSignTransactionParams): Promise<EosSignedTransaction>;
-    private validateStakeActionData;
-    private validateUnstakeActionData;
-    private static validateVoteActionData;
-    private static createTransactionIdHex;
-    /**
-     * Deserialize a transaction
-     * @param transaction
-     * @param headers
-     */
-    private deserializeTransaction;
-    /**
-     * Explain/parse transaction
-     * @param params - ExplainTransactionOptions
-     */
-    explainTransaction(params: ExplainTransactionOptions): Promise<TransactionExplanation>;
-    /**
-     * @deprecated
-     */
-    initiateRecovery(params: RecoveryOptions): never;
-    /**
-     * Make a request to one of the public EOS nodes available
-     * @param params.endpoint
-     * @param params.payload
-     */
-    protected getDataFromNode(params: {
-        endpoint: string;
-        payload?: Record<string, unknown>;
-    }): Promise<request.Response>;
-    /**
-     * Get EOS chain info from a public node
-     */
-    protected getChainInfoFromNode(): Promise<any>;
-    /**
-     * Get data specific to an account from a public node
-     * @param address
-     */
-    protected getAccountFromNode({ address }: {
-        address: string;
-    }): Promise<any>;
-    /**
-     * Get block data from a public node using its block number or block id
-     * @param blockNumOrId
-     */
-    protected getBlockFromNode({ blockNumOrId }: {
-        blockNumOrId: string;
-    }): Promise<any>;
-    /**
-     * Get headers for an EOS tx from a public node
-     */
-    protected getTransactionHeadersFromNode(): Promise<any>;
-    protected getTransferAction({ recipient, sender, amount, memo }: any): EosTransactionAction;
-    /**
-     * Sign a transaction with a key
-     * @param signableTx
-     * @param signingKey
-     */
-    signTx(signableTx: string, signingKey: BIP32Interface): string;
-    /**
-     * Builds a funds recovery transaction without BitGo
-     * @param params
-     */
-    recover(params: RecoveryOptions): Promise<RecoveryTransaction>;
-    parseTransaction(params: ParseTransactionOptions): Promise<ParsedTransaction>;
-    /**
-     * Verify that a transaction prebuild complies with the original intention
-     *
-     * @param params
-     * @param params.txParams params used to build the transaction
-     * @param params.txPrebuild the prebuilt transaction
-     */
-    verifyTransaction(params: EosVerifyTransactionOptions): Promise<any>;
-    /**
-     * Generate a random EOS address.
-     *
-     * This is just a random string which abides by the EOS adddress constraints,
-     * and is not actually checked for availability on the EOS blockchain.
-     *
-     * Current EOS address constraints are:
-     * * Address must be exactly 12 characters
-     * * Address must only contain lowercase letters and numbers 1-5
-     * @returns a validly formatted EOS address, which may or may not actually be available on chain.
-     */
-    generateRandomAddress(params: Record<string, never>): string;
-}
-export {};
-//# sourceMappingURL=eos.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"eos.d.ts","sourceRoot":"","sources":["../../src/eos.ts"],"names":[],"mappings":";AAIA,OAAO,EAAS,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAM7D,OAAO,KAAK,OAAO,MAAM,YAAY,CAAC;AAKtC,OAAO,EACL,QAAQ,EACR,SAAS,EAMT,4BAA4B,IAAI,yBAAyB,EAEzD,OAAO,EACP,iBAAiB,EACjB,uBAAuB,EACvB,aAAa,EACb,sBAAsB,IAAI,0BAA0B,EACpD,sBAAsB,EAEtB,mBAAmB,EACnB,oBAAoB,IAAI,wBAAwB,EAChD,wBAAwB,IAAI,4BAA4B,EACxD,MAAM,EACP,MAAM,sBAAsB,CAAC;AAE9B,UAAU,cAAc;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,KAAK;IACpB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,UAAU,qBAAqB;IAC7B,gBAAgB,EAAE,MAAM,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,UAAU,oBAAoB;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACvD,IAAI,EAAE,kBAAkB,GAAG,eAAe,GAAG,cAAc,CAAC;CAC7D;AAED,UAAU,sBAAsB;IAC9B,UAAU,EAAE,SAAS,EAAE,CAAC;IACxB,OAAO,EAAE,qBAAqB,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,KAAK,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,wBAAyB,SAAQ,0BAA0B;IAC1E,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,sBAAsB,CAAC;IACnC,UAAU,EAAE,SAAS,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,2BAA4B,SAAQ,4BAA4B;IAC/E,UAAU,EAAE,sBAAsB,CAAC;IACnC,QAAQ,EAAE,wBAAwB,CAAC;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,mBAAmB,CAAC;IACnC,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB;AAED,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,SAAS,EAAE,CAAC;IACxB,OAAO,EAAE,qBAAqB,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,KAAK,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,oBAAqB,SAAQ,yBAAyB;IACrE,UAAU,EAAE,aAAa,CAAC;CAC3B;AAoBD,UAAU,kBAAkB;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,UAAU,eAAe;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAgBD,UAAU,cAAc;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,UAAU,yBAAyB;IACjC,WAAW,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC;IACpC,OAAO,EAAE,qBAAqB,CAAC;CAChC;AAED,UAAU,mBAAmB;IAC3B,WAAW,EAAE,KAAK,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,UAAU,eAAe;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,UAAU,oBAAqB,SAAQ,wBAAwB;IAC7D,WAAW,EAAE,MAAM,CAAC;CACrB;AAkBD,qBAAa,GAAI,SAAQ,QAAQ;IAC/B,OAAc,mBAAmB,WAA+C;IAChF,OAAc,cAAc,SAAM;IAElC,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,SAAS,GAAG,QAAQ;IAIjD,UAAU,IAAI,MAAM;IAIpB,QAAQ,IAAI,MAAM;IAIlB,SAAS,IAAI,MAAM;IAInB,WAAW,IAAI,MAAM;IAIrB,aAAa,IAAI,MAAM;IAIvB,IAAI,aAAa,WAEhB;IAED;;;OAGG;IACH,wBAAwB,IAAI,OAAO;IAInC;;OAEG;IACH,iBAAiB,IAAI,MAAM,EAAE;IAG7B;;;;OAIG;IACH,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO;IAevC;;;;OAIG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAQhC;;;;OAIG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAQhC;;;;OAIG;IACH,WAAW,CAAC,EAAE,KAAK,EAAE,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO;IAIlD;;;;OAIG;IACH,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAItC;;;OAGG;IACH,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,cAAc;IAgDlD;;;OAGG;IACH,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM;IAOvD;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,cAAc,GAAG,MAAM;IAO7D;;;;OAIG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IASxC;;;;OAIG;IACG,eAAe,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAyBvF;;;;;;;OAOG;IACG,eAAe,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAwBtF,OAAO,CAAC,uBAAuB;IAgB/B,OAAO,CAAC,yBAAyB;IAgBjC,OAAO,CAAC,MAAM,CAAC,sBAAsB;IAcrC,OAAO,CAAC,MAAM,CAAC,sBAAsB;IAIrC;;;;OAIG;YACW,sBAAsB;IAiNpC;;;OAGG;IACG,kBAAkB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IA+B5F;;OAEG;IACH,gBAAgB,CAAC,MAAM,EAAE,eAAe,GAAG,KAAK;IAIhD;;;;OAIG;cACa,eAAe,CAAC,MAAM,EAAE;QACtC,QAAQ,EAAE,MAAM,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACnC,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC;IAY7B;;OAEG;cACa,oBAAoB,IAAI,OAAO,CAAC,GAAG,CAAC;IAQpD;;;OAGG;cACa,kBAAkB,CAAC,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAWlF;;;OAGG;cACa,gBAAgB,CAAC,EAAE,YAAY,EAAE,EAAE;QAAE,YAAY,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAW1F;;OAEG;cACa,6BAA6B,IAAI,OAAO,CAAC,GAAG,CAAC;IAc7D,SAAS,CAAC,iBAAiB,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,GAAG,GAAG,oBAAoB;IAmB3F;;;;OAIG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,cAAc,GAAG,MAAM;IAM9D;;;OAGG;IACG,OAAO,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA8I9D,gBAAgB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAInF;;;;;;OAMG;IACG,iBAAiB,CAAC,MAAM,EAAE,2BAA2B,GAAG,OAAO,CAAC,GAAG,CAAC;IAiG1E;;;;;;;;;;OAUG;IACH,qBAAqB,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,MAAM;CAW7D"}