@aptos-labs/ts-sdk 0.0.4 → 0.0.6

package/dist/esm/api/staking.d.mts

@@ -0,0 +1,53 @@
+import { AptosConfig } from './aptosConfig.mjs';
+import { OrderBy, GetNumberOfDelegatorsResponse, GetDelegatedStakingActivitiesResponse } from '../types/indexer.mjs';
+import { AccountAddressInput } from '../core/accountAddress.mjs';
+import '../types/index.mjs';
+import '../utils/apiEndpoints.mjs';
+import '../utils/const.mjs';
+import '../types/generated/operations.mjs';
+import '../types/generated/types.mjs';
+import '../bcs/serializer.mjs';
+import '../core/hex.mjs';
+import '../core/common.mjs';
+import '../bcs/deserializer.mjs';
+import '../transactions/instances/transactionArgument.mjs';
+
+/**
+ * A class to query all `Staking` related queries on Aptos.
+ */
+declare class Staking {
+    readonly config: AptosConfig;
+    constructor(config: AptosConfig);
+    /**
+     * Queries current number of delegators in a pool.  Throws an error if the pool is not found.
+     *
+     * @param args.poolAddress Pool address
+     * @returns The number of delegators for the given pool
+     */
+    getNumberOfDelegators(args: {
+        poolAddress: AccountAddressInput;
+    }): Promise<number>;
+    /**
+     * Queries current number of delegators in a pool.  Throws an error if the pool is not found.
+     *
+     * @returns GetNumberOfDelegatorsForAllPoolsResponse response type
+     */
+    getNumberOfDelegatorsForAllPools(args?: {
+        options?: {
+            orderBy?: OrderBy<GetNumberOfDelegatorsResponse[0]>;
+        };
+    }): Promise<GetNumberOfDelegatorsResponse>;
+    /**
+     * Queries delegated staking activities
+     *
+     * @param args.delegatorAddress Delegator address
+     * @param args.poolAddress Pool address
+     * @returns GetDelegatedStakingActivitiesResponse response type
+     */
+    getDelegatedStakingActivities(args: {
+        delegatorAddress: AccountAddressInput;
+        poolAddress: AccountAddressInput;
+    }): Promise<GetDelegatedStakingActivitiesResponse>;
+}
+
+export { Staking };

package/dist/esm/api/staking.mjs

@@ -0,0 +1,2 @@
+import{a}from"../chunk-BFSEVKNA.mjs";import"../chunk-VMQWW5UT.mjs";import"../chunk-7MNEEVXY.mjs";import"../chunk-WX43AJTD.mjs";import"../chunk-E7FWVXGX.mjs";import"../chunk-TCTZCPQ6.mjs";import"../chunk-N2FKVZ4D.mjs";import"../chunk-3JVGSFHP.mjs";import"../chunk-GEFQFRL3.mjs";import"../chunk-KC64ESLO.mjs";import"../chunk-LV33NV4J.mjs";import"../chunk-EGOYLZBU.mjs";import"../chunk-FYIFBLHU.mjs";import"../chunk-6FBKUTGF.mjs";import"../chunk-UPLWWSB4.mjs";import"../chunk-U3LO2FSJ.mjs";import"../chunk-U25N2VWA.mjs";import"../chunk-44MGBJ73.mjs";import"../chunk-YYRDFZE6.mjs";import"../chunk-62SCW5NH.mjs";import"../chunk-RYETO74W.mjs";import"../chunk-EFIYW4WK.mjs";import"../chunk-LR65XHSF.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-HVADSXTB.mjs";import"../chunk-BPYLPPEQ.mjs";import"../chunk-4ADA5BE7.mjs";import"../chunk-X32O46IB.mjs";import"../chunk-GTC7WHMV.mjs";import"../chunk-NZIJV4O2.mjs";import"../chunk-HA6JD5R6.mjs";import"../chunk-DNDWTM7A.mjs";import"../chunk-TIH6ARYP.mjs";import"../chunk-FBPNHF54.mjs";import"../chunk-Y7VR7X5W.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-ZWH2ESXT.mjs";export{a as Staking};
+//# sourceMappingURL=staking.mjs.map

package/dist/esm/api/staking.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/esm/api/transaction.d.mts

