@aptos-labs/ts-sdk 6.3.1 → 7.0.0

package/dist/api/general.js

@@ -0,0 +1,311 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+import { getChainTopUserTransactions, getIndexerLastSuccessVersion, getLedgerInfo, getProcessorStatus, queryIndexer, } from "../internal/general.js";
+import { getBlockByHeight, getBlockByVersion } from "../internal/transaction.js";
+import { view, viewJson } from "../internal/view.js";
+/**
+ * A class to query various Aptos-related information and perform operations on the Aptos blockchain.
+ * @group General
+ */
+export class General {
+    config;
+    /**
+     * Initializes a new instance of the Aptos client with the specified configuration.
+     * This allows users to interact with the Aptos blockchain using the provided settings.
+     *
+     * @param config - The configuration settings for the Aptos client.
+     * @param config.network - The network to connect to (e.g., TESTNET, MAINNET).
+     * @param config.nodeUrl - The URL of the Aptos node to connect to.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * async function runExample() {
+     *     // Create a configuration for the Aptos client
+     *     const config = new AptosConfig({
+     *         network: Network.TESTNET, // specify the network
+     *         nodeUrl: "https://testnet.aptos.dev" // specify the node URL
+     *     });
+     *
+     *     // Initialize the Aptos client with the configuration
+     *     const aptos = new Aptos(config);
+     *
+     *     console.log("Aptos client initialized:", aptos);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group General
+     */
+    constructor(config) {
+        this.config = config;
+    }
+    /**
+     * Queries for the Aptos ledger information.
+     *
+     * @returns The Aptos Ledger Info, which includes details such as chain ID, epoch, and ledger version.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Fetching the ledger information
+     *   const ledgerInfo = await aptos.getLedgerInfo();
+     *
+     *   console.log(ledgerInfo);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group General
+     */
+    async getLedgerInfo() {
+        return getLedgerInfo({ aptosConfig: this.config });
+    }
+    /**
+     * Retrieves the chain ID of the Aptos blockchain.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Fetching the chain ID
+     *   const chainId = await aptos.getChainId();
+     *   console.log("Chain ID:", chainId);
+     * }
+     * runExample().catch(console.error);
+     *
+     * @returns The chain ID of the Aptos blockchain.
+     * ```
+     * @group General
+     */
+    async getChainId() {
+        const result = await this.getLedgerInfo();
+        return result.chain_id;
+    }
+    /**
+     * Retrieves block information by the specified ledger version.
+     *
+     * @param args - The arguments for retrieving the block.
+     * @param args.ledgerVersion - The ledger version to lookup block information for.
+     * @param args.options - Optional parameters for the request.
+     * @param args.options.withTransactions - If set to true, include all transactions in the block.
+     *
+     * @returns Block information with optional transactions.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Retrieve block information for a specific ledger version
+     *   const block = await aptos.getBlockByVersion({ ledgerVersion: 5 });
+     *   console.log(block);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group General
+     */
+    async getBlockByVersion(args) {
+        return getBlockByVersion({
+            aptosConfig: this.config,
+            ...args,
+        });
+    }
+    /**
+     * Retrieve a block by its height, allowing for the inclusion of transactions if specified.
+     *
+     * @param args - The parameters for the block retrieval.
+     * @param args.blockHeight - The block height to look up, starting at 0.
+     * @param args.options - Optional settings for the retrieval.
+     * @param args.options.withTransactions - If set to true, includes all transactions in the block.
+     *
+     * @returns The block with optional transactions included.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Retrieve the block at height 5, including transactions
+     *   const block = await aptos.getBlockByHeight({ blockHeight: 5, options: { withTransactions: true } });
+     *   console.log(block);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group General
+     */
+    async getBlockByHeight(args) {
+        return getBlockByHeight({ aptosConfig: this.config, ...args });
+    }
+    /**
+     * Queries for a Move view function
+     * @param args.payload Payload for the view function
+     * @param args.options.ledgerVersion The ledger version to query, if not provided it will get the latest version
+     *
+     * @example
+     * const data = await aptos.view({
+     *  payload: {
+     *   function: "0x1::coin::balance",
+     *   typeArguments: ["0x1::aptos_coin::AptosCoin"],
+     *   functionArguments: [accountAddress],
+     *  }
+     * })
+     *
+     * @returns an array of Move values
+     * @group General
+     */
+    async view(args) {
+        return view({ aptosConfig: this.config, ...args });
+    }
+    /**
+     * Queries for a Move view function with JSON, this provides compatability with the old `aptos` package
+     * @param args.payload Payload for the view function
+     * @param args.options.ledgerVersion The ledger version to query, if not provided it will get the latest version
+     *
+     * @example
+     * const data = await aptos.view({
+     *  payload: {
+     *   function: "0x1::coin::balance",
+     *   typeArguments: ["0x1::aptos_coin::AptosCoin"],
+     *   functionArguments: [accountAddress.toString()],
+     *  }
+     * })
+     *
+     * @returns an array of Move values
+     * @group General
+     */
+    async viewJson(args) {
+        return viewJson({ aptosConfig: this.config, ...args });
+    }
+    /**
+     * Queries the top user transactions based on the specified limit.
+     *
+     * @param args - The arguments for querying top user transactions.
+     * @param args.limit - The number of transactions to return.
+     * @returns GetChainTopUserTransactionsResponse
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Fetch the top user transactions with a limit of 5
+     *   const topUserTransactions = await aptos.getChainTopUserTransactions({ limit: 5 });
+     *
+     *   console.log(topUserTransactions);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group General
+     */
+    async getChainTopUserTransactions(args) {
+        return getChainTopUserTransactions({
+            aptosConfig: this.config,
+            ...args,
+        });
+    }
+    /**
+     * Retrieves data from the Aptos Indexer using a GraphQL query.
+     * This function allows you to execute complex queries to fetch specific data from the Aptos blockchain.
+     *
+     * @param args.query.query - A GraphQL query string.
+     * @param args.query.variables - The variables for the query (optional).
+     *
+     * @return The provided T type.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Querying the Aptos Indexer for ledger information
+     *   const topUserTransactions = await aptos.queryIndexer({
+     *     query: { query: `query MyQuery {
+     *       ledger_infos {
+     *         chain_id
+     *       }
+     *     }`}
+     *   });
+     *
+     *   console.log(topUserTransactions);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group General
+     */
+    async queryIndexer(args) {
+        return queryIndexer({
+            aptosConfig: this.config,
+            ...args,
+        });
+    }
+    /**
+     * Queries for the last successful indexer version, providing insight into the ledger version the indexer is updated to, which
+     * may lag behind the full nodes.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Get the last successful indexer version
+     *   const version = await aptos.getIndexerLastSuccessVersion();
+     *   console.log(`Last successful indexer version: ${version}`);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group General
+     */
+    async getIndexerLastSuccessVersion() {
+        return getIndexerLastSuccessVersion({ aptosConfig: this.config });
+    }
+    /**
+     * Query the processor status for a specific processor type.
+     *
+     * @param processorType The processor type to query.
+     * @returns The status of the specified processor type.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   // Get the processor status for the account transactions processor
+     *   const status = await aptos.getProcessorStatus("account_transactions_processor");
+     *   console.log(status);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group General
+     */
+    async getProcessorStatus(processorType) {
+        return getProcessorStatus({ aptosConfig: this.config, processorType });
+    }
+}
+//# sourceMappingURL=general.js.map

