@moveindustries/ts-sdk 5.1.4

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

@@ -0,0 +1,141 @@
+import { M as MovementConfig, s as AccountAddressInput, aK as InputGenerateTransactionPayloadData, aG as InputGenerateTransactionOptions, ag as SimpleTransaction, ab as MultiAgentTransaction } from '../../accountAddress-CNXtapt1.mjs';
+import '../../types/indexer.mjs';
+import '../../types/generated/operations.mjs';
+import '../../types/generated/types.mjs';
+import '../../utils/apiEndpoints.mjs';
+import '../../utils/const.mjs';
+import '../../core/common.mjs';
+
+/**
+ * A class to handle all `Build` transaction operations.
+ * @group Implementation
+ */
+declare class Build {
+    readonly config: MovementConfig;
+    /**
+     * Initializes a new instance of the Movement client with the specified configuration.
+     * This allows you to interact with the Movement blockchain using the provided settings.
+     *
+     * @param config - The configuration settings for the Movement client.
+     * @param config.network - The network to connect to (e.g., TESTNET, MAINNET).
+     * @param config.nodeUrl - The URL of the Movement node to connect to.
+     * @param config.account - The account details for authentication.
+     *
+     * @example
+     * ```typescript
+     * import { Movement, MovementConfig, Network } from "@moveindustries/ts-sdk";
+     *
+     * async function runExample() {
+     *     // Create a configuration for the Movement client
+     *     const config = new MovementConfig({
+     *         network: Network.TESTNET, // specify the network
+     *         nodeUrl: "https://testnet.movement.dev", // specify the node URL
+     *     });
+     *
+     *     // Initialize the Movement client
+     *     const movement = new Movement(config);
+     *
+     *     console.log("Movement client initialized:", aptos);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Implementation
+     */
+    constructor(config: MovementConfig);
+    /**
+     * Build a simple transaction.
+     *
+     * This function allows you to create a transaction with specified sender and data.
+     *
+     * @param args.sender - The sender account address.
+     * @param args.data - The transaction data.
+     * @param args.options - Optional transaction configurations.
+     * @param args.withFeePayer - Whether there is a fee payer for the transaction.
+     *
+     * @returns SimpleTransaction
+     *
+     * @example
+     * ```typescript
+     * import { Movement, MovementConfig, Network } from "@moveindustries/ts-sdk";
+     *
+     * const config = new MovementConfig({ network: Network.TESTNET });
+     * const movement = new Movement(config);
+     *
+     * async function runExample() {
+     *   // Build a simple transaction
+     *   const transaction = await movement.transaction.simple({
+     *     sender: "0x1", // replace with a real sender account address
+     *     data: {
+     *       function: "0x1::aptos_account::transfer",
+     *       functionArguments: ["0x2", 100], // replace with a real destination account address
+     *     },
+     *     options: {
+     *       gasUnitPrice: 100, // specify your own gas unit price if needed
+     *       maxGasAmount: 1000, // specify your own max gas amount if needed
+     *     },
+     *   });
+     *
+     *   console.log(transaction);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Implementation
+     */
+    simple(args: {
+        sender: AccountAddressInput;
+        data: InputGenerateTransactionPayloadData;
+        options?: InputGenerateTransactionOptions;
+        withFeePayer?: boolean;
+    }): Promise<SimpleTransaction>;
+    /**
+     * Build a multi-agent transaction that allows multiple signers to authorize a transaction.
+     *
+     * @param args - The parameters for creating the multi-agent transaction.
+     * @param args.sender - The sender account address.
+     * @param args.data - The transaction data.
+     * @param args.secondarySignerAddresses - An array of the secondary signers' account addresses.
+     * @param args.options - Optional transaction configurations.
+     * @param args.withFeePayer - Whether there is a fee payer for the transaction.
+     *
+     * @returns MultiAgentTransaction
+     *
+     * @example
+     * ```typescript
+     * import { Movement, MovementConfig, Network } from "@moveindustries/ts-sdk";
+     *
+     * const config = new MovementConfig({ network: Network.TESTNET });
+     * const movement = new Movement(config);
+     *
+     * async function runExample() {
+     *   // Build a multi-agent transaction
+     *   const transaction = await movement.multiAgent({
+     *     sender: "0x1", // replace with a real sender account address
+     *     data: {
+     *       // Transaction data structure
+     *       function: "0x1::aptos_account::transfer",
+     *       functionArguments: ["0x2", 100], // replace with a real destination account address and amount
+     *     },
+     *     secondarySignerAddresses: ["0x3", "0x4"], // replace with real secondary signer addresses
+     *     options: {
+     *       // Optional transaction configurations
+     *       maxGasAmount: "1000",
+     *       gasUnitPrice: "1",
+     *     },
+     *   });
+     *
+     *   console.log(transaction);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Implementation
+     */
+    multiAgent(args: {
+        sender: AccountAddressInput;
+        data: InputGenerateTransactionPayloadData;
+        secondarySignerAddresses: AccountAddressInput[];
+        options?: InputGenerateTransactionOptions;
+        withFeePayer?: boolean;
+    }): Promise<MultiAgentTransaction>;
+}
+
+export { Build };

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