@@ -0,0 +1,101 @@
+import { AptosConfig } from './aptosConfig.mjs';
+import { PaginationArgs, TransactionResponse, AnyNumber, HexInput, WaitForTransactionOptions, GasEstimation } from '../types/index.mjs';
+import '../utils/apiEndpoints.mjs';
+import '../utils/const.mjs';
+import '../types/indexer.mjs';
+import '../types/generated/operations.mjs';
+import '../types/generated/types.mjs';
+
+declare class Transaction {
+    readonly config: AptosConfig;
+    constructor(config: AptosConfig);
+    /**
+     * Queries on-chain transactions. This function will not return pending
+     * transactions. For that, use `getTransactionsByHash`.
+     *
+     * @param args.options.offset The number transaction to start with
+     * @param args.options.limit Number of results to return
+     *
+     * @returns Array of on-chain transactions
+     */
+    getTransactions(args?: {
+        options?: PaginationArgs;
+    }): Promise<TransactionResponse[]>;
+    /**
+     * Queries on-chain transaction by version. This function will not return pending transactions.
+     *
+     * @param args.ledgerVersion - Transaction version is an unsigned 64-bit number.
+     * @returns On-chain transaction. Only on-chain transactions have versions, so this
+     * function cannot be used to query pending transactions.
+     */
+    getTransactionByVersion(args: {
+        ledgerVersion: AnyNumber;
+    }): Promise<TransactionResponse>;
+    /**
+     * Queries on-chain transaction by transaction hash. This function will return pending transactions.
+     * @param args.transactionHash - Transaction hash should be hex-encoded bytes string with 0x prefix.
+     * @returns Transaction from mempool (pending) or on-chain (committed) transaction
+     */
+    getTransactionByHash(args: {
+        transactionHash: HexInput;
+    }): Promise<TransactionResponse>;
+    /**
+     * Defines if specified transaction is currently in pending state
+     *
+     * To create a transaction hash:
+     *
+     * 1. Create a hash message from the bytes: "Aptos::Transaction" bytes + the BCS-serialized Transaction bytes.
+     * 2. Apply hash algorithm SHA3-256 to the hash message bytes.
+     * 3. Hex-encode the hash bytes with 0x prefix.
+     *
+     * @param args.transactionHash A hash of transaction
+     * @returns `true` if transaction is in pending state and `false` otherwise
+     */
+    isPendingTransaction(args: {
+        transactionHash: HexInput;
+    }): Promise<boolean>;
+    /**
+     * Waits for a transaction to move past the pending state.
+     *
+     * There are 4 cases.
+     * 1. Transaction is successfully processed and committed to the chain.
+     *    - The function will resolve with the transaction response from the API.
+     * 2. Transaction is rejected for some reason, and is therefore not committed to the blockchain.
+     *    - The function will throw an AptosApiError with an HTTP status code indicating some problem with the request.
+     * 3. Transaction is committed but execution failed, meaning no changes were
+     *    written to the blockchain state.
+     *    - If `checkSuccess` is true, the function will throw a FailedTransactionError
+     *      If `checkSuccess` is false, the function will resolve with the transaction response where the `success` field is false.
+     * 4. Transaction does not move past the pending state within `args.options.timeoutSecs` seconds.
+     *    - The function will throw a WaitForTransactionError
+     *
+     *
+     * @param args.transactionHash The hash of a transaction previously submitted to the blockchain.
+     * @param args.options.timeoutSecs Timeout in seconds. Defaults to 20 seconds.
+     * @param args.options.checkSuccess A boolean which controls whether the function will error if the transaction failed.
+     *   Defaults to true.  See case 3 above.
+     * @returns The transaction on-chain.  See above for more details.
+     */
+    waitForTransaction(args: {
+        transactionHash: HexInput;
+        options?: WaitForTransactionOptions;
+    }): Promise<TransactionResponse>;
+    /**
+     * Gives an estimate of the gas unit price required to get a
+     * transaction on chain in a reasonable amount of time.
+     * For more information {@link https://fullnode.mainnet.aptoslabs.com/v1/spec#/operations/estimate_gas_price}
+     *
+     * @returns Object holding the outputs of the estimate gas API
+     * @example
+     * ```
+     * {
+     *  gas_estimate: number;
+     *  deprioritized_gas_estimate?: number;
+     *  prioritized_gas_estimate?: number;
+     * }
+     * ```
+     */
+    getGasPriceEstimation(): Promise<GasEstimation>;
+}
+
+export { Transaction };

package/dist/esm/api/transaction.mjs

