@bitgo-beta/abstract-substrate 1.0.1-beta.20 → 1.0.1-beta.21

package/dist/src/lib/utils.d.ts

@@ -0,0 +1,258 @@
+import { DotAssetTypes, BaseUtils, DotAddressFormat, Seed } from '@bitgo-beta/sdk-core';
+import { KeyringPair } from '@polkadot/keyring/types';
+import { Args, BaseTxInfo, OptionsWithMeta, UnsignedTransaction } from '@substrate/txwrapper-core';
+import { DecodedSignedTx, DecodedSigningPayload, TypeRegistry } from '@substrate/txwrapper-core/lib/types';
+import { AddProxyBatchCallArgs, BatchArgs, BatchCallObject, HexString, ProxyArgs, StakeArgs, StakeBatchCallArgs, StakeMoreArgs, StakeMoreCallArgs, TransferAllArgs, TransferArgs, TxMethod, UnstakeBatchCallArgs } from './iface';
+import { KeyPair } from '.';
+export declare class Utils implements BaseUtils {
+    /** @inheritdoc */
+    isValidAddress(address: string): boolean;
+    /** @inheritdoc */
+    isValidBlockId(hash: string): boolean;
+    /** @inheritdoc */
+    isValidPrivateKey(key: string): boolean;
+    /** @inheritdoc */
+    isValidPublicKey(key: string): boolean;
+    /** @inheritdoc */
+    isValidSignature(signature: string): boolean;
+    /**
+     * Verifies the signature on a given message
+     *
+     * @param {string} signedMessage the signed message for the signature
+     * @param {string} signature the signature to verify
+     * @param {string} address the address of the signer
+     * @returns {boolean} whether the signature is valid or not
+     */
+    verifySignature(signedMessage: string, signature: string, address: string): boolean;
+    /** @inheritdoc */
+    isValidTransactionId(txId: string): boolean;
+    /**
+     * decodeSeed decodes a substrate seed
+     *
+     * @param {string} seed - the seed to be validated.
+     * @returns {Seed} - the object Seed
+     */
+    decodeSeed(seed: string): Seed;
+    /**
+     * Helper function to capitalize the first letter of a string
+     *
+     * @param {string} val
+     * @returns {string}
+     */
+    capitalizeFirstLetter(val: string): string;
+    /**
+     * Helper function to decode the internal method hex in case of a proxy transaction
+     *
+     * @param {string | UnsignedTransaction} tx
+     * @param { metadataRpc: string; registry: TypeRegistry } options
+     * @returns {TransferArgs}
+     */
+    decodeCallMethod(tx: string | UnsignedTransaction, options: {
+        metadataRpc: string;
+        registry: TypeRegistry;
+    }): TransferArgs;
+    /**
+     * keyPairFromSeed generates an object with secretKey and publicKey using the substrate sdk
+     * @param seed 32 bytes long seed
+     * @returns KeyPair
+     */
+    keyPairFromSeed(seed: Uint8Array): KeyPair;
+    /**
+     * Signing function. Implement this on the OFFLINE signing device.
+     *
+     * @param {KeyringPair} pair - The signing pair.
+     * @param {string} signingPayload - Payload to sign.
+     * @param {UnsignedTransaction} transaction - raw transaction to sign
+     * @param {Object} options
+     * @param {HexString} options.metadataRpc - metadata that is needed for substrate to sign
+     * @param {TypeRegistry} options.registry - metadata that is needed for substrate to sign
+     */
+    createSignedTx(pair: KeyringPair, signingPayload: string, transaction: UnsignedTransaction, options: {
+        metadataRpc: HexString;
+        registry: TypeRegistry;
+    }): string;
+    /**
+     * Serializes the signed transaction
+     *
+     * @param transaction Transaction to serialize
+     * @param signature Signature of the message
+     * @param metadataRpc Network metadata
+     * @param registry Transaction registry
+     * @returns string Serialized transaction
+     */
+    serializeSignedTransaction(transaction: any, signature: any, metadataRpc: `0x${string}`, registry: any): string;
+    /**
+     * Decodes the substrate address from the given format
+     *
+     * @param {string} address
+     * @param {number} [ss58Format]
+     * @returns {string}
+     */
+    decodeSubstrateAddress(address: string, ss58Format: number): string;
+    /**
+     * Decodes the substrate address from the given format
+     *
+     * @param {string} address
+     * @param {number} [ss58Format]
+     * @returns {string}
+     */
+    encodeSubstrateAddress(address: string, ss58Format?: number): string;
+    /**
+     * Retrieves the txHash of a signed txHex
+     *
+     * @param txHex signed transaction hex
+     * @returns {string}
+     */
+    getTxHash(txHex: string): string;
+    isSigningPayload(payload: DecodedSigningPayload | DecodedSignedTx): payload is DecodedSigningPayload;
+    isProxyTransfer(arg: TxMethod['args']): arg is ProxyArgs;
+    isTransfer(arg: TxMethod['args']): arg is TransferArgs;
+    isTransferAll(arg: TxMethod['args']): arg is TransferAllArgs;
+    /**
+     * Returns true if arg is of type BatchArgs, false otherwise.
+     *
+     * @param arg The object to test.
+     *
+     * @return true if arg is of type BatchArgs, false otherwise.
+     */
+    isBatch(arg: TxMethod['args']): arg is BatchArgs;
+    /**
+     * Returns true if arg is of type BatchArgs and the calls of the batch are staking calls: a stake
+     * call (bond) followed by an add proxy call (addProxy), false otherwise.
+     *
+     * @param arg The object to test.
+     *
+     * @return true if arg is of type BatchArgs and the calls of the batch are staking calls: a stake
+     * call (bond) followed by an add proxy call (addProxy), false otherwise.
+     */
+    isStakingBatch(arg: TxMethod['args']): arg is BatchArgs;
+    /**
+     * Returns true if arg is of type StakeBatchCallArgs, false otherwise.
+     *
+     * @param arg The object to test.
+     *
+     * @return true if arg is of type StakeBatchCallArgs, false otherwise.
+     */
+    isStakeBatchCallArgs(arg: BatchCallObject['args']): arg is StakeBatchCallArgs;
+    /**
+     * Returns true if arg is of type AddProxyBatchCallArgs, false otherwise.
+     *
+     * @param arg The object to test.
+     *
+     * @return true if arg is of type AddProxyBatchCallArgs, false otherwise.
+     */
+    isAddProxyBatchCallArgs(arg: BatchCallObject['args']): arg is AddProxyBatchCallArgs;
+    /**
+     * Returns true if arg is of type BatchArgs and the calls of the batch are unstaking calls: a remove
+     * proxy call (removeProxy), followed by a chill call, and an unstake call (unbond), false otherwise.
+     *
+     * @param arg The object to test.
+     *
+     * @return true if arg is of type BatchArgs and the calls of the batch are unstaking calls: a remove
+     * proxy call (removeProxy), followed by a chill call, and an unstake call (unbond), false otherwise.
+     */
+    isUnstakingBatch(arg: TxMethod['args']): arg is BatchArgs;
+    /**
+     * Returns true if arg is of type AddProxyBatchCallArgs, false otherwise.
+     *
+     * @param arg The object to test.
+     *
+     * @return true if arg is of type AddProxyBatchCallArgs, false otherwise.
+     */
+    isRemoveProxyBatchCallArgs(arg: BatchCallObject['args']): arg is AddProxyBatchCallArgs;
+    /**
+     * Returns true if arg is of type UnstakeBatchCallArgs, false otherwise.
+     *
+     * @param arg The object to test.
+     *
+     * @return true if arg is of type UnstakeBatchCallArgs, false otherwise.
+     */
+    isUnstakeBatchCallArgs(arg: BatchCallObject['args']): arg is UnstakeBatchCallArgs;
+    /**
+     * Returns true if arg is of type StakeArgs, false otherwise.
+     *
+     * @param arg The object to test.
+     *
+     * @return true if arg is of type StakeArgs, false otherwise.
+     */
+    isBond(arg: TxMethod['args']): arg is StakeArgs;
+    /**
+     * Returns true if arg is of type StakeMoreArgs, false otherwise.
+     *
+     * @param arg The object to test.
+     *
+     * @return true if arg is of type StakeMoreArgs, false otherwise.
+     */
+    isBondExtra(arg: TxMethod['args'] | BatchCallObject['args']): arg is StakeMoreArgs;
+    /**
+     * Returns true if arg is of type StakeMoreArgs, false otherwise.
+     *
+     * @param arg The object to test.
+     *
+     * @return true if arg is of type StakeMoreArgs, false otherwise.
+     */
+    isBondBatchExtra(arg: BatchCallObject['args']): arg is StakeMoreCallArgs;
+    /**
+     * extracts and returns the signature in hex format given a raw signed transaction
+     *
+     * @param {string} rawTx signed raw transaction
+     * @param options registry substrate registry used to retrieve the signature
+     */
+    recoverSignatureFromRawTx(rawTx: string, options: {
+        registry: TypeRegistry;
+    }): string;
+    /**
+     * Decodes the dot address from the given format
+     *
+     * @param {string} address
+     * @param {number} [ss58Format]
+     * @returns {KeyPair}
+     */
+    decodeSubstrateAddressToKeyPair(address: string, ss58Format?: number): KeyPair;
+    /**
+     * Checks whether the given input is a hex string with with 0 value
+     * used to check whether a given transaction is immortal or mortal
+     * @param hexValue
+     */
+    isZeroHex(hexValue: string): boolean;
+    /**
+     * Takes an asset name and returns the respective address to format to
+     * since substrate addresses differ depending on the network
+     * @param networkCoinName
+     */
+    getAddressFormat(networkCoinName: DotAssetTypes): DotAddressFormat;
+    /**
+     * Creates a pure proxy extrinsic. Substrate has renamed anonymous proxies to pure proxies, but
+     * the libraries we are using to build transactions have not been updated, as a stop gap we are
+     * defining the pure proxy extrinsic here.
+     *
+     * @param args Arguments to the createPure extrinsic.
+     * @param info Common information to all transactions.
+     * @param options Chain registry and metadata.
+     */
+    pureProxy(args: PureProxyArgs, info: BaseTxInfo, options: OptionsWithMeta): UnsignedTransaction;
+    /**
+     * Removes '0x' from a given `string` if present.
+     *
+     * @param {string} str the string value.
+     *
+     * @return {string} a string without a '0x' prefix.
+     */
+    stripHexPrefix(str: string): string;
+    /**
+     * Returns true if a string starts with '0x', false otherwise.
+     *
+     * @param {string} str the string value.
+     *
+     * @return {boolean} true if a string starts with '0x', false otherwise.
+     */
+    isHexPrefixed(str: string): boolean;
+}
+interface PureProxyArgs extends Args {
+    proxyType: string;
+    delay: number;
+    index: number;
+}
+declare const utils: Utils;
+export default utils;
+//# sourceMappingURL=utils.d.ts.map