@@ -0,0 +1,2 @@
+import{qe as a}from"../../chunk-47V7UGV5.mjs";import"../../chunk-A5L76YP7.mjs";import"../../chunk-YFFYA5U3.mjs";import"../../chunk-UYVPNUH3.mjs";import"../../chunk-G3MHXDYA.mjs";import"../../chunk-RUIFVDWM.mjs";import"../../chunk-WVDICMU4.mjs";import"../../chunk-2KDUIZKB.mjs";import"../../chunk-OOOAVIMQ.mjs";import"../../chunk-V3O2SBO4.mjs";import"../../chunk-D6HPXGEP.mjs";import"../../chunk-5HXLZHDW.mjs";import"../../chunk-7TTTMBAK.mjs";import"../../chunk-GOXRBEIJ.mjs";import"../../chunk-2QTV4AOE.mjs";import"../../chunk-PHRRBT44.mjs";import"../../chunk-VEZCMPUG.mjs";import"../../chunk-CHWDP6AR.mjs";import"../../chunk-V3MBJJTL.mjs";import"../../chunk-NECL5FCQ.mjs";import"../../chunk-4QMXOWHP.mjs";import"../../chunk-ZP4DWSQA.mjs";import"../../chunk-NUB6KE73.mjs";import"../../chunk-I6YGBK5S.mjs";import"../../chunk-S4D2KBYN.mjs";import"../../chunk-CRCE7R4D.mjs";import"../../chunk-NQUZ4UHR.mjs";import"../../chunk-NMFJJOGW.mjs";import"../../chunk-5ZKA765G.mjs";import"../../chunk-FJRPU2NH.mjs";import"../../chunk-UL777LTI.mjs";import"../../chunk-7ECCT6PK.mjs";import"../../chunk-SYXDZA4K.mjs";import"../../chunk-R2G23RIY.mjs";import"../../chunk-MEWW7VTQ.mjs";import"../../chunk-HGLO5LDS.mjs";import"../../chunk-ANTEUWH6.mjs";import"../../chunk-KPJGWDSQ.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-6NO4QKAO.mjs";import"../../chunk-FS5ZJKO7.mjs";import"../../chunk-UVP74ONT.mjs";import"../../chunk-XCURF77K.mjs";import"../../chunk-RXHPS4IU.mjs";import"../../chunk-WFAH73WN.mjs";import"../../chunk-Y6YW4BAZ.mjs";import"../../chunk-DS6QB6HG.mjs";import"../../chunk-FD6FGKYY.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-YOHEYPDP.mjs";import"../../chunk-SRXFRTHK.mjs";import"../../chunk-5IMQPJ6J.mjs";import"../../chunk-RL4YPMN4.mjs";import"../../chunk-UI4OF6CP.mjs";import"../../chunk-PZ233FIY.mjs";import"../../chunk-VW3WBAAD.mjs";import"../../chunk-PCESRJYO.mjs";import"../../chunk-KDMSOCZY.mjs";export{a as Build};
+//# sourceMappingURL=build.mjs.map

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

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

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