@@ -0,0 +1,2 @@
+import{a}from"../chunk-AAIBCWZY.mjs";import"../chunk-VYAVLUPJ.mjs";import"../chunk-3JPVQHOR.mjs";import"../chunk-AH44UPM4.mjs";import"../chunk-7MNEEVXY.mjs";import"../chunk-WX43AJTD.mjs";import"../chunk-N2FKVZ4D.mjs";import"../chunk-3JVGSFHP.mjs";import"../chunk-GEFQFRL3.mjs";import"../chunk-KC64ESLO.mjs";import"../chunk-LV33NV4J.mjs";import"../chunk-EGOYLZBU.mjs";import"../chunk-FYIFBLHU.mjs";import"../chunk-6FBKUTGF.mjs";import"../chunk-Y7VR7X5W.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-ZWH2ESXT.mjs";export{a as Transaction};
+//# sourceMappingURL=transaction.mjs.map

package/dist/esm/api/transaction.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/esm/api/transactionSubmission.d.mts

@@ -0,0 +1,142 @@
+import { AptosConfig } from './aptosConfig.mjs';
+import { Account } from '../core/account.mjs';
+import { AccountAddressInput } from '../core/accountAddress.mjs';
+import { PrivateKey } from '../core/crypto/asymmetricCrypto.mjs';
+import { UserTransactionResponse, PendingTransactionResponse, HexInput, TransactionResponse } from '../types/index.mjs';
+import { AccountAuthenticator } from '../transactions/authenticator/account.mjs';
+import { InputGenerateSingleSignerRawTransactionData, InputSingleSignerTransaction, InputGenerateFeePayerRawTransactionData, InputFeePayerTransaction, InputGenerateMultiAgentRawTransactionData, InputMultiAgentTransaction, InputGenerateTransactionData, AnyRawTransaction, InputSimulateTransactionData, InputSubmitTransactionData, InputGenerateTransactionOptions } from '../transactions/types.mjs';
+import '../utils/apiEndpoints.mjs';
+import '../utils/const.mjs';
+import '../core/authenticationKey.mjs';
+import '../core/hex.mjs';
+import '../core/common.mjs';
+import '../bcs/serializer.mjs';
+import '../bcs/deserializer.mjs';
+import '../transactions/instances/transactionArgument.mjs';
+import '../types/indexer.mjs';
+import '../types/generated/operations.mjs';
+import '../types/generated/types.mjs';
+import '../core/crypto/anyPublicKey.mjs';
+import '../core/crypto/anySignature.mjs';
+import '../core/crypto/ed25519.mjs';
+import '../core/crypto/multiEd25519.mjs';
+import '../core/crypto/multiKey.mjs';
+import '../bcs/serializable/moveStructs.mjs';
+import '../bcs/serializable/movePrimitives.mjs';
+import '../bcs/serializable/fixedBytes.mjs';
+import '../transactions/instances/rawTransaction.mjs';
+import '../transactions/instances/chainId.mjs';
+import '../transactions/instances/transactionPayload.mjs';
+import '../transactions/instances/identifier.mjs';
+import '../transactions/instances/moduleId.mjs';
+import '../transactions/typeTag/index.mjs';
+
+declare class TransactionSubmission {
+    readonly config: AptosConfig;
+    constructor(config: AptosConfig);
+    /**
+     * We are defining function signatures, each with its specific input and output.
+     * These are the possible function signature for `generateTransaction` function.
+     * When we call `generateTransaction` function with the relevant type properties,
+     * Typescript can infer the return type based on the appropriate function overload.
+     */
+    generateTransaction(args: InputGenerateSingleSignerRawTransactionData): Promise<InputSingleSignerTransaction>;
+    generateTransaction(args: InputGenerateFeePayerRawTransactionData): Promise<InputFeePayerTransaction>;
+    generateTransaction(args: InputGenerateMultiAgentRawTransactionData): Promise<InputMultiAgentTransaction>;
+    generateTransaction(args: InputGenerateTransactionData): Promise<AnyRawTransaction>;
+    /**
+     * Sign a transaction that can later be submitted to chain
+     *
+     * @param args.signer The signer account to sign the transaction
+     * @param args.transaction An instance of a RawTransaction, plus optional secondary/fee payer addresses
+     * @param args.asFeePayer optional. If the signer is also the fee payer
+     * ```
+     * {
+     *  rawTransaction: RawTransaction,
+     *  secondarySignerAddresses?: Array<AccountAddress>,
+     *  feePayerAddress?: AccountAddress
+     * }
+     * ```
+     *
+     * @return The signer AccountAuthenticator
+     */
+    signTransaction(args: {
+        signer: Account;
+        transaction: AnyRawTransaction;
+        asFeePayer?: boolean;
+    }): AccountAuthenticator;
+    /**
+     * Simulates a transaction before singing it.
+     *
+     * @param args.signerPublicKey The signer public key
+     * @param args.transaction The raw transaction to simulate
+     * @param args.secondarySignersPublicKeys optional. For when the transaction is a multi signers transaction
+     * @param args.feePayerPublicKey optional. For when the transaction is a fee payer (aka sponsored) transaction
+     * @param args.options optional. A config to simulate the transaction with
+     */
+    simulateTransaction(args: InputSimulateTransactionData): Promise<Array<UserTransactionResponse>>;
+    /**
+     * Submit transaction to chain
+     *
+     * @param args.transaction A aptos transaction type
+     * @param args.senderAuthenticator The account authenticator of the transaction sender
+     * @param args.secondarySignerAuthenticators optional. For when the transaction is a multi signers transaction
+     *
+     * @return PendingTransactionResponse
+     */
+    submitTransaction(args: InputSubmitTransactionData): Promise<PendingTransactionResponse>;
+    /**
+     * Sign and submit a single signer transaction to chain
+     *
+     * @param args.signer The signer account to sign the transaction
+     * @param args.transaction An instance of a RawTransaction, plus optional secondary/fee payer addresses
+     * ```
+     * {
+     *  rawTransaction: RawTransaction,
+     *  secondarySignerAddresses? : Array<AccountAddress>,
+     *  feePayerAddress?: AccountAddress
+     * }
+     * ```
+     *
+     * @return PendingTransactionResponse
+     */
+    signAndSubmitTransaction(args: {
+        signer: Account;
+        transaction: AnyRawTransaction;
+    }): Promise<PendingTransactionResponse>;
+    /**
+     * Generates a transaction to publish a move package to chain.
+     *
+     * To get the `metadataBytes` and `byteCode`, can compile using Aptos CLI with command
+     * `aptos move compile --save-metadata ...`,
+     * For more info {@link https://aptos.dev/tutorials/your-first-dapp/#step-4-publish-a-move-module}
+     *
+     * @param args.account The publisher account
+     * @param args.metadataBytes The package metadata bytes
+     * @param args.moduleBytecode An array of the bytecode of each module in the package in compiler output order
+     *
+     * @returns A SingleSignerTransaction that can be simulated or submitted to chain
+     */
+    publishPackageTransaction(args: {
+        account: AccountAddressInput;
+        metadataBytes: HexInput;
+        moduleBytecode: Array<HexInput>;
+        options?: InputGenerateTransactionOptions;
+    }): Promise<InputSingleSignerTransaction>;
+    /**
+     * Rotate an account's auth key. After rotation, only the new private key can be used to sign txns for
+     * the account.
+     * Note: Only legacy Ed25519 scheme is supported for now.
+     * More info: {@link https://aptos.dev/guides/account-management/key-rotation/}
+     * @param args.fromAccount The account to rotate the auth key for
+     * @param args.toNewPrivateKey The new private key to rotate to
+     *
+     * @returns PendingTransactionResponse
+     */
+    rotateAuthKey(args: {
+        fromAccount: Account;
+        toNewPrivateKey: PrivateKey;
+    }): Promise<TransactionResponse>;
+}
+
+export { TransactionSubmission };