package/dist/api/general.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"general.js","sourceRoot":"","sources":["../../src/api/general.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAGtC,OAAO,EACL,2BAA2B,EAC3B,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,YAAY,GACb,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACjF,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAcrD;;;GAGG;AACH,MAAM,OAAO,OAAO;IACT,MAAM,CAAc;IAE7B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,YAAY,MAAmB;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,aAAa;QACjB,OAAO,aAAa,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,UAAU;QACd,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC1C,OAAO,MAAM,CAAC,QAAQ,CAAC;IACzB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,KAAK,CAAC,iBAAiB,CAAC,IAGvB;QACC,OAAO,iBAAiB,CAAC;YACvB,WAAW,EAAE,IAAI,CAAC,MAAM;YACxB,GAAG,IAAI;SACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,KAAK,CAAC,gBAAgB,CAAC,IAA0E;QAC/F,OAAO,gBAAgB,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,IAAI,CAA6B,IAGtC;QACC,OAAO,IAAI,CAAI,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,QAAQ,CAA6B,IAG1C;QACC,OAAO,QAAQ,CAAI,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,2BAA2B,CAAC,IAAuB;QACvD,OAAO,2BAA2B,CAAC;YACjC,WAAW,EAAE,IAAI,CAAC,MAAM;YACxB,GAAG,IAAI;SACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,KAAK,CAAC,YAAY,CAAe,IAA6B;QAC5D,OAAO,YAAY,CAAI;YACrB,WAAW,EAAE,IAAI,CAAC,MAAM;YACxB,GAAG,IAAI;SACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,4BAA4B;QAChC,OAAO,4BAA4B,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,kBAAkB,CAAC,aAA4B;QACnD,OAAO,kBAAkB,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;IACzE,CAAC;CACF"}

