@fuel-ts/account 0.0.0-rc-1889-20240322122653 → 0.0.0-rc-1815-20240322131329

package/dist/mnemonic/index.d.ts

@@ -0,0 +1,3 @@
+export { default as Mnemonic, MNEMONIC_SIZES } from './mnemonic';
+export type { MnemonicPhrase } from './utils';
+//# sourceMappingURL=index.d.ts.map

package/dist/mnemonic/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/mnemonic/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AACjE,YAAY,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC"}

package/dist/mnemonic/mnemonic.d.ts

@@ -0,0 +1,85 @@
+import type { BytesLike } from '@fuel-ts/interfaces';
+import type { MnemonicPhrase } from './utils';
+export declare const MNEMONIC_SIZES: number[];
+declare class Mnemonic {
+    wordlist: Array<string>;
+    /**
+     *
+     * @param wordlist - Provide a wordlist with the list of words used to generate the mnemonic phrase. The default value is the English list.
+     * @returns Mnemonic instance
+     */
+    constructor(wordlist?: Array<string>);
+    /**
+     *
+     * @param phrase - Mnemonic phrase composed by words from the provided wordlist
+     * @returns Entropy hash
+     */
+    mnemonicToEntropy(phrase: MnemonicPhrase): string;
+    /**
+     *
+     * @param entropy - Entropy source to the mnemonic phrase.
+     * @returns Mnemonic phrase
+     */
+    entropyToMnemonic(entropy: BytesLike): string;
+    /**
+     *
+     * @param phrase - Mnemonic phrase composed by words from the provided wordlist
+     * @param wordlist - Provide a wordlist with the list of words used to generate the mnemonic phrase. The default value is the English list.
+     * @returns Mnemonic phrase
+     */
+    static mnemonicToEntropy(phrase: MnemonicPhrase, wordlist?: Array<string>): string;
+    /**
+     * @param entropy - Entropy source to the mnemonic phrase.
+     * @param testnet - Inform if should use testnet or mainnet prefix, default value is true (`mainnet`).
+     * @returns 64-byte array contains privateKey and chainCode as described on BIP39
+     */
+    static entropyToMnemonic(entropy: BytesLike, wordlist?: Array<string>): string;
+    /**
+     * @param phrase - Mnemonic phrase composed by words from the provided wordlist
+     * @param passphrase - Add additional security to protect the generated seed with a memorized passphrase. `Note: if the owner forgot the passphrase, all wallets and accounts derive from the phrase will be lost.`
+     * @returns 64-byte array contains privateKey and chainCode as described on BIP39
+     */
+    static mnemonicToSeed(phrase: MnemonicPhrase, passphrase?: BytesLike): string;
+    /**
+     * @param phrase - Mnemonic phrase composed by words from the provided wordlist
+     * @param passphrase - Add additional security to protect the generated seed with a memorized passphrase. `Note: if the owner forgot the passphrase, all wallets and accounts derive from the phrase will be lost.`
+     * @returns 64-byte array contains privateKey and chainCode as described on BIP39
+     */
+    static mnemonicToMasterKeys(phrase: MnemonicPhrase, passphrase?: BytesLike): Uint8Array;
+    /**
+     * Validates if given mnemonic is  valid
+     * @param phrase - Mnemonic phrase composed by words from the provided wordlist
+     * @returns true if phrase is a valid mnemonic
+     */
+    static isMnemonicValid(phrase: string): boolean;
+    static binarySearch(target: string): boolean;
+    /**
+     * @param seed - BIP39 seed
+     * @param testnet - Inform if should use testnet or mainnet prefix, the default value is true (`mainnet`).
+     * @returns 64-byte array contains privateKey and chainCode as described on BIP39
+     */
+    static masterKeysFromSeed(seed: string): Uint8Array;
+    /**
+     * Get the extendKey as defined on BIP-32 from the provided seed
+     *
+     * @param seed - BIP39 seed
+     * @param testnet - Inform if should use testnet or mainnet prefix, default value is true (`mainnet`).
+     * @returns BIP-32 extended private key
+     */
+    static seedToExtendedKey(seed: string, testnet?: boolean): string;
+    /**
+     *  Create a new mnemonic using a randomly generated number as entropy.
+     *  As defined in BIP39, the entropy must be a multiple of 32 bits, and its size must be between 128 and 256 bits.
+     *  Therefore, the possible values for `strength` are 128, 160, 192, 224, and 256.
+     *  If not provided, the default entropy length will be set to 256 bits.
+     *  The return is a list of words that encodes the generated entropy.
+     *
+     *
+     * @param size - Number of bytes used as an entropy
+     * @param extraEntropy - Optional extra entropy to increase randomness
+     * @returns A randomly generated mnemonic
+     */
+    static generate(size?: number, extraEntropy?: BytesLike): string;
+}
+export default Mnemonic;
+//# sourceMappingURL=mnemonic.d.ts.map