package/dist/esm/api/transactionSubmission.mjs

@@ -0,0 +1,2 @@
+import{a}from"../chunk-EYXHVA6W.mjs";import"../chunk-Y5DJPHJT.mjs";import"../chunk-NTD3H2S4.mjs";import"../chunk-2W744GUN.mjs";import"../chunk-U6SZNNVL.mjs";import"../chunk-HTZTTZQJ.mjs";import"../chunk-UAAI3NCA.mjs";import"../chunk-JDS7K2WI.mjs";import"../chunk-JZNLZMUC.mjs";import"../chunk-UYVPNUH3.mjs";import"../chunk-S36IYY6K.mjs";import"../chunk-VWVEDCBM.mjs";import"../chunk-R3KWVOFG.mjs";import"../chunk-BV4OOU5Y.mjs";import"../chunk-EQ5BEDJ7.mjs";import"../chunk-Z2UDRTHA.mjs";import"../chunk-KQXRH5FK.mjs";import"../chunk-EWTHPMEE.mjs";import"../chunk-QWVR4RCV.mjs";import"../chunk-VYAVLUPJ.mjs";import"../chunk-3JPVQHOR.mjs";import"../chunk-TQD4IGUM.mjs";import"../chunk-AH44UPM4.mjs";import"../chunk-7MNEEVXY.mjs";import"../chunk-WX43AJTD.mjs";import"../chunk-E7FWVXGX.mjs";import"../chunk-TCTZCPQ6.mjs";import"../chunk-N2FKVZ4D.mjs";import"../chunk-3JVGSFHP.mjs";import"../chunk-GEFQFRL3.mjs";import"../chunk-KC64ESLO.mjs";import"../chunk-LV33NV4J.mjs";import"../chunk-EGOYLZBU.mjs";import"../chunk-FYIFBLHU.mjs";import"../chunk-6FBKUTGF.mjs";import"../chunk-UPLWWSB4.mjs";import"../chunk-U3LO2FSJ.mjs";import"../chunk-U25N2VWA.mjs";import"../chunk-44MGBJ73.mjs";import"../chunk-YYRDFZE6.mjs";import"../chunk-62SCW5NH.mjs";import"../chunk-RYETO74W.mjs";import"../chunk-EFIYW4WK.mjs";import"../chunk-LR65XHSF.mjs";import"../chunk-FZY4PMEE.mjs";import"../chunk-HVADSXTB.mjs";import"../chunk-BPYLPPEQ.mjs";import"../chunk-4ADA5BE7.mjs";import"../chunk-X32O46IB.mjs";import"../chunk-GTC7WHMV.mjs";import"../chunk-NZIJV4O2.mjs";import"../chunk-HA6JD5R6.mjs";import"../chunk-DNDWTM7A.mjs";import"../chunk-TIH6ARYP.mjs";import"../chunk-FBPNHF54.mjs";import"../chunk-Y7VR7X5W.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-ZWH2ESXT.mjs";export{a as TransactionSubmission};
+//# sourceMappingURL=transactionSubmission.mjs.map

