@aptos-labs/ts-sdk 1.34.0 → 1.35.0-zeta.1

package/README.md

@@ -1,4 +1,4 @@
-# Typescript SDK for Aptos
+# TypeScript SDK for Aptos
 
 ![License][github-license]
 [![Discord][discord-image]][discord-url]
@@ -7,7 +7,7 @@
 ![NPM bundle size](https://img.shields.io/bundlephobia/min/%40aptos-labs/ts-sdk)
 [![NPM Package Downloads][npm-image-downloads]][npm-url]
 
-The [TypeScript SDK](https://www.npmjs.com/package/@aptos-labs/ts-sdk) allows you to connect, explore, and interact on the Aptos blockchain. You can use it to request data, send transactions, set up test environments, and more!
+The [TypeScript SDK](https://www.npmjs.com/package/@aptos-labs/ts-sdk) allows you to connect, explore, and interact with the Aptos blockchain. You can use it to request data, send transactions, set up test environments, and more!
 
 ## Learn How To Use The TypeScript SDK
 ### [Quickstart](https://aptos.dev/en/build/sdks/ts-sdk/quickstart)
@@ -15,7 +15,6 @@ The [TypeScript SDK](https://www.npmjs.com/package/@aptos-labs/ts-sdk) allows yo
 ### [Examples](./examples/README.md)
 ### [Reference Docs (For looking up specific functions)](https://aptos-labs.github.io/aptos-ts-sdk/)
 
-
 ## Installation
 
 ### For use in Node.js or a web application
@@ -26,12 +25,12 @@ Install with your favorite package manager such as npm, yarn, or pnpm:
 pnpm install @aptos-labs/ts-sdk
 ```
 
-### For use in a browser (<= 1.9.1 version only)
+### For use in a browser (<= version 1.9.1 only)
 
 You can add the SDK to your web application using a script tag:
 
 ```html
-<script src="https://unpkg.com/@aptos-labs/ts-sdk/dist/browser/index.global.js" />
+<script src="https://unpkg.com/@aptos-labs/ts-sdk/dist/browser/index.global.js"></script>
 ```
 
 Then, the SDK can be accessed through `window.aptosSDK`.
@@ -207,18 +206,18 @@ example();
 
 ## Troubleshooting
 
-If you see import error when you do this
+If you see an import error when you do this:
 
 ```typescript
 import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
 ```
 
-It could be your `tsconfig.json` is not using `node`. Make sure your `moduleResolution` in the `tsconfig.json` is set to `node` instead of `bundler`.
+It could be that your `tsconfig.json` is not using `node`. Make sure your `moduleResolution` in the `tsconfig.json` is set to `node` instead of `bundler`.
 
 ## Contributing
 
 If you found a bug or would like to request a feature, please file an [issue](https://github.com/aptos-labs/aptos-ts-sdk/issues/new/choose).
-If, based on the discussion on an issue you would like to offer a code change, please make a [pull request](https://github.com/aptos-labs/aptos-ts-sdk/pulls).
+If, based on the discussion on an issue, you would like to offer a code change, please make a [pull request](https://github.com/aptos-labs/aptos-ts-sdk/pulls).
 If neither of these describes what you would like to contribute, check out the [contributing guide](https://github.com/aptos-labs/aptos-ts-sdk/blob/main/CONTRIBUTING.md).
 
 ## Running unit tests
@@ -234,4 +233,4 @@ pnpm jest keyless.test.ts
 [experimental-url]: https://www.npmjs.com/package/@aptos-labs/ts-sdk/v/experimental
 [discord-image]: https://img.shields.io/discord/945856774056083548?label=Discord&logo=discord&style=flat
 [discord-url]: https://discord.gg/aptosnetwork
-[github-license]: https://img.shields.io/github/license/aptos-labs/aptos-ts-sdk
+[github-license]: https://img.shields.io/github/license/aptos-labs/aptos-ts-sdk

package/dist/common/{accountAddress-CDtCLtJA.d.ts → accountAddress-Ce4Cv60D.d.ts}

@@ -1,14 +1,14 @@
 type GetAccountCoinsDataQuery = {
     current_fungible_asset_balances: Array<{
-        amount?: any | null;
-        asset_type?: string | null;
+        amount: any;
+        asset_type: string;
         is_frozen: boolean;
-        is_primary?: boolean | null;
+        is_primary: boolean;
         last_transaction_timestamp?: any | null;
         last_transaction_version?: any | null;
         owner_address: string;
         storage_id: string;
-        token_standard?: string | null;
+        token_standard: string;
         metadata?: {
             token_standard: string;
             symbol: string;
@@ -185,15 +185,15 @@ type GetCollectionDataQuery = {
 };
 type GetCurrentFungibleAssetBalancesQuery = {
     current_fungible_asset_balances: Array<{
-        amount?: any | null;
-        asset_type?: string | null;
+        amount: any;
+        asset_type: string;
         is_frozen: boolean;
-        is_primary?: boolean | null;
+        is_primary: boolean;
         last_transaction_timestamp?: any | null;
         last_transaction_version?: any | null;
         owner_address: string;
         storage_id: string;
-        token_standard?: string | null;
+        token_standard: string;
     }>;
 };
 type GetDelegatedStakingActivitiesQuery = {
@@ -257,6 +257,15 @@ type GetFungibleAssetMetadataQuery = {
         maximum_v2?: any | null;
     }>;
 };
+type GetMultiKeyForAuthKeyQuery = {
+    auth_key_multikey_layout: Array<{
+        auth_key: string;
+        last_transaction_version: any;
+        multikey_layout_with_prefixes: any;
+        multikey_type: string;
+        signatures_required: any;
+    }>;
+};
 type GetNamesQuery = {
     current_aptos_names: Array<{
         domain?: string | null;
@@ -294,6 +303,18 @@ type GetProcessorStatusQuery = {
         last_updated: any;
     }>;
 };
+type GetSignaturesQuery = {
+    signatures: Array<{
+        signature: string;
+        public_key: string;
+        public_key_indices: any;
+        type: string;
+        signer: string;
+        transaction_version: any;
+        threshold: any;
+        is_sender_primary: boolean;
+    }>;
+};
 type GetTableItemsDataQuery = {
     table_items: Array<{
         decoded_key: any;
@@ -552,6 +573,18 @@ type GetTableItemsDataResponse = GetTableItemsDataQuery["table_items"];
  * @category Types
  */
 type GetTableItemsMetadataResponse = GetTableItemsMetadataQuery["table_metadatas"];
+/**
+ * The response containing the multikey for an authentication key.
+ * @group Implementation
+ * @category Types
+ */
+type GetMultiKeyForAuthKeyResponse = GetMultiKeyForAuthKeyQuery["auth_key_multikey_layout"][0];
+/**
+ * The response containing the account transactions for an account.
+ * @group Implementation
+ * @category Types
+ */
+type GetSignaturesResponse = GetSignaturesQuery["signatures"][0];
 /**
  * The response containing the current Aptos names from the GetNamesQuery.
  * @group Implementation
@@ -892,6 +925,7 @@ interface ClientRequest<Req> {
     originMethod?: string;
     body?: Req;
     contentType?: string;
+    acceptType?: string;
     params?: any;
     overrides?: ClientConfig & FullNodeConfig & IndexerConfig & FaucetConfig;
     headers?: Record<string, any>;
@@ -921,6 +955,22 @@ interface Client {
      * @param requestOptions.overrides - Optional configuration overrides for the request.
      */
     provider<Req, Res>(requestOptions: ClientRequest<Req>): Promise<ClientResponse<Res>>;
+    /**
+     * Sends a request to the specified URL with the given options, that returns a binary response
+     *
+     * @experimental
+     * @param requestOptions - The options for the request.
+     * @param requestOptions.url - The URL to send the request to.
+     * @param requestOptions.method - The HTTP method to use, either "GET" or "POST".
+     * @param requestOptions.path - An optional path to append to the URL.
+     * @param requestOptions.body - The body of the request, applicable for POST requests.
+     * @param requestOptions.contentType - The content type of the request body.
+     * @param requestOptions.acceptType - The expected content type of the response.
+     * @param requestOptions.params - Optional parameters to include in the request.
+     * @param requestOptions.originMethod - An optional method to specify the origin of the request.
+     * @param requestOptions.overrides - Optional configuration overrides for the request.
+     */
+    binaryProvider?: <Req>(requestOptions: ClientRequest<Req>) => Promise<ClientResponse<Buffer>>;
 }
 /**
  * The API request type
@@ -931,6 +981,8 @@ interface Client {
  * @param body (optional) - the body of the request
  * @param contentType (optional) - the content type to set the `content-type` header to,
  * by default is set to `application/json`
+ * @param acceptType (optional) - the content type to set the `accept-type` header to,
+ * by default is set to `application/json`
  * @param params (optional) - query params to add to the request
  * @param originMethod (optional) - the local method the request came from
  * @param overrides (optional) - a `ClientConfig` object type to override request data
@@ -1457,7 +1509,7 @@ type MoveScriptBytecode = {
 /**
  * JSON representations of transaction signatures returned from the node API.
  */
-type TransactionSignature = TransactionEd25519Signature | TransactionSecp256k1Signature | TransactionMultiEd25519Signature | TransactionMultiAgentSignature | TransactionFeePayerSignature;
+type TransactionSignature = TransactionEd25519Signature | TransactionSecp256k1Signature | TransactionMultiEd25519Signature | TransactionMultiAgentSignature | TransactionFeePayerSignature | TransactionSingleSenderSignature;
 /**
  * Determine if the provided signature is an Ed25519 signature.
  * This function checks for the presence of the "signature" property
@@ -1466,7 +1518,7 @@ type TransactionSignature = TransactionEd25519Signature | TransactionSecp256k1Si
  * @param signature - The transaction signature to be checked.
  * @returns A boolean indicating whether the signature is an Ed25519 signature.
  */
-declare function isEd25519Signature(signature: TransactionSignature): signature is TransactionFeePayerSignature;
+declare function isEd25519Signature(signature: TransactionSignature): signature is TransactionEd25519Signature;
 /**
  * Determine if the provided signature is a valid secp256k1 ECDSA signature.
  *
@@ -1495,6 +1547,27 @@ declare function isFeePayerSignature(signature: TransactionSignature): signature
  * @returns A boolean indicating whether the signature is a multi-ed25519 signature.
  */
 declare function isMultiEd25519Signature(signature: TransactionSignature): signature is TransactionMultiEd25519Signature;
+/**
+ * Determine if the provided signature is of type "single_sender".
+ *
+ * @param signature - The transaction signature to check.
+ * @returns A boolean indicating whether the signature is a single-sender signature.
+ */
+declare function isSingleSenderSignature(signature: TransactionSignature): signature is TransactionSingleSenderSignature;
+/**
+ * Determine if the provided signature is of type "single_sender".
+ *
+ * @param signature - The transaction signature to check.
+ * @returns A boolean indicating whether the signature is a single-sender signature.
+ */
+declare function isSingleSenderSingleKeySignature(signature: TransactionSignature): signature is TransactionSingleSenderSingleKeySignature;
+/**
+ * Determine if the provided signature is of type "single_sender".
+ *
+ * @param signature - The transaction signature to check.
+ * @returns A boolean indicating whether the signature is a single-sender signature.
+ */
+declare function isSingleSenderMultiKeySignature(signature: TransactionSignature): signature is TransactionSingleSenderMultiKeySignature;
 /**
  * The signature for a transaction using the Ed25519 algorithm.
  */
@@ -1511,6 +1584,40 @@ type TransactionSecp256k1Signature = {
     public_key: string;
     signature: "secp256k1_ecdsa_signature";
 };
+/**
+ * The structure for a multi-signature transaction using Ed25519.
+ */
+type TransactionSingleSenderSignature = TransactionSingleSenderSingleKeySignature | TransactionSingleSenderMultiKeySignature;
+type TransactionSingleSenderSingleKeySignature = {
+    type: "single_sender";
+    public_key: {
+        value: string;
+        type: string;
+    };
+    signature: {
+        value: string;
+        type: string;
+    };
+    signatures_required: never;
+};
+/**
+ * The structure for a multi-signature transaction using Ed25519.
+ */
+type TransactionSingleSenderMultiKeySignature = {
+    type: "single_sender";
+    public_keys: {
+        value: string;
+        type: string;
+    }[];
+    signatures: {
+        index: number;
+        signature: {
+            value: string;
+            type: string;
+        };
+    }[];
+    signatures_required: number;
+};
 /**
  * The structure for a multi-signature transaction using Ed25519.
  */
@@ -3110,4 +3217,4 @@ declare class AccountAddress extends Serializable implements TransactionArgument
     equals(other: AccountAddress): boolean;
 }
 
-export { type GetOwnedTokensResponse as $, type AnyNumber as A, type MoveResource as B, type Client as C, Deserializer as D, type EntryFunctionArgument as E, type FullNodeConfig as F, type TokenStandardArg as G, type HexInput as H, type IndexerConfig as I, type GetAccountOwnedTokensQueryResponse as J, type GetAccountOwnedTokensFromCollectionResponse as K, type LedgerVersionArg as L, type MoveModuleId as M, Network as N, type OrderByArg as O, PrivateKeyVariants as P, type GetAccountCollectionsWithOwnedTokenResponse as Q, type GetAccountCoinsDataResponse as R, Serializable as S, type TransactionArgument as T, type Uint8 as U, type GetObjectDataQueryResponse as V, type WhereArg as W, type GetCollectionDataResponse as X, type GetTokenDataResponse as Y, ZkpVariant as Z, type GetCurrentTokenOwnershipResponse as _, Serializer as a, type WriteSetChange as a$, type GetTokenActivityResponse as a0, type GetEventsResponse as a1, type WaitForTransactionOptions as a2, type UserTransactionResponse as a3, type GetFungibleAssetMetadataResponse as a4, type GetFungibleAssetActivitiesResponse as a5, type GetCurrentFungibleAssetBalancesResponse as a6, type LedgerInfo as a7, type Block as a8, type GetChainTopUserTransactionsResponse as a9, type TokenStandard as aA, TypeTagVariants as aB, ScriptTransactionArgumentVariants as aC, TransactionPayloadVariants as aD, TransactionVariants as aE, TransactionAuthenticatorVariant as aF, AccountAuthenticatorVariant as aG, AnySignatureVariant as aH, EphemeralSignatureVariant as aI, type Uint64 as aJ, type Uint128 as aK, type Uint256 as aL, type ClientHeadersType as aM, TransactionResponseType as aN, isPendingTransactionResponse as aO, isUserTransactionResponse as aP, isGenesisTransactionResponse as aQ, isBlockMetadataTransactionResponse as aR, isStateCheckpointTransactionResponse as aS, isValidatorTransactionResponse as aT, isBlockEpilogueTransactionResponse as aU, type GenesisTransactionResponse as aV, type BlockMetadataTransactionResponse as aW, type StateCheckpointTransactionResponse as aX, type ValidatorTransactionResponse as aY, type BlockEndInfo as aZ, type BlockEpilogueTransactionResponse as a_, type GraphqlQuery as aa, type GetProcessorStatusResponse as ab, type GetANSNameResponse as ac, type GetNumberOfDelegatorsResponse as ad, type GetDelegatedStakingActivitiesResponse as ae, type PendingTransactionResponse as af, type CommittedTransactionResponse as ag, type GasEstimation as ah, type TableItemRequest as ai, type GetTableItemsDataResponse as aj, type GetTableItemsMetadataResponse as ak, type ClientRequest as al, type ClientResponse as am, type AptosRequest as an, type AptosResponse as ao, MimeType as ap, ensureBoolean as aq, outOfRangeErrorMessage as ar, validateNumberInRange as as, AddressInvalidReason as at, ParsingError as au, type ParsingResult as av, HexInvalidReason as aw, hexToAsciiString as ax, type OrderBy as ay, type OrderByValue as az, type Uint16 as b, type WriteSetChangeDeleteModule as b0, type WriteSetChangeDeleteResource as b1, type WriteSetChangeDeleteTableItem as b2, type WriteSetChangeWriteModule as b3, type WriteSetChangeWriteResource as b4, type WriteSetChangeWriteTableItem as b5, type DecodedTableData as b6, type DeletedTableData as b7, type TransactionPayloadResponse as b8, type EntryFunctionPayloadResponse as b9, type MoveUint256Type as bA, type MoveAddressType as bB, type MoveObjectType as bC, type MoveOptionType as bD, type MoveStructType as bE, type MoveType as bF, MoveFunctionVisibility as bG, MoveAbility as bH, type MoveStructField as bI, type MoveModule as bJ, type MoveStruct as bK, RoleType as bL, DeriveScheme as bM, type GenerateAccountWithEd25519 as bN, type GenerateAccountWithSingleSignerSecp256k1Key as bO, type GenerateAccount as bP, NetworkToIndexerAPI as bQ, NetworkToNodeAPI as bR, NetworkToFaucetAPI as bS, NetworkToPepperAPI as bT, NetworkToProverAPI as bU, NetworkToChainId as bV, NetworkToNetworkName as bW, type ScriptPayloadResponse as ba, type MultisigPayloadResponse as bb, type GenesisPayload as bc, type MoveScriptBytecode as bd, type TransactionSignature as be, isEd25519Signature as bf, isSecp256k1Signature as bg, isMultiAgentSignature as bh, isFeePayerSignature as bi, isMultiEd25519Signature as bj, type TransactionEd25519Signature as bk, type TransactionSecp256k1Signature as bl, type TransactionMultiEd25519Signature as bm, type TransactionMultiAgentSignature as bn, type TransactionFeePayerSignature as bo, type AccountSignature as bp, type WriteSet as bq, type ScriptWriteSet as br, type DirectWriteSet as bs, type EventGuid as bt, type Event as bu, type MoveUint8Type as bv, type MoveUint16Type as bw, type MoveUint32Type as bx, type MoveUint64Type as by, type MoveUint128Type as bz, type Uint32 as c, type Deserializable as d, Hex as e, type AuthenticationKeyScheme as f, AccountAddress as g, AnyPublicKeyVariant as h, EphemeralPublicKeyVariant as i, type ClientConfig as j, type FaucetConfig as k, type AptosSettings as l, EphemeralCertificateVariant as m, type AccountAddressInput as n, type ScriptFunctionArgument as o, type MoveFunctionId as p, type MoveStructId as q, type MoveValue as r, type MoveFunctionGenericTypeParam as s, SigningSchemeInput as t, SigningScheme as u, type MoveFunction as v, type AccountData as w, type PaginationArgs as x, type MoveModuleBytecode as y, type TransactionResponse as z };
+export { type GetOwnedTokensResponse as $, type AnyNumber as A, type MoveResource as B, type Client as C, Deserializer as D, type EntryFunctionArgument as E, type FullNodeConfig as F, type TokenStandardArg as G, type HexInput as H, type IndexerConfig as I, type GetAccountOwnedTokensQueryResponse as J, type GetAccountOwnedTokensFromCollectionResponse as K, type LedgerVersionArg as L, type MoveModuleId as M, Network as N, type OrderByArg as O, PrivateKeyVariants as P, type GetAccountCollectionsWithOwnedTokenResponse as Q, type GetAccountCoinsDataResponse as R, Serializable as S, type TransactionArgument as T, type Uint8 as U, type GetObjectDataQueryResponse as V, type WhereArg as W, type GetCollectionDataResponse as X, type GetTokenDataResponse as Y, ZkpVariant as Z, type GetCurrentTokenOwnershipResponse as _, Serializer as a, type BlockEndInfo as a$, type GetTokenActivityResponse as a0, type GetEventsResponse as a1, type WaitForTransactionOptions as a2, type UserTransactionResponse as a3, type GetFungibleAssetMetadataResponse as a4, type GetFungibleAssetActivitiesResponse as a5, type GetCurrentFungibleAssetBalancesResponse as a6, type LedgerInfo as a7, type Block as a8, type GetChainTopUserTransactionsResponse as a9, type OrderBy as aA, type OrderByValue as aB, type TokenStandard as aC, TypeTagVariants as aD, ScriptTransactionArgumentVariants as aE, TransactionPayloadVariants as aF, TransactionVariants as aG, TransactionAuthenticatorVariant as aH, AccountAuthenticatorVariant as aI, AnySignatureVariant as aJ, EphemeralSignatureVariant as aK, type Uint64 as aL, type Uint128 as aM, type Uint256 as aN, type ClientHeadersType as aO, TransactionResponseType as aP, isPendingTransactionResponse as aQ, isUserTransactionResponse as aR, isGenesisTransactionResponse as aS, isBlockMetadataTransactionResponse as aT, isStateCheckpointTransactionResponse as aU, isValidatorTransactionResponse as aV, isBlockEpilogueTransactionResponse as aW, type GenesisTransactionResponse as aX, type BlockMetadataTransactionResponse as aY, type StateCheckpointTransactionResponse as aZ, type ValidatorTransactionResponse as a_, type GraphqlQuery as aa, type GetProcessorStatusResponse as ab, type GetANSNameResponse as ac, type GetNumberOfDelegatorsResponse as ad, type GetDelegatedStakingActivitiesResponse as ae, type PendingTransactionResponse as af, type CommittedTransactionResponse as ag, type GasEstimation as ah, type TableItemRequest as ai, type GetTableItemsDataResponse as aj, type GetTableItemsMetadataResponse as ak, type ClientRequest as al, type ClientResponse as am, type AptosRequest as an, type AptosResponse as ao, MimeType as ap, ensureBoolean as aq, outOfRangeErrorMessage as ar, validateNumberInRange as as, AddressInvalidReason as at, ParsingError as au, type ParsingResult as av, HexInvalidReason as aw, hexToAsciiString as ax, type GetMultiKeyForAuthKeyResponse as ay, type GetSignaturesResponse as az, type Uint16 as b, NetworkToPepperAPI as b$, type BlockEpilogueTransactionResponse as b0, type WriteSetChange as b1, type WriteSetChangeDeleteModule as b2, type WriteSetChangeDeleteResource as b3, type WriteSetChangeDeleteTableItem as b4, type WriteSetChangeWriteModule as b5, type WriteSetChangeWriteResource as b6, type WriteSetChangeWriteTableItem as b7, type DecodedTableData as b8, type DeletedTableData as b9, type DirectWriteSet as bA, type EventGuid as bB, type Event as bC, type MoveUint8Type as bD, type MoveUint16Type as bE, type MoveUint32Type as bF, type MoveUint64Type as bG, type MoveUint128Type as bH, type MoveUint256Type as bI, type MoveAddressType as bJ, type MoveObjectType as bK, type MoveOptionType as bL, type MoveStructType as bM, type MoveType as bN, MoveFunctionVisibility as bO, MoveAbility as bP, type MoveStructField as bQ, type MoveModule as bR, type MoveStruct as bS, RoleType as bT, DeriveScheme as bU, type GenerateAccountWithEd25519 as bV, type GenerateAccountWithSingleSignerSecp256k1Key as bW, type GenerateAccount as bX, NetworkToIndexerAPI as bY, NetworkToNodeAPI as bZ, NetworkToFaucetAPI as b_, type TransactionPayloadResponse as ba, type EntryFunctionPayloadResponse as bb, type ScriptPayloadResponse as bc, type MultisigPayloadResponse as bd, type GenesisPayload as be, type MoveScriptBytecode as bf, type TransactionSignature as bg, isEd25519Signature as bh, isSecp256k1Signature as bi, isMultiAgentSignature as bj, isFeePayerSignature as bk, isMultiEd25519Signature as bl, isSingleSenderSignature as bm, isSingleSenderSingleKeySignature as bn, isSingleSenderMultiKeySignature as bo, type TransactionEd25519Signature as bp, type TransactionSecp256k1Signature as bq, type TransactionSingleSenderSignature as br, type TransactionSingleSenderSingleKeySignature as bs, type TransactionSingleSenderMultiKeySignature as bt, type TransactionMultiEd25519Signature as bu, type TransactionMultiAgentSignature as bv, type TransactionFeePayerSignature as bw, type AccountSignature as bx, type WriteSet as by, type ScriptWriteSet as bz, type Uint32 as c, NetworkToProverAPI as c0, NetworkToChainId as c1, NetworkToNetworkName as c2, type Deserializable as d, Hex as e, type AuthenticationKeyScheme as f, AccountAddress as g, AnyPublicKeyVariant as h, EphemeralPublicKeyVariant as i, type ClientConfig as j, type FaucetConfig as k, type AptosSettings as l, EphemeralCertificateVariant as m, type AccountAddressInput as n, type ScriptFunctionArgument as o, type MoveFunctionId as p, type MoveStructId as q, type MoveValue as r, type MoveFunctionGenericTypeParam as s, SigningSchemeInput as t, SigningScheme as u, type MoveFunction as v, type AccountData as w, type PaginationArgs as x, type MoveModuleBytecode as y, type TransactionResponse as z };