@@ -0,0 +1,98 @@
+import { M as MovementConfig, b3 as AnyRawTransaction, a0 as AccountAuthenticator, b9 as InputTransactionPluginData } from '../../accountAddress-CNXtapt1.mjs';
+import '../../types/indexer.mjs';
+import '../../types/generated/operations.mjs';
+import '../../types/generated/types.mjs';
+import '../../utils/apiEndpoints.mjs';
+import '../../utils/const.mjs';
+import '../../core/common.mjs';
+
+/**
+ * Validates the fee payer data when submitting a transaction to ensure that the fee
+ * payer authenticator is provided if a fee payer address is specified. This helps
+ * prevent errors in transaction submission related to fee payer authentication.
+ *
+ * The validation is skipped if a custom transaction submitter is defined.
+ *
+ * @param config - The Movement configuration that may contain a transaction submitter.
+ * @param args - The method arguments containing transaction data and optional transaction submitter.
+ *
+ * @example
+ * ```typescript
+ * import { Movement, MovementConfig, Network } from "@moveindustries/ts-sdk";
+ *
+ * const config = new MovementConfig({ network: Network.TESTNET });
+ * const movement = new Movement(config);
+ *
+ * class TransactionHandler {
+ *   async submitTransaction(methodArgs: { transaction: { feePayerAddress: string }, feePayerAuthenticator?: string }) {
+ *     validateFeePayerDataOnSubmission(this.config, methodArgs);
+ *     // Logic to submit the transaction
+ *   }
+ * }
+ *
+ * async function runExample() {
+ *   const handler = new TransactionHandler();
+ *
+ *   // Attempt to submit a transaction without a fee payer authenticator
+ *   try {
+ *     await handler.submitTransaction({
+ *       transaction: { feePayerAddress: "0x1" }, // replace with a real fee payer address
+ *     });
+ *   } catch (error) {
+ *     console.error(error.message); // Should log the error message
+ *   }
+ *
+ *   // Submit a transaction with a fee payer authenticator
+ *   await handler.submitTransaction({
+ *     transaction: { feePayerAddress: "0x1" }, // replace with a real fee payer address
+ *     feePayerAuthenticator: "authenticatorValue", // replace with a real authenticator
+ *   });
+ *
+ *   console.log("Transaction submitted successfully.");
+ * }
+ * runExample().catch(console.error);
+ * ```
+ * @group Implementation
+ */
+declare function validateFeePayerDataOnSubmission(config: MovementConfig, args: {
+    transaction: AnyRawTransaction;
+    senderAuthenticator: AccountAuthenticator;
+    feePayerAuthenticator?: AccountAuthenticator;
+} & InputTransactionPluginData): void;
+/**
+ * Validates that the fee payer public key is provided when simulating a Fee Payer transaction.
+ * This ensures that all necessary data is present for the simulation to proceed correctly.
+ *
+ * @param target - The target object where the method is defined.
+ * @param propertyKey - The name of the method being decorated.
+ * @param descriptor - The property descriptor for the method.
+ *
+ * @example
+ * ```typescript
+ * import { Movement, MovementConfig, Network } from "@moveindustries/ts-sdk";
+ *
+ * const config = new MovementConfig({ network: Network.TESTNET });
+ * const movement = new Movement(config);
+ *
+ * async function runExample() {
+ *   const methodArgs = {
+ *     transaction: {
+ *       feePayerAddress: "0x1", // replace with a real fee payer address
+ *     },
+ *     feePayerPublicKey: undefined, // missing fee payer public key
+ *   };
+ *
+ *   try {
+ *     // This will throw an error due to missing feePayerPublicKey
+ *     await movement.someMethod(methodArgs);
+ *   } catch (error) {
+ *     console.error(error.message); // Output the error message
+ *   }
+ * }
+ * runExample().catch(console.error);
+ * ```
+ * @group Implementation
+ */
+declare function ValidateFeePayerDataOnSimulation(target: unknown, propertyKey: string, descriptor: PropertyDescriptor): PropertyDescriptor;
+
+export { ValidateFeePayerDataOnSimulation, validateFeePayerDataOnSubmission };

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

@@ -0,0 +1,2 @@
+import{a,b}from"../../chunk-2QTV4AOE.mjs";import"../../chunk-KDMSOCZY.mjs";export{b as ValidateFeePayerDataOnSimulation,a as validateFeePayerDataOnSubmission};
+//# sourceMappingURL=helpers.mjs.map

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

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

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