package/dist/esm/api/transactionSubmission.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/esm/bcs/consts.d.mts

@@ -0,0 +1,14 @@
+import { Uint8, Uint16, Uint32, Uint64, Uint128, Uint256 } from '../types/index.mjs';
+import '../utils/apiEndpoints.mjs';
+import '../types/indexer.mjs';
+import '../types/generated/operations.mjs';
+import '../types/generated/types.mjs';
+
+declare const MAX_U8_NUMBER: Uint8;
+declare const MAX_U16_NUMBER: Uint16;
+declare const MAX_U32_NUMBER: Uint32;
+declare const MAX_U64_BIG_INT: Uint64;
+declare const MAX_U128_BIG_INT: Uint128;
+declare const MAX_U256_BIG_INT: Uint256;
+
+export { MAX_U128_BIG_INT, MAX_U16_NUMBER, MAX_U256_BIG_INT, MAX_U32_NUMBER, MAX_U64_BIG_INT, MAX_U8_NUMBER };

package/dist/esm/bcs/consts.mjs

@@ -0,0 +1,2 @@
+import{a,b,c,d,e,f}from"../chunk-DNDWTM7A.mjs";import"../chunk-ZWH2ESXT.mjs";export{e as MAX_U128_BIG_INT,b as MAX_U16_NUMBER,f as MAX_U256_BIG_INT,c as MAX_U32_NUMBER,d as MAX_U64_BIG_INT,a as MAX_U8_NUMBER};
+//# sourceMappingURL=consts.mjs.map

package/dist/esm/bcs/consts.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/esm/bcs/deserializer.d.mts