package/dist/mnemonic/mnemonic.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mnemonic.d.ts","sourceRoot":"","sources":["../../src/mnemonic/mnemonic.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAMrD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAiB9C,eAAO,MAAM,cAAc,UAAuB,CAAC;AA8BnD,cAAM,QAAQ;IACZ,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;;;OAIG;gBACS,QAAQ,GAAE,KAAK,CAAC,MAAM,CAAW;IAM7C;;;;OAIG;IACH,iBAAiB,CAAC,MAAM,EAAE,cAAc;IAIxC;;;;OAIG;IACH,iBAAiB,CAAC,OAAO,EAAE,SAAS;IAIpC;;;;;OAKG;IACH,MAAM,CAAC,iBAAiB,CAAC,MAAM,EAAE,cAAc,EAAE,QAAQ,GAAE,KAAK,CAAC,MAAM,CAAW,GAAG,MAAM;IAQ3F;;;;OAIG;IACH,MAAM,CAAC,iBAAiB,CAAC,OAAO,EAAE,SAAS,EAAE,QAAQ,GAAE,KAAK,CAAC,MAAM,CAAW,GAAG,MAAM;IAWvF;;;;OAIG;IACH,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,cAAc,EAAE,UAAU,GAAE,SAAc;IASxE;;;;OAIG;IACH,MAAM,CAAC,oBAAoB,CAAC,MAAM,EAAE,cAAc,EAAE,UAAU,GAAE,SAAc;IAK9E;;;;OAIG;IACH,MAAM,CAAC,eAAe,CAAC,MAAM,EAAE,MAAM;IAqBrC,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAqB5C;;;;OAIG;IACH,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU;IAanD;;;;;;OAMG;IACH,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,OAAe,GAAG,MAAM;IAuBxE;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,GAAE,MAAW,EAAE,YAAY,GAAE,SAAc;CAMhE;AAED,eAAe,QAAQ,CAAC"}

package/dist/mnemonic/utils.d.ts

@@ -0,0 +1,8 @@
+import type { BytesLike } from '@fuel-ts/interfaces';
+export type MnemonicPhrase = string | Array<string>;
+export declare function toUtf8Bytes(stri: string): Uint8Array;
+export declare function getWords(mnemonic: MnemonicPhrase): Array<string>;
+export declare function getPhrase(mnemonic: MnemonicPhrase): string;
+export declare function entropyToMnemonicIndices(entropy: Uint8Array): Array<number>;
+export declare function mnemonicWordsToEntropy(words: Array<string>, wordlist: Array<string>): BytesLike;
+//# sourceMappingURL=utils.d.ts.map

package/dist/mnemonic/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/mnemonic/utils.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAIrD,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;AAEpD,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAqCpD;AAYD,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC,CAKhE;AAED,wBAAgB,SAAS,CAAC,QAAQ,EAAE,cAAc,GAAG,MAAM,CAK1D;AAED,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,CA+B3E;AAED,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAkC/F"}

package/dist/predicate/index.d.ts

@@ -0,0 +1,3 @@
+export * from './predicate';
+export * from './utils/getPredicateRoot';
+//# sourceMappingURL=index.d.ts.map

package/dist/predicate/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/predicate/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,0BAA0B,CAAC"}