package/dist/api/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./aptos.js";
+export * from "./aptosConfig.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAGA,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC"}

package/dist/api/index.js

@@ -0,0 +1,5 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+export * from "./aptos.js";
+export * from "./aptosConfig.js";
+//# sourceMappingURL=index.js.map

package/dist/api/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAEtC,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC"}

package/dist/api/keyless.d.ts

@@ -0,0 +1,160 @@
+import { Account } from "../account/index.js";
+import { EphemeralKeyPair } from "../account/EphemeralKeyPair.js";
+import { KeylessAccount } from "../account/KeylessAccount.js";
+import { ProofFetchCallback } from "../account/AbstractKeylessAccount.js";
+import { FederatedKeylessAccount } from "../account/FederatedKeylessAccount.js";
+import { AccountAddressInput } from "../core/accountAddress.js";
+import { ZeroKnowledgeSig } from "../core/crypto/keyless.js";
+import { InputGenerateTransactionOptions, SimpleTransaction } from "../transactions/index.js";
+import { HexInput } from "../types/index.js";
+import { AptosConfig } from "./aptosConfig.js";
+/**
+ * A class to query all `Keyless` related queries on Aptos.
+ *
+ * More documentation on how to integrate Keyless Accounts see the below
+ * [Aptos Keyless Integration Guide](https://aptos.dev/guides/keyless-accounts/#aptos-keyless-integration-guide).
+ * @group Keyless
+ */
+export declare class Keyless {
+    readonly config: AptosConfig;
+    /**
+     * Initializes a new instance of the Aptos class with the provided configuration.
+     * This allows you to interact with the Aptos blockchain using the specified network settings.
+     *
+     * @param config - The configuration settings for connecting to the Aptos network.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * async function runExample() {
+     *     // Create a new configuration for the Aptos client
+     *     const config = new AptosConfig({ network: Network.TESTNET }); // Specify your desired network
+     *
+     *     // Initialize the Aptos client with the configuration
+     *     const aptos = new Aptos(config);
+     *
+     *     console.log("Aptos client initialized:", aptos);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Keyless
+     */
+    constructor(config: AptosConfig);
+    /**
+     * Fetches the pepper from the Aptos pepper service API.
+     *
+     * @param args - The arguments for fetching the pepper.
+     * @param args.jwt - JWT token.
+     * @param args.ephemeralKeyPair - The EphemeralKeyPair used to generate the nonce in the JWT token.
+     * @param args.derivationPath - A derivation path used for creating multiple accounts per user via the BIP-44 standard. Defaults
+     * to "m/44'/637'/0'/0'/0".
+     * @returns The pepper which is a Uint8Array of length 31.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   const ephemeralKeyPair = new EphemeralKeyPair(); // create a new ephemeral key pair
+     *   const jwt = "your_jwt_token"; // replace with a real JWT token
+     *
+     *   // Fetching the pepper using the provided JWT and ephemeral key pair
+     *   const pepper = await aptos.getPepper({
+     *     jwt,
+     *     ephemeralKeyPair,
+     *     // derivationPath: "m/44'/637'/0'/0'/0" // specify your own if needed
+     *   });
+     *
+     *   console.log("Fetched pepper:", pepper);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Keyless
+     */
+    getPepper(args: {
+        jwt: string;
+        ephemeralKeyPair: EphemeralKeyPair;
+        derivationPath?: string;
+    }): Promise<Uint8Array>;
+    /**
+     * Fetches a proof from the Aptos prover service API.
+     *
+     * @param args - The arguments for fetching the proof.
+     * @param args.jwt - JWT token.
+     * @param args.ephemeralKeyPair - The EphemeralKeyPair used to generate the nonce in the JWT token.
+     * @param args.pepper - The pepper used for the account. If not provided, it will be fetched from the Aptos pepper service.
+     * @param args.uidKey - A key in the JWT token to use to set the uidVal in the IdCommitment.
+     *
+     * @returns The proof which is represented by a ZeroKnowledgeSig.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network, EphemeralKeyPair, getPepper } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   const jwt = "your_jwt_token"; // replace with a real JWT token
+     *   const ephemeralKeyPair = new EphemeralKeyPair(); // create a new ephemeral key pair
+     *
+     *   // Fetch the proof using the getProof function
+     *   const proof = await aptos.getProof({
+     *     jwt,
+     *     ephemeralKeyPair,
+     *     pepper: await getPepper({}), // fetch the pepper if not provided
+     *     uidKey: "sub", // specify the uid key
+     *   });
+     *
+     *   console.log("Fetched proof:", proof);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Keyless
+     */
+    getProof(args: {
+        jwt: string;
+        ephemeralKeyPair: EphemeralKeyPair;
+        pepper?: HexInput;
+        uidKey?: string;
+    }): Promise<ZeroKnowledgeSig>;
+    deriveKeylessAccount(args: {
+        jwt: string;
+        ephemeralKeyPair: EphemeralKeyPair;
+        uidKey?: string;
+        pepper?: HexInput;
+        proofFetchCallback?: ProofFetchCallback;
+    }): Promise<KeylessAccount>;
+    deriveKeylessAccount(args: {
+        jwt: string;
+        ephemeralKeyPair: EphemeralKeyPair;
+        jwkAddress: AccountAddressInput;
+        uidKey?: string;
+        pepper?: HexInput;
+        proofFetchCallback?: ProofFetchCallback;
+    }): Promise<FederatedKeylessAccount>;
+    /**
+     * This installs a set of FederatedJWKs at an address for a given iss.
+     *
+     * It will fetch the JSON Web Keyset (JWK) set from the well-known endpoint and update the FederatedJWKs at the sender's address
+     * to reflect it.
+     *
+     * @param args.sender The account that will install the JWKs
+     * @param args.iss the iss claim of the federated OIDC provider.
+     * @param args.jwksUrl the URL to find the corresponding JWKs. For supported IDP providers this parameter in not necessary.
+     *
+     * @returns The pending transaction that results from submission.
+     * @group Keyless
+     */
+    updateFederatedKeylessJwkSetTransaction(args: {
+        sender: Account;
+        iss: string;
+        jwksUrl?: string;
+        options?: InputGenerateTransactionOptions;
+    }): Promise<SimpleTransaction>;
+}
+//# sourceMappingURL=keyless.d.ts.map