@@ -0,0 +1,168 @@
+import EventEmitter from 'eventemitter3';
+import { M as MovementConfig, aK as InputGenerateTransactionPayloadData, aG as InputGenerateTransactionOptions } from '../../accountAddress-CNXtapt1.mjs';
+import { A as Account } from '../../Ed25519Account-DsqenvLJ.mjs';
+import { TransactionWorkerEvents, TransactionWorker } from '../../transactions/management/transactionWorker.mjs';
+import '../../types/indexer.mjs';
+import '../../types/generated/operations.mjs';
+import '../../types/generated/types.mjs';
+import '../../utils/apiEndpoints.mjs';
+import '../../utils/const.mjs';
+import '../../core/common.mjs';
+import '../../transactions/management/accountSequenceNumber.mjs';
+import '../../transactions/management/asyncQueue.mjs';
+
+declare class TransactionManagement extends EventEmitter<TransactionWorkerEvents> {
+    account: Account;
+    transactionWorker: TransactionWorker;
+    readonly config: MovementConfig;
+    /**
+     * Initializes a new instance of the Movement client with the provided configuration settings.
+     * This allows you to interact with the Movement blockchain using the specified network and options.
+     *
+     * @param config - The configuration settings for the Movement client.
+     * @param config.network - The network to connect to (e.g., TESTNET, MAINNET).
+     * @param config.nodeUrl - The URL of the Movement node to connect to.
+     * @param config.account - Optional account settings for authentication.
+     *
+     * @example
+     * ```typescript
+     * import { Movement, MovementConfig, Network } from "@moveindustries/ts-sdk";
+     *
+     * async function runExample() {
+     *     // Create a configuration for the Movement client
+     *     const config = new MovementConfig({
+     *         network: Network.TESTNET, // specify the network to use
+     *         nodeUrl: "https://testnet.movement.dev" // replace with your node URL
+     *     });
+     *
+     *     // Initialize the Movement client with the configuration
+     *     const movement = new Movement(config);
+     *
+     *     console.log("Movement client initialized successfully.");
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Implementation
+     */
+    constructor(config: MovementConfig);
+    /**
+     * Initializes the transaction worker using the provided sender account and begins listening for events.
+     * This function is essential for setting up the transaction processing environment.
+     *
+     * @param args - The arguments for starting the transaction worker.
+     * @param args.sender - The sender account to sign and submit the transaction.
+     *
+     * @example
+     * ```typescript
+     * import { Movement, MovementConfig, Network, Account } from "@moveindustries/ts-sdk";
+     *
+     * const config = new MovementConfig({ network: Network.TESTNET });
+     * const movement = new Movement(config);
+     *
+     * async function runExample() {
+     *     const sender = Account.generate(); // Generate a new account for sending transactions
+     *
+     *     // Start the transaction worker with the sender account
+     *     movement.start({ sender });
+     *
+     *     console.log("Transaction worker started with sender:", sender.accountAddress);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Implementation
+     */
+    private start;
+    /**
+     * Pushes transaction data to the transaction worker for processing.
+     *
+     * @param args.data An array of transaction payloads to be processed.
+     * @param args.options Optional. Transaction generation configurations (excluding accountSequenceNumber).
+     *
+     * @example
+     * ```typescript
+     * import { Movement, MovementConfig, Network } from "@moveindustries/ts-sdk";
+     *
+     * const config = new MovementConfig({ network: Network.TESTNET });
+     * const movement = new Movement(config);
+     *
+     * async function runExample() {
+     *   // Prepare transaction payloads
+     *   const payloads = [
+     *      {}, // Build your first transaction payload
+     *      {}, // Build your second transaction payload
+     *   ];
+     *
+     *   // Push transaction data to the worker
+     *   movement.push({
+     *     data: payloads,
+     *     {}, // Specify options as needed
+     *   });
+     *
+     *   console.log("Transaction data pushed successfully.");
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Implementation
+     */
+    private push;
+    /**
+     * Starts listening to transaction worker events, allowing the application to respond to transaction status changes.
+     * This function enables the application to handle events such as transaction sent, execution success, or failure.
+     *
+     * @example
+     * ```typescript
+     * import { Movement, MovementConfig, Network } from "@moveindustries/ts-sdk";
+     *
+     * const config = new MovementConfig({ network: Network.TESTNET });
+     * const movement = new Movement(config);
+     *
+     * async function runExample() {
+     *   // Register to listen for transaction events
+     *   movement.registerToEvents();
+     *
+     *   // You can send a transaction here to see the events in action
+     *   const sender = Account.generate(); // replace with a real account
+     *   const destination = Account.generate(); // replace with a real account
+     *
+     *   const transaction = await movement.transaction.build.simple({
+     *     sender: sender.accountAddress,
+     *     data: {
+     *       function: "0x1::aptos_account::transfer",
+     *       functionArguments: [destination.accountAddress, 100],
+     *     },
+     *   });
+     *
+     *   await movement.transaction.send(transaction);
+     *
+     *   console.log("Transaction sent and events registered.");
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Implementation
+     */
+    private registerToEvents;
+    /**
+     * Send batch transactions for a single account.
+     *
+     * This function uses a transaction worker that receives payloads to be processed
+     * and submitted to chain.
+     * Note that this process is best for submitting multiple transactions that
+     * don't rely on each other, i.e. batch funds, batch token mints, etc.
+     *
+     * If any worker failure, the functions throws an error.
+     *
+     * @param args.sender The sender account to sign and submit the transaction
+     * @param args.data An array of transaction payloads
+     * @param args.options optional. Transaction generation configurations (excluding accountSequenceNumber)
+     *
+     * @return void. Throws if any error
+     * @group Implementation
+     */
+    forSingleAccount(args: {
+        sender: Account;
+        data: InputGenerateTransactionPayloadData[];
+        options?: Omit<InputGenerateTransactionOptions, "accountSequenceNumber">;
+    }): void;
+}
+
+export { TransactionManagement };

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