package/dist/predicate/predicate.d.ts

@@ -0,0 +1,94 @@
+import type { JsonAbi, InputValue } from '@fuel-ts/abi-coder';
+import { Interface } from '@fuel-ts/abi-coder';
+import type { AbstractAddress, BytesLike } from '@fuel-ts/interfaces';
+import type { BigNumberish } from '@fuel-ts/math';
+import { Account } from '../account';
+import type { TxParamsType } from '../account';
+import type { CallResult, Provider, ProviderSendTxParams, TransactionRequest, TransactionRequestLike, TransactionResponse } from '../providers';
+export type PredicateParams<T = InputValue[]> = {
+    bytecode: BytesLike;
+    provider: Provider;
+    abi?: JsonAbi;
+    inputData?: T;
+    configurableConstants?: {
+        [name: string]: unknown;
+    };
+};
+/**
+ * `Predicate` provides methods to populate transaction data with predicate information and sending transactions with them.
+ */
+export declare class Predicate<TInputData extends InputValue[]> extends Account {
+    bytes: Uint8Array;
+    predicateDataBytes: Uint8Array;
+    predicateData: TInputData;
+    interface?: Interface;
+    /**
+     * Creates an instance of the Predicate class.
+     *
+     * @param bytecode - The bytecode of the predicate.
+     * @param abi - The JSON ABI of the predicate.
+     * @param provider - The provider used to interact with the blockchain.
+     * @param inputData - The predicate input data (optional).
+     * @param configurableConstants - Optional configurable constants for the predicate.
+     */
+    constructor({ bytecode, abi, provider, inputData, configurableConstants, }: PredicateParams<TInputData>);
+    /**
+     * Populates the transaction data with predicate data.
+     *
+     * @param transactionRequestLike - The transaction request-like object.
+     * @returns The transaction request with predicate data.
+     */
+    populateTransactionPredicateData(transactionRequestLike: TransactionRequestLike): TransactionRequest;
+    /**
+     * A helper that creates a transfer transaction request and returns it.
+     *
+     * @param destination - The address of the destination.
+     * @param amount - The amount of coins to transfer.
+     * @param assetId - The asset ID of the coins to transfer.
+     * @param txParams - The transaction parameters (gasLimit, gasPrice, maturity).
+     * @returns A promise that resolves to the prepared transaction request.
+     */
+    createTransfer(
+    /** Address of the destination */
+    destination: AbstractAddress, 
+    /** Amount of coins */
+    amount: BigNumberish, 
+    /** Asset ID of coins */
+    assetId?: BytesLike, 
+    /** Tx Params */
+    txParams?: TxParamsType): Promise<TransactionRequest>;
+    /**
+     * Sends a transaction with the populated predicate data.
+     *
+     * @param transactionRequestLike - The transaction request-like object.
+     * @returns A promise that resolves to the transaction response.
+     */
+    sendTransaction(transactionRequestLike: TransactionRequestLike, options?: Pick<ProviderSendTxParams, 'awaitExecution'>): Promise<TransactionResponse>;
+    /**
+     * Simulates a transaction with the populated predicate data.
+     *
+     * @param transactionRequestLike - The transaction request-like object.
+     * @returns A promise that resolves to the call result.
+     */
+    simulateTransaction(transactionRequestLike: TransactionRequestLike): Promise<CallResult>;
+    private getPredicateData;
+    /**
+     * Processes the predicate data and returns the altered bytecode and interface.
+     *
+     * @param bytes - The bytes of the predicate.
+     * @param jsonAbi - The JSON ABI of the predicate.
+     * @param configurableConstants - Optional configurable constants for the predicate.
+     * @returns An object containing the new predicate bytes and interface.
+     */
+    private static processPredicateData;
+    /**
+     * Sets the configurable constants for the predicate.
+     *
+     * @param bytes - The bytes of the predicate.
+     * @param configurableConstants - Configurable constants to be set.
+     * @param abiInterface - The ABI interface of the predicate.
+     * @returns The mutated bytes with the configurable constants set.
+     */
+    private static setConfigurableConstants;
+}
+//# sourceMappingURL=predicate.d.ts.map