package/dist/api/keyless.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyless.d.ts","sourceRoot":"","sources":["../../src/api/keyless.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAC1E,OAAO,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AAChF,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAO7D,OAAO,EAAE,+BAA+B,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC9F,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;;;;GAMG;AACH,qBAAa,OAAO;IAwBN,QAAQ,CAAC,MAAM,EAAE,WAAW;IAvBxC;;;;;;;;;;;;;;;;;;;;;;OAsBG;gBACkB,MAAM,EAAE,WAAW;IAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACG,SAAS,CAAC,IAAI,EAAE;QACpB,GAAG,EAAE,MAAM,CAAC;QACZ,gBAAgB,EAAE,gBAAgB,CAAC;QACnC,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB,GAAG,OAAO,CAAC,UAAU,CAAC;IAIvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACG,QAAQ,CAAC,IAAI,EAAE;QACnB,GAAG,EAAE,MAAM,CAAC;QACZ,gBAAgB,EAAE,gBAAgB,CAAC;QACnC,MAAM,CAAC,EAAE,QAAQ,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAIvB,oBAAoB,CAAC,IAAI,EAAE;QAC/B,GAAG,EAAE,MAAM,CAAC;QACZ,gBAAgB,EAAE,gBAAgB,CAAC;QACnC,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,QAAQ,CAAC;QAClB,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;KACzC,GAAG,OAAO,CAAC,cAAc,CAAC;IAErB,oBAAoB,CAAC,IAAI,EAAE;QAC/B,GAAG,EAAE,MAAM,CAAC;QACZ,gBAAgB,EAAE,gBAAgB,CAAC;QACnC,UAAU,EAAE,mBAAmB,CAAC;QAChC,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,QAAQ,CAAC;QAClB,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;KACzC,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAsDpC;;;;;;;;;;;;OAYG;IACG,uCAAuC,CAAC,IAAI,EAAE;QAClD,MAAM,EAAE,OAAO,CAAC;QAChB,GAAG,EAAE,MAAM,CAAC;QACZ,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,OAAO,CAAC,EAAE,+BAA+B,CAAC;KAC3C,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAG/B"}