package/dist/src/lib/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/lib/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,gBAAgB,EAAqC,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAG3H,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAKtD,OAAO,EAAE,IAAI,EAAE,UAAU,EAAgB,eAAe,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AACjH,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,YAAY,EAAE,MAAM,qCAAqC,CAAC;AAM3G,OAAO,EACL,qBAAqB,EACrB,SAAS,EACT,eAAe,EACf,SAAS,EACT,SAAS,EAET,SAAS,EACT,kBAAkB,EAClB,aAAa,EACb,iBAAiB,EACjB,eAAe,EACf,YAAY,EACZ,QAAQ,EACR,oBAAoB,EACrB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,CAAC;AAS5B,qBAAa,KAAM,YAAW,SAAS;IACrC,kBAAkB;IAClB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IASxC,kBAAkB;IAClB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAIrC,kBAAkB;IAClB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IASvC,kBAAkB;IAClB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAatC,kBAAkB;IAClB,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAK5C;;;;;;;OAOG;IACH,eAAe,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO;IAOnF,kBAAkB;IAClB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI3C;;;;;OAKG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAO9B;;;;;OAKG;IACH,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAI1C;;;;;;OAMG;IACH,gBAAgB,CACd,EAAE,EAAE,MAAM,GAAG,mBAAmB,EAChC,OAAO,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,YAAY,CAAA;KAAE,GACvD,YAAY;IAuBf;;;;OAIG;IACH,eAAe,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO;IAQ1C;;;;;;;;;OASG;IACH,cAAc,CACZ,IAAI,EAAE,WAAW,EACjB,cAAc,EAAE,MAAM,EACtB,WAAW,EAAE,mBAAmB,EAChC,OAAO,EAAE;QAAE,WAAW,EAAE,SAAS,CAAC;QAAC,QAAQ,EAAE,YAAY,CAAA;KAAE,GAC1D,MAAM;IAYT;;;;;;;;OAQG;IACH,0BAA0B,CAAC,WAAW,KAAA,EAAE,SAAS,KAAA,EAAE,WAAW,EAAE,KAAK,MAAM,EAAE,EAAE,QAAQ,KAAA,GAAG,MAAM;IAOhG;;;;;;OAMG;IACH,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM;IAKnE;;;;;;OAMG;IACH,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM;IAIpE;;;;;OAKG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAIhC,gBAAgB,CAAC,OAAO,EAAE,qBAAqB,GAAG,eAAe,GAAG,OAAO,IAAI,qBAAqB;IAIpG,eAAe,CAAC,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,SAAS;IAIxD,UAAU,CAAC,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,YAAY;IAItD,aAAa,CAAC,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,eAAe;IAI5D;;;;;;OAMG;IACH,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,SAAS;IAIhD;;;;;;;;OAQG;IACH,cAAc,CAAC,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,SAAS;IAYvD;;;;;;OAMG;IACH,oBAAoB,CAAC,GAAG,EAAE,eAAe,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,kBAAkB;IAI7E;;;;;;OAMG;IACH,uBAAuB,CAAC,GAAG,EAAE,eAAe,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,qBAAqB;IAQnF;;;;;;;;OAQG;IACH,gBAAgB,CAAC,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,SAAS;IAazD;;;;;;OAMG;IACH,0BAA0B,CAAC,GAAG,EAAE,eAAe,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,qBAAqB;IAQtF;;;;;;OAMG;IACH,sBAAsB,CAAC,GAAG,EAAE,eAAe,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,oBAAoB;IAIjF;;;;;;OAMG;IACH,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,SAAS;IAI/C;;;;;;OAMG;IACH,WAAW,CAAC,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,eAAe,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,aAAa;IAIlF;;;;;;OAMG;IACH,gBAAgB,CAAC,GAAG,EAAE,eAAe,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,iBAAiB;IAIxE;;;;;OAKG;IACH,yBAAyB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,QAAQ,EAAE,YAAY,CAAA;KAAE,GAAG,MAAM;IAcrF;;;;;;OAMG;IACH,+BAA+B,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO;IAI9E;;;;OAIG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAIpC;;;;OAIG;IACH,gBAAgB,CAAC,eAAe,EAAE,aAAa,GAAG,gBAAgB;IAIlE;;;;;;;;OAQG;IACH,SAAS,CAAC,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,eAAe,GAAG,mBAAmB;IAc/F;;;;;;OAMG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAInC;;;;;;OAMG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;CAGpC;AAED,UAAU,aAAc,SAAQ,IAAI;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED,QAAA,MAAM,KAAK,OAAc,CAAC;AAE1B,eAAe,KAAK,CAAC"}