@@ -0,0 +1,150 @@
+import { Uint8, Uint16, Uint32, Uint64, Uint128, Uint256 } from '../types/index.mjs';
+import '../utils/apiEndpoints.mjs';
+import '../types/indexer.mjs';
+import '../types/generated/operations.mjs';
+import '../types/generated/types.mjs';
+
+/**
+ * This interface exists to define Deserializable<T> inputs for functions that
+ * deserialize a byte buffer into a type T.
+ * It is not intended to be implemented or extended, because Typescript has no support
+ * for static methods in interfaces.
+ */
+interface Deserializable<T> {
+    deserialize(deserializer: Deserializer): T;
+}
+declare class Deserializer {
+    private buffer;
+    private offset;
+    constructor(data: Uint8Array);
+    private read;
+    /**
+     * Deserializes a string. UTF8 string is supported. Reads the string's bytes length "l" first,
+     * and then reads "l" bytes of content. Decodes the byte array into a string.
+     *
+     * BCS layout for "string": string_length | string_content
+     * where string_length is a u32 integer encoded as a uleb128 integer, equal to the number of bytes in string_content.
+     *
+     * @example
+     * ```ts
+     * const deserializer = new Deserializer(new Uint8Array([8, 49, 50, 51, 52, 97, 98, 99, 100]));
+     * assert(deserializer.deserializeStr() === "1234abcd");
+     * ```
+     */
+    deserializeStr(): string;
+    /**
+     * Deserializes an array of bytes.
+     *
+     * BCS layout for "bytes": bytes_length | bytes
+     * where bytes_length is a u32 integer encoded as a uleb128 integer, equal to the length of the bytes array.
+     */
+    deserializeBytes(): Uint8Array;
+    /**
+     * Deserializes an array of bytes. The number of bytes to read is already known.
+     *
+     */
+    deserializeFixedBytes(len: number): Uint8Array;
+    /**
+     * Deserializes a boolean value.
+     *
+     * BCS layout for "boolean": One byte. "0x01" for true and "0x00" for false.
+     */
+    deserializeBool(): boolean;
+    /**
+     * Deserializes a uint8 number.
+     *
+     * BCS layout for "uint8": One byte. Binary format in little-endian representation.
+     */
+    deserializeU8(): Uint8;
+    /**
+     * Deserializes a uint16 number.
+     *
+     * BCS layout for "uint16": Two bytes. Binary format in little-endian representation.
+     * @example
+     * ```ts
+     * const deserializer = new Deserializer(new Uint8Array([0x34, 0x12]));
+     * assert(deserializer.deserializeU16() === 4660);
+     * ```
+     */
+    deserializeU16(): Uint16;
+    /**
+     * Deserializes a uint32 number.
+     *
+     * BCS layout for "uint32": Four bytes. Binary format in little-endian representation.
+     * @example
+     * ```ts
+     * const deserializer = new Deserializer(new Uint8Array([0x78, 0x56, 0x34, 0x12]));
+     * assert(deserializer.deserializeU32() === 305419896);
+     * ```
+     */
+    deserializeU32(): Uint32;
+    /**
+     * Deserializes a uint64 number.
+     *
+     * BCS layout for "uint64": Eight bytes. Binary format in little-endian representation.
+     * @example
+     * ```ts
+     * const deserializer = new Deserializer(new Uint8Array([0x00, 0xEF, 0xCD, 0xAB, 0x78, 0x56, 0x34, 0x12]));
+     * assert(deserializer.deserializeU64() === 1311768467750121216);
+     * ```
+     */
+    deserializeU64(): Uint64;
+    /**
+     * Deserializes a uint128 number.
+     *
+     * BCS layout for "uint128": Sixteen bytes. Binary format in little-endian representation.
+     */
+    deserializeU128(): Uint128;
+    /**
+     * Deserializes a uint256 number.
+     *
+     * BCS layout for "uint256": Thirty-two bytes. Binary format in little-endian representation.
+     */
+    deserializeU256(): Uint256;
+    /**
+     * Deserializes a uleb128 encoded uint32 number.
+     *
+     * BCS use uleb128 encoding in two cases: (1) lengths of variable-length sequences and (2) tags of enum values
+     */
+    deserializeUleb128AsU32(): Uint32;
+    /**
+     * Helper function that primarily exists to support alternative syntax for deserialization.
+     * That is, if we have a `const deserializer: new Deserializer(...)`, instead of having to use
+     * `MyClass.deserialize(deserializer)`, we can call `deserializer.deserialize(MyClass)`.
+     *
+     * @example const deserializer = new Deserializer(new Uint8Array([1, 2, 3]));
+     * const value = deserializer.deserialize(MyClass); // where MyClass has a `deserialize` function
+     * // value is now an instance of MyClass
+     * // equivalent to `const value = MyClass.deserialize(deserializer)`
+     * @param cls The BCS-deserializable class to deserialize the buffered bytes into.
+     *
+     * @returns the deserialized value of class type T
+     */
+    deserialize<T>(cls: Deserializable<T>): T;
+    /**
+     * Deserializes an array of BCS Deserializable values given an existing Deserializer
+     * instance with a loaded byte buffer.
+     *
+     * @param cls The BCS-deserializable class to deserialize the buffered bytes into.
+     * @example
+     * // serialize a vector of addresses
+     * const addresses = new Array<AccountAddress>(
+     *   AccountAddress.fromRelaxed("0x1"),
+     *   AccountAddress.fromRelaxed("0x2"),
+     *   AccountAddress.fromRelaxed("0xa"),
+     *   AccountAddress.fromRelaxed("0xb"),
+     * );
+     * const serializer = new Serializer();
+     * serializer.serializeVector(addresses);
+     * const serializedBytes = serializer.toUint8Array();
+     *
+     * // deserialize the bytes into an array of addresses
+     * const deserializer = new Deserializer(serializedBytes);
+     * const deserializedAddresses = deserializer.deserializeVector(AccountAddress);
+     * // deserializedAddresses is now an array of AccountAddress instances
+     * @returns an array of deserialized values of type T
+     */
+    deserializeVector<T>(cls: Deserializable<T>): Array<T>;
+}
+
+export { Deserializable, Deserializer };