package/dist/predicate/predicate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"predicate.d.ts","sourceRoot":"","sources":["../../src/predicate/predicate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EACL,SAAS,EAKV,MAAM,oBAAoB,CAAC;AAI5B,OAAO,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACtE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAIlD,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C,OAAO,KAAK,EACV,UAAU,EACV,QAAQ,EACR,oBAAoB,EACpB,kBAAkB,EAClB,sBAAsB,EACtB,mBAAmB,EACpB,MAAM,cAAc,CAAC;AAItB,MAAM,MAAM,eAAe,CAAC,CAAC,GAAG,UAAU,EAAE,IAAI;IAC9C,QAAQ,EAAE,SAAS,CAAC;IACpB,QAAQ,EAAE,QAAQ,CAAC;IACnB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,SAAS,CAAC,EAAE,CAAC,CAAC;IACd,qBAAqB,CAAC,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACrD,CAAC;AAEF;;GAEG;AACH,qBAAa,SAAS,CAAC,UAAU,SAAS,UAAU,EAAE,CAAE,SAAQ,OAAO;IACrE,KAAK,EAAE,UAAU,CAAC;IAClB,kBAAkB,EAAE,UAAU,CAAuB;IACrD,aAAa,EAAE,UAAU,CAA+B;IACxD,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB;;;;;;;;OAQG;gBACS,EACV,QAAQ,EACR,GAAG,EACH,QAAQ,EACR,SAAS,EACT,qBAAqB,GACtB,EAAE,eAAe,CAAC,UAAU,CAAC;IAgB9B;;;;;OAKG;IACH,gCAAgC,CAAC,sBAAsB,EAAE,sBAAsB;IAiB/E;;;;;;;;OAQG;IACG,cAAc;IAClB,iCAAiC;IACjC,WAAW,EAAE,eAAe;IAC5B,sBAAsB;IACtB,MAAM,EAAE,YAAY;IACpB,wBAAwB;IACxB,OAAO,GAAE,SAAuB;IAChC,gBAAgB;IAChB,QAAQ,GAAE,YAAiB,GAC1B,OAAO,CAAC,kBAAkB,CAAC;IAK9B;;;;;OAKG;IACH,eAAe,CACb,sBAAsB,EAAE,sBAAsB,EAC9C,OAAO,CAAC,EAAE,IAAI,CAAC,oBAAoB,EAAE,gBAAgB,CAAC,GACrD,OAAO,CAAC,mBAAmB,CAAC;IAK/B;;;;;OAKG;IACH,mBAAmB,CAAC,sBAAsB,EAAE,sBAAsB,GAAG,OAAO,CAAC,UAAU,CAAC;IAKxF,OAAO,CAAC,gBAAgB;IAsBxB;;;;;;;OAOG;IACH,OAAO,CAAC,MAAM,CAAC,oBAAoB;IAgCnC;;;;;;;OAOG;IACH,OAAO,CAAC,MAAM,CAAC,wBAAwB;CAsCxC"}

package/dist/predicate/utils/getPredicateRoot.d.ts

@@ -0,0 +1,12 @@
+import type { BytesLike } from '@fuel-ts/interfaces';
+/**
+ * @hidden
+ *
+ * Calculates the predicate root for a given bytecode and chain ID.
+ *
+ * @param bytecode - The bytecode represented as a BytesLike object.
+ * @param chainId - The ID of the chain associated with the bytecode.
+ * @returns The predicate root as a string.
+ */
+export declare const getPredicateRoot: (bytecode: BytesLike) => string;
+//# sourceMappingURL=getPredicateRoot.d.ts.map

package/dist/predicate/utils/getPredicateRoot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getPredicateRoot.d.ts","sourceRoot":"","sources":["../../../src/predicate/utils/getPredicateRoot.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAIrD;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,aAAc,SAAS,KAAG,MAQtD,CAAC"}

package/dist/predicate/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from './getPredicateRoot';
+//# sourceMappingURL=index.d.ts.map

package/dist/predicate/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/predicate/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC"}