package/dist/api/keyless.js

@@ -0,0 +1,176 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+import { deriveKeylessAccount, getPepper, getProof, updateFederatedKeylessJwkSetTransaction, } from "../internal/keyless.js";
+/**
+ * A class to query all `Keyless` related queries on Aptos.
+ *
+ * More documentation on how to integrate Keyless Accounts see the below
+ * [Aptos Keyless Integration Guide](https://aptos.dev/guides/keyless-accounts/#aptos-keyless-integration-guide).
+ * @group Keyless
+ */
+export class Keyless {
+    config;
+    /**
+     * Initializes a new instance of the Aptos class with the provided configuration.
+     * This allows you to interact with the Aptos blockchain using the specified network settings.
+     *
+     * @param config - The configuration settings for connecting to the Aptos network.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * async function runExample() {
+     *     // Create a new configuration for the Aptos client
+     *     const config = new AptosConfig({ network: Network.TESTNET }); // Specify your desired network
+     *
+     *     // Initialize the Aptos client with the configuration
+     *     const aptos = new Aptos(config);
+     *
+     *     console.log("Aptos client initialized:", aptos);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Keyless
+     */
+    constructor(config) {
+        this.config = config;
+    }
+    /**
+     * Fetches the pepper from the Aptos pepper service API.
+     *
+     * @param args - The arguments for fetching the pepper.
+     * @param args.jwt - JWT token.
+     * @param args.ephemeralKeyPair - The EphemeralKeyPair used to generate the nonce in the JWT token.
+     * @param args.derivationPath - A derivation path used for creating multiple accounts per user via the BIP-44 standard. Defaults
+     * to "m/44'/637'/0'/0'/0".
+     * @returns The pepper which is a Uint8Array of length 31.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   const ephemeralKeyPair = new EphemeralKeyPair(); // create a new ephemeral key pair
+     *   const jwt = "your_jwt_token"; // replace with a real JWT token
+     *
+     *   // Fetching the pepper using the provided JWT and ephemeral key pair
+     *   const pepper = await aptos.getPepper({
+     *     jwt,
+     *     ephemeralKeyPair,
+     *     // derivationPath: "m/44'/637'/0'/0'/0" // specify your own if needed
+     *   });
+     *
+     *   console.log("Fetched pepper:", pepper);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Keyless
+     */
+    async getPepper(args) {
+        return getPepper({ aptosConfig: this.config, ...args });
+    }
+    /**
+     * Fetches a proof from the Aptos prover service API.
+     *
+     * @param args - The arguments for fetching the proof.
+     * @param args.jwt - JWT token.
+     * @param args.ephemeralKeyPair - The EphemeralKeyPair used to generate the nonce in the JWT token.
+     * @param args.pepper - The pepper used for the account. If not provided, it will be fetched from the Aptos pepper service.
+     * @param args.uidKey - A key in the JWT token to use to set the uidVal in the IdCommitment.
+     *
+     * @returns The proof which is represented by a ZeroKnowledgeSig.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network, EphemeralKeyPair, getPepper } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   const jwt = "your_jwt_token"; // replace with a real JWT token
+     *   const ephemeralKeyPair = new EphemeralKeyPair(); // create a new ephemeral key pair
+     *
+     *   // Fetch the proof using the getProof function
+     *   const proof = await aptos.getProof({
+     *     jwt,
+     *     ephemeralKeyPair,
+     *     pepper: await getPepper({}), // fetch the pepper if not provided
+     *     uidKey: "sub", // specify the uid key
+     *   });
+     *
+     *   console.log("Fetched proof:", proof);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Keyless
+     */
+    async getProof(args) {
+        return getProof({ aptosConfig: this.config, ...args });
+    }
+    /**
+     * Derives a Keyless Account from the provided JWT token and corresponding EphemeralKeyPair. This function computes the proof
+     * via the proving service and can fetch the pepper from the pepper service if not explicitly provided.
+     *
+     * @param args - The arguments required to derive the Keyless Account.
+     * @param args.jwt - The JWT token used for deriving the account.
+     * @param args.ephemeralKeyPair - The EphemeralKeyPair used to generate the nonce in the JWT token.
+     * @param args.jwkAddress - The address the where the JWKs used to verify signatures are found.  Setting the value derives a
+     * FederatedKeylessAccount.
+     * @param args.uidKey - An optional key in the JWT token to set the uidVal in the IdCommitment.
+     * @param args.pepper - An optional pepper value.
+     * @param args.proofFetchCallback - An optional callback function for fetching the proof in the background, allowing for a more
+     * responsive user experience.
+     *
+     * @returns A KeylessAccount that can be used to sign transactions.
+     *
+     * @example
+     * ```typescript
+     * import { Aptos, AptosConfig, Network, deriveKeylessAccount } from "@aptos-labs/ts-sdk";
+     *
+     * const config = new AptosConfig({ network: Network.TESTNET });
+     * const aptos = new Aptos(config);
+     *
+     * async function runExample() {
+     *   const jwt = "your_jwt_token"; // replace with a real JWT token
+     *   const ephemeralKeyPair = new EphemeralKeyPair(); // create a new ephemeral key pair
+     *
+     *   // Deriving the Keyless Account
+     *   const keylessAccount = await deriveKeylessAccount({
+     *     jwt,
+     *     ephemeralKeyPair,
+     *     uidKey: "your_uid_key", // optional
+     *     pepper: "your_pepper", // optional
+     *   });
+     *
+     *   console.log("Keyless Account derived:", keylessAccount);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Keyless
+     */
+    async deriveKeylessAccount(args) {
+        return deriveKeylessAccount({ aptosConfig: this.config, ...args });
+    }
+    /**
+     * This installs a set of FederatedJWKs at an address for a given iss.
+     *
+     * It will fetch the JSON Web Keyset (JWK) set from the well-known endpoint and update the FederatedJWKs at the sender's address
+     * to reflect it.
+     *
+     * @param args.sender The account that will install the JWKs
+     * @param args.iss the iss claim of the federated OIDC provider.
+     * @param args.jwksUrl the URL to find the corresponding JWKs. For supported IDP providers this parameter in not necessary.
+     *
+     * @returns The pending transaction that results from submission.
+     * @group Keyless
+     */
+    async updateFederatedKeylessJwkSetTransaction(args) {
+        return updateFederatedKeylessJwkSetTransaction({ aptosConfig: this.config, ...args });
+    }
+}
+//# sourceMappingURL=keyless.js.map

package/dist/api/keyless.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyless.js","sourceRoot":"","sources":["../../src/api/keyless.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,sCAAsC;AAStC,OAAO,EACL,oBAAoB,EACpB,SAAS,EACT,QAAQ,EACR,uCAAuC,GACxC,MAAM,wBAAwB,CAAC;AAKhC;;;;;;GAMG;AACH,MAAM,OAAO,OAAO;IAwBG;IAvBrB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,YAAqB,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,KAAK,CAAC,SAAS,CAAC,IAIf;QACC,OAAO,SAAS,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,KAAK,CAAC,QAAQ,CAAC,IAKd;QACC,OAAO,QAAQ,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACzD,CAAC;IAmBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACH,KAAK,CAAC,oBAAoB,CAAC,IAO1B;QACC,OAAO,oBAAoB,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,uCAAuC,CAAC,IAK7C;QACC,OAAO,uCAAuC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACxF,CAAC;CACF"}