@@ -0,0 +1,2 @@
+import{ve as a}from"../../chunk-47V7UGV5.mjs";import"../../chunk-A5L76YP7.mjs";import"../../chunk-YFFYA5U3.mjs";import"../../chunk-UYVPNUH3.mjs";import"../../chunk-G3MHXDYA.mjs";import"../../chunk-RUIFVDWM.mjs";import"../../chunk-WVDICMU4.mjs";import"../../chunk-2KDUIZKB.mjs";import"../../chunk-OOOAVIMQ.mjs";import"../../chunk-V3O2SBO4.mjs";import"../../chunk-D6HPXGEP.mjs";import"../../chunk-5HXLZHDW.mjs";import"../../chunk-7TTTMBAK.mjs";import"../../chunk-GOXRBEIJ.mjs";import"../../chunk-2QTV4AOE.mjs";import"../../chunk-PHRRBT44.mjs";import"../../chunk-VEZCMPUG.mjs";import"../../chunk-CHWDP6AR.mjs";import"../../chunk-V3MBJJTL.mjs";import"../../chunk-NECL5FCQ.mjs";import"../../chunk-4QMXOWHP.mjs";import"../../chunk-ZP4DWSQA.mjs";import"../../chunk-NUB6KE73.mjs";import"../../chunk-I6YGBK5S.mjs";import"../../chunk-S4D2KBYN.mjs";import"../../chunk-CRCE7R4D.mjs";import"../../chunk-NQUZ4UHR.mjs";import"../../chunk-NMFJJOGW.mjs";import"../../chunk-5ZKA765G.mjs";import"../../chunk-FJRPU2NH.mjs";import"../../chunk-UL777LTI.mjs";import"../../chunk-7ECCT6PK.mjs";import"../../chunk-SYXDZA4K.mjs";import"../../chunk-R2G23RIY.mjs";import"../../chunk-MEWW7VTQ.mjs";import"../../chunk-HGLO5LDS.mjs";import"../../chunk-ANTEUWH6.mjs";import"../../chunk-KPJGWDSQ.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-6NO4QKAO.mjs";import"../../chunk-FS5ZJKO7.mjs";import"../../chunk-UVP74ONT.mjs";import"../../chunk-XCURF77K.mjs";import"../../chunk-RXHPS4IU.mjs";import"../../chunk-WFAH73WN.mjs";import"../../chunk-Y6YW4BAZ.mjs";import"../../chunk-DS6QB6HG.mjs";import"../../chunk-FD6FGKYY.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-YOHEYPDP.mjs";import"../../chunk-SRXFRTHK.mjs";import"../../chunk-5IMQPJ6J.mjs";import"../../chunk-RL4YPMN4.mjs";import"../../chunk-UI4OF6CP.mjs";import"../../chunk-PZ233FIY.mjs";import"../../chunk-VW3WBAAD.mjs";import"../../chunk-PCESRJYO.mjs";import"../../chunk-KDMSOCZY.mjs";export{a as TransactionManagement};
+//# sourceMappingURL=management.mjs.map

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

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

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