package/dist/esm/bcs/deserializer.mjs

@@ -0,0 +1,2 @@
+import{a}from"../chunk-GTC7WHMV.mjs";import"../chunk-DNDWTM7A.mjs";import"../chunk-ZWH2ESXT.mjs";export{a as Deserializer};
+//# sourceMappingURL=deserializer.mjs.map

package/dist/esm/bcs/deserializer.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/esm/bcs/index.d.mts

@@ -0,0 +1,14 @@
+export { Deserializable, Deserializer } from './deserializer.mjs';
+export { Serializable, Serializer, ensureBoolean, outOfRangeErrorMessage, validateNumberInRange } from './serializer.mjs';
+export { EntryFunctionBytes } from './serializable/entryFunctionBytes.mjs';
+export { FixedBytes } from './serializable/fixedBytes.mjs';
+export { Bool, U128, U16, U256, U32, U64, U8 } from './serializable/movePrimitives.mjs';
+export { MoveOption, MoveString, MoveVector } from './serializable/moveStructs.mjs';
+import '../types/index.mjs';
+import '../utils/apiEndpoints.mjs';
+import '../types/indexer.mjs';
+import '../types/generated/operations.mjs';
+import '../types/generated/types.mjs';
+import '../core/hex.mjs';
+import '../core/common.mjs';
+import '../transactions/instances/transactionArgument.mjs';

package/dist/esm/bcs/index.mjs

@@ -0,0 +1,2 @@
+import"../chunk-FZY4PMEE.mjs";import{a as h}from"../chunk-HVADSXTB.mjs";import{a as g}from"../chunk-BPYLPPEQ.mjs";import{a as p,b as q,c as r}from"../chunk-4ADA5BE7.mjs";import{a as i,b as j,c as k,d as l,e as m,f as n,g as o}from"../chunk-X32O46IB.mjs";import{a as f}from"../chunk-GTC7WHMV.mjs";import{a,b,c,d,e}from"../chunk-HA6JD5R6.mjs";import"../chunk-DNDWTM7A.mjs";import"../chunk-TIH6ARYP.mjs";import"../chunk-FBPNHF54.mjs";import"../chunk-Y7VR7X5W.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-ZWH2ESXT.mjs";export{i as Bool,f as Deserializer,h as EntryFunctionBytes,g as FixedBytes,r as MoveOption,q as MoveString,p as MoveVector,a as Serializable,b as Serializer,n as U128,k as U16,o as U256,l as U32,m as U64,j as U8,c as ensureBoolean,d as outOfRangeErrorMessage,e as validateNumberInRange};
+//# sourceMappingURL=index.mjs.map

package/dist/esm/bcs/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/esm/bcs/serializable/entryFunctionBytes.d.mts

@@ -0,0 +1,40 @@
+import { Serializable, Serializer } from '../serializer.mjs';
+import { Deserializer } from '../deserializer.mjs';
+import { FixedBytes } from './fixedBytes.mjs';
+import { EntryFunctionArgument } from '../../transactions/instances/transactionArgument.mjs';
+import '../../core/hex.mjs';
+import '../../core/common.mjs';
+import '../../types/index.mjs';
+import '../../utils/apiEndpoints.mjs';
+import '../../types/indexer.mjs';
+import '../../types/generated/operations.mjs';
+import '../../types/generated/types.mjs';
+
+/**
+ * This class exists solely to represent a sequence of fixed bytes as a serialized entry function, because
+ * serializing an entry function appends a prefix that's *only* used for entry function arguments.
+ *
+ * NOTE: Attempting to use this class for a serialized script function will result in erroneous
+ * and unexpected behavior.
+ *
+ * If you wish to convert this class back to a TransactionArgument, you must know the type
+ * of the argument beforehand, and use the appropriate class to deserialize the bytes within
+ * an instance of this class.
+ */
+declare class EntryFunctionBytes extends Serializable implements EntryFunctionArgument {
+    readonly value: FixedBytes;
+    private constructor();
+    serialize(serializer: Serializer): void;
+    serializeForEntryFunction(serializer: Serializer): void;
+    /**
+     * The only way to create an instance of this class is to use this static method.
+     *
+     * This function should only be used when deserializing a sequence of EntryFunctionPayload arguments.
+     * @param deserializer the deserializer instance with the buffered bytes
+     * @param length the length of the bytes to deserialize
+     * @returns an instance of this class, which will now only be usable as an EntryFunctionArgument
+     */
+    static deserialize(deserializer: Deserializer, length: number): EntryFunctionBytes;
+}
+
+export { EntryFunctionBytes };