@@ -0,0 +1,124 @@
+import { M as MovementConfig, b3 as AnyRawTransaction, a0 as AccountAuthenticator } from '../../accountAddress-CNXtapt1.mjs';
+import { A as Account } from '../../Ed25519Account-DsqenvLJ.mjs';
+import '../../types/indexer.mjs';
+import '../../types/generated/operations.mjs';
+import '../../types/generated/types.mjs';
+import '../../utils/apiEndpoints.mjs';
+import '../../utils/const.mjs';
+import '../../core/common.mjs';
+
+/**
+ * A class to handle all `Sign` transaction operations.
+ *
+ * @param config - The configuration object for Movement.
+ * @group Implementation
+ */
+declare class Sign {
+    readonly config: MovementConfig;
+    /**
+     * Creates an instance of the Movement client with the specified configuration.
+     *
+     * @param config - The configuration settings for the Movement client.
+     *
+     * @example
+     * ```typescript
+     * import { Movement, MovementConfig, Network } from "@moveindustries/ts-sdk";
+     *
+     * async function runExample() {
+     *     // Create a new Movement client with testnet configuration
+     *     const config = new MovementConfig({ network: Network.TESTNET });
+     *     const movement = new Movement(config);
+     *
+     *     console.log("Movement client created with config:", config);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Implementation
+     */
+    constructor(config: MovementConfig);
+    /**
+     * Signs a transaction using the provided account signer. This function is essential for ensuring that transactions are properly
+     * authenticated before being sent to the network.
+     *
+     * @param args - The arguments for signing the transaction.
+     * @param args.signer - The account that will sign the transaction.
+     * @param args.transaction - The raw transaction data to be signed.
+     *
+     * @example
+     * ```typescript
+     * import { Movement, MovementConfig, Network, Account } from "@moveindustries/ts-sdk";
+     *
+     * const config = new MovementConfig({ network: Network.TESTNET });
+     * const movement = new Movement(config);
+     *
+     * async function runExample() {
+     *   const sender = Account.generate(); // Generate a new account for signing
+     *   const transaction = await movement.transaction.build.simple({
+     *     sender: sender.accountAddress,
+     *     data: {
+     *       function: "0x1::aptos_account::transfer",
+     *       functionArguments: [ "0x1", 100 ], // replace with a real account address and amount
+     *     },
+     *   });
+     *
+     *   // Sign the transaction
+     *   const signedTransaction = await movement.transaction.sign({
+     *     signer: sender,
+     *     transaction: transaction,
+     *   });
+     *
+     *   console.log("Signed Transaction:", signedTransaction);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Implementation
+     */
+    transaction(args: {
+        signer: Account;
+        transaction: AnyRawTransaction;
+    }): AccountAuthenticator;
+    /**
+     * Sets the fee payer address for a transaction and signs it with the provided account.
+     * This function is essential for transactions that require a designated fee payer.
+     *
+     * @param args - The arguments for the function.
+     * @param args.signer - The account that will sign the transaction.
+     * @param args.transaction - The transaction object that requires a fee payer address.
+     *
+     * @throws Error if the transaction does not have a feePayerAddress property.
+     *
+     * @example
+     * ```typescript
+     * import { Movement, MovementConfig, Network, Account } from "@moveindustries/ts-sdk";
+     *
+     * const config = new MovementConfig({ network: Network.TESTNET });
+     * const movement = new Movement(config);
+     *
+     * async function runExample() {
+     *   const sender = Account.generate(); // Generate a new account for signing
+     *   const transaction = await movement.transaction.build.simple({
+     *     sender: sender.accountAddress,
+     *     data: {
+     *       function: "0x1::aptos_account::transfer",
+     *       functionArguments: ["0x1", 100], // replace with a real recipient address
+     *     },
+     *   });
+     *
+     *   // Set the fee payer for the transaction
+     *   transaction.feePayerAddress = "0x1"; // replace with a real fee payer address
+     *
+     *   const signedTransaction = await movement.transactionAsFeePayer({ signer: sender, transaction });
+     *
+     *   console.log("Signed Transaction:", signedTransaction);
+     * }
+     * runExample().catch(console.error);
+     * ```
+     * @group Implementation
+     */
+    transactionAsFeePayer(args: {
+        signer: Account;
+        transaction: AnyRawTransaction;
+    }): AccountAuthenticator;
+}
+
+export { Sign };

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