package/dist/esm/bcs/serializable/entryFunctionBytes.mjs

@@ -0,0 +1,2 @@
+import{a}from"../../chunk-HVADSXTB.mjs";import"../../chunk-BPYLPPEQ.mjs";import"../../chunk-HA6JD5R6.mjs";import"../../chunk-DNDWTM7A.mjs";import"../../chunk-TIH6ARYP.mjs";import"../../chunk-FBPNHF54.mjs";import"../../chunk-ZWH2ESXT.mjs";export{a as EntryFunctionBytes};
+//# sourceMappingURL=entryFunctionBytes.mjs.map

package/dist/esm/bcs/serializable/entryFunctionBytes.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/esm/bcs/serializable/fixedBytes.d.mts

@@ -0,0 +1,52 @@
+import { Serializable, Serializer } from '../serializer.mjs';
+import { Deserializer } from '../deserializer.mjs';
+import { HexInput } from '../../types/index.mjs';
+import { TransactionArgument } from '../../transactions/instances/transactionArgument.mjs';
+import '../../core/hex.mjs';
+import '../../core/common.mjs';
+import '../../utils/apiEndpoints.mjs';
+import '../../types/indexer.mjs';
+import '../../types/generated/operations.mjs';
+import '../../types/generated/types.mjs';
+
+/**
+ *  This class exists to represent a contiguous sequence of already serialized BCS-bytes.
+ *
+ *  It differs from most other Serializable classes in that its internal byte buffer is serialized to BCS
+ *  bytes exactly as-is, without prepending the length of the bytes.
+ *
+ *  If you want to write your own serialization function and pass the bytes as a transaction argument,
+ *  you should use this class.
+ *
+ *  This class is also more generally used to represent type-agnostic BCS bytes as a vector<u8>.
+ *
+ *  An example of this is the bytes resulting from entry function arguments that have been serialized
+ *  for an entry function.
+ *
+ *  @example
+ *  const yourCustomSerializedBytes = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]);
+ *  const fixedBytes = new FixedBytes(yourCustomSerializedBytes);
+ *  const payload = await generateTransactionPayload({
+ *    function: "0xbeefcafe::your_module::your_function_that_requires_custom_serialization",
+ *    functionArguments: [yourCustomBytes],
+ *  });
+ *
+ *  For example, if you store each of the 32 bytes for an address as a U8 in a MoveVector<U8>, when you
+ *  serialize that MoveVector<U8>, it will be serialized to 33 bytes. If you solely want to pass around
+ *  the 32 bytes as a Serializable class that *does not* prepend the length to the BCS-serialized representation,
+ *  use this class.
+ *
+ * @params value: HexInput representing a sequence of Uint8 bytes
+ * @returns a Serializable FixedBytes instance, which when serialized, does not prepend the length of the bytes
+ * @see EntryFunctionBytes
+ */
+declare class FixedBytes extends Serializable implements TransactionArgument {
+    value: Uint8Array;
+    constructor(value: HexInput);
+    serialize(serializer: Serializer): void;
+    serializeForEntryFunction(serializer: Serializer): void;
+    serializeForScriptFunction(serializer: Serializer): void;
+    static deserialize(deserializer: Deserializer, length: number): FixedBytes;
+}
+
+export { FixedBytes };

package/dist/esm/bcs/serializable/fixedBytes.mjs

@@ -0,0 +1,2 @@
+import{a}from"../../chunk-BPYLPPEQ.mjs";import"../../chunk-HA6JD5R6.mjs";import"../../chunk-DNDWTM7A.mjs";import"../../chunk-TIH6ARYP.mjs";import"../../chunk-FBPNHF54.mjs";import"../../chunk-ZWH2ESXT.mjs";export{a as FixedBytes};
+//# sourceMappingURL=fixedBytes.mjs.map

package/dist/esm/bcs/serializable/fixedBytes.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}