@@ -0,0 +1,2 @@
+import{qc as o}from"../../chunk-47V7UGV5.mjs";import"../../chunk-A5L76YP7.mjs";import"../../chunk-YFFYA5U3.mjs";import"../../chunk-UYVPNUH3.mjs";import"../../chunk-G3MHXDYA.mjs";import"../../chunk-RUIFVDWM.mjs";import"../../chunk-WVDICMU4.mjs";import"../../chunk-2KDUIZKB.mjs";import"../../chunk-OOOAVIMQ.mjs";import"../../chunk-V3O2SBO4.mjs";import"../../chunk-D6HPXGEP.mjs";import"../../chunk-5HXLZHDW.mjs";import"../../chunk-7TTTMBAK.mjs";import"../../chunk-GOXRBEIJ.mjs";import"../../chunk-2QTV4AOE.mjs";import"../../chunk-PHRRBT44.mjs";import"../../chunk-VEZCMPUG.mjs";import"../../chunk-CHWDP6AR.mjs";import"../../chunk-V3MBJJTL.mjs";import"../../chunk-NECL5FCQ.mjs";import"../../chunk-4QMXOWHP.mjs";import"../../chunk-ZP4DWSQA.mjs";import"../../chunk-NUB6KE73.mjs";import"../../chunk-I6YGBK5S.mjs";import"../../chunk-S4D2KBYN.mjs";import"../../chunk-CRCE7R4D.mjs";import"../../chunk-NQUZ4UHR.mjs";import"../../chunk-NMFJJOGW.mjs";import"../../chunk-5ZKA765G.mjs";import"../../chunk-FJRPU2NH.mjs";import"../../chunk-UL777LTI.mjs";import"../../chunk-7ECCT6PK.mjs";import"../../chunk-SYXDZA4K.mjs";import"../../chunk-R2G23RIY.mjs";import"../../chunk-MEWW7VTQ.mjs";import"../../chunk-HGLO5LDS.mjs";import"../../chunk-ANTEUWH6.mjs";import"../../chunk-KPJGWDSQ.mjs";import"../../chunk-FZY4PMEE.mjs";import"../../chunk-6NO4QKAO.mjs";import"../../chunk-FS5ZJKO7.mjs";import"../../chunk-UVP74ONT.mjs";import"../../chunk-XCURF77K.mjs";import"../../chunk-RXHPS4IU.mjs";import"../../chunk-WFAH73WN.mjs";import"../../chunk-Y6YW4BAZ.mjs";import"../../chunk-DS6QB6HG.mjs";import"../../chunk-FD6FGKYY.mjs";import"../../chunk-4WPQQPUF.mjs";import"../../chunk-YOHEYPDP.mjs";import"../../chunk-SRXFRTHK.mjs";import"../../chunk-5IMQPJ6J.mjs";import"../../chunk-RL4YPMN4.mjs";import"../../chunk-UI4OF6CP.mjs";import"../../chunk-PZ233FIY.mjs";import"../../chunk-VW3WBAAD.mjs";import"../../chunk-PCESRJYO.mjs";import"../../chunk-KDMSOCZY.mjs";var a=class{constructor(n){this.config=n}transaction(n){return o({...n})}transactionAsFeePayer(n){let{signer:r,transaction:t}=n;if(!t.feePayerAddress)throw new Error(`Transaction ${t} is not a Fee Payer transaction`);return t.feePayerAddress=r.accountAddress,o({signer:r,transaction:t})}};export{a as Sign};
+//# sourceMappingURL=sign.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/api/transactionSubmission/sign.ts"],"sourcesContent":["// Copyright © Move Industries\n// SPDX-License-Identifier: Apache-2.0\n\nimport { Account } from \"../../account\";\nimport { signTransaction } from \"../../internal/transactionSubmission\";\nimport { AccountAuthenticator, AnyRawTransaction } from \"../../transactions\";\nimport { MovementConfig } from \"../movementConfig\";\n\n/**\n * A class to handle all `Sign` transaction operations.\n *\n * @param config - The configuration object for Movement.\n * @group Implementation\n */\nexport class Sign {\n  readonly config: MovementConfig;\n\n  /**\n   * Creates an instance of the Movement client with the specified configuration.\n   *\n   * @param config - The configuration settings for the Movement client.\n   *\n   * @example\n   * ```typescript\n   * import { Movement, MovementConfig, Network } from \"@moveindustries/ts-sdk\";\n   *\n   * async function runExample() {\n   *     // Create a new Movement client with testnet configuration\n   *     const config = new MovementConfig({ network: Network.TESTNET });\n   *     const movement = new Movement(config);\n   *\n   *     console.log(\"Movement client created with config:\", config);\n   * }\n   * runExample().catch(console.error);\n   * ```\n   * @group Implementation\n   */\n  constructor(config: MovementConfig) {\n    this.config = config;\n  }\n\n  /**\n   * Signs a transaction using the provided account signer. This function is essential for ensuring that transactions are properly\n   * authenticated before being sent to the network.\n   *\n   * @param args - The arguments for signing the transaction.\n   * @param args.signer - The account that will sign the transaction.\n   * @param args.transaction - The raw transaction data to be signed.\n   *\n   * @example\n   * ```typescript\n   * import { Movement, MovementConfig, Network, Account } from \"@moveindustries/ts-sdk\";\n   *\n   * const config = new MovementConfig({ network: Network.TESTNET });\n   * const movement = new Movement(config);\n   *\n   * async function runExample() {\n   *   const sender = Account.generate(); // Generate a new account for signing\n   *   const transaction = await movement.transaction.build.simple({\n   *     sender: sender.accountAddress,\n   *     data: {\n   *       function: \"0x1::aptos_account::transfer\",\n   *       functionArguments: [ \"0x1\", 100 ], // replace with a real account address and amount\n   *     },\n   *   });\n   *\n   *   // Sign the transaction\n   *   const signedTransaction = await movement.transaction.sign({\n   *     signer: sender,\n   *     transaction: transaction,\n   *   });\n   *\n   *   console.log(\"Signed Transaction:\", signedTransaction);\n   * }\n   * runExample().catch(console.error);\n   * ```\n   * @group Implementation\n   */\n  // eslint-disable-next-line class-methods-use-this\n  transaction(args: { signer: Account; transaction: AnyRawTransaction }): AccountAuthenticator {\n    return signTransaction({\n      ...args,\n    });\n  }\n\n  /**\n   * Sets the fee payer address for a transaction and signs it with the provided account.\n   * This function is essential for transactions that require a designated fee payer.\n   *\n   * @param args - The arguments for the function.\n   * @param args.signer - The account that will sign the transaction.\n   * @param args.transaction - The transaction object that requires a fee payer address.\n   *\n   * @throws Error if the transaction does not have a feePayerAddress property.\n   *\n   * @example\n   * ```typescript\n   * import { Movement, MovementConfig, Network, Account } from \"@moveindustries/ts-sdk\";\n   *\n   * const config = new MovementConfig({ network: Network.TESTNET });\n   * const movement = new Movement(config);\n   *\n   * async function runExample() {\n   *   const sender = Account.generate(); // Generate a new account for signing\n   *   const transaction = await movement.transaction.build.simple({\n   *     sender: sender.accountAddress,\n   *     data: {\n   *       function: \"0x1::aptos_account::transfer\",\n   *       functionArguments: [\"0x1\", 100], // replace with a real recipient address\n   *     },\n   *   });\n   *\n   *   // Set the fee payer for the transaction\n   *   transaction.feePayerAddress = \"0x1\"; // replace with a real fee payer address\n   *\n   *   const signedTransaction = await movement.transactionAsFeePayer({ signer: sender, transaction });\n   *\n   *   console.log(\"Signed Transaction:\", signedTransaction);\n   * }\n   * runExample().catch(console.error);\n   * ```\n   * @group Implementation\n   */\n  // eslint-disable-next-line class-methods-use-this\n  transactionAsFeePayer(args: { signer: Account; transaction: AnyRawTransaction }): AccountAuthenticator {\n    const { signer, transaction } = args;\n\n    // if transaction doesn't hold a \"feePayerAddress\" prop it means\n    // this is not a fee payer transaction\n    if (!transaction.feePayerAddress) {\n      throw new Error(`Transaction ${transaction} is not a Fee Payer transaction`);\n    }\n\n    // Set the feePayerAddress to the signer account address\n    transaction.feePayerAddress = signer.accountAddress;\n\n    return signTransaction({\n      signer,\n      transaction,\n    });\n  }\n}\n"],"mappings":"u4DAcO,IAAMA,EAAN,KAAW,CAuBhB,YAAYC,EAAwB,CAClC,KAAK,OAASA,CAChB,CAwCA,YAAYC,EAAiF,CAC3F,OAAOC,EAAgB,CACrB,GAAGD,CACL,CAAC,CACH,CAyCA,sBAAsBA,EAAiF,CACrG,GAAM,CAAE,OAAAE,EAAQ,YAAAC,CAAY,EAAIH,EAIhC,GAAI,CAACG,EAAY,gBACf,MAAM,IAAI,MAAM,eAAeA,CAAW,iCAAiC,EAI7E,OAAAA,EAAY,gBAAkBD,EAAO,eAE9BD,EAAgB,CACrB,OAAAC,EACA,YAAAC,CACF,CAAC,CACH,CACF","names":["Sign","config","args","signTransaction","signer","transaction"]}