@moveindustries/ts-sdk 5.1.4

package/src/transactions/instances/signedTransaction.ts

@@ -0,0 +1,73 @@
+// Copyright © Move Industries
+// SPDX-License-Identifier: Apache-2.0
+
+/* eslint-disable @typescript-eslint/naming-convention */
+
+import { Deserializer } from "../../bcs/deserializer";
+import { Serializable, Serializer } from "../../bcs/serializer";
+import { TransactionAuthenticator } from "../authenticator/transaction";
+import { RawTransaction } from "./rawTransaction";
+
+/**
+ * Represents a signed transaction that includes a raw transaction and an authenticator.
+ * The authenticator contains a client's public key and the signature of the raw transaction.
+ *
+ * @see {@link https://movement.dev/integration/creating-a-signed-transaction | Creating a Signed Transaction}
+ * @param raw_txn - The raw transaction to be signed.
+ * @param authenticator - Contains a client's public key and the signature of the raw transaction.
+ * Authenticator can have three variations: single signature, multi-signature, and multi-agent.
+ * @see {@link https://github.com/aptos-labs/aptos-core/blob/main/types/src/transaction/authenticator.rs} for details.
+ * @group Implementation
+ * @category Transactions
+ */
+export class SignedTransaction extends Serializable {
+  public readonly raw_txn: RawTransaction;
+
+  public readonly authenticator: TransactionAuthenticator;
+
+  /**
+   * Represents a signed transaction that includes a raw transaction and an authenticator.
+   * The authenticator contains a client's public key and the signature of the raw transaction,
+   * which can be of three types: single signature, multi-signature, and multi-agent.
+   *
+   * @param raw_txn The raw transaction to be signed.
+   * @param authenticator Contains a client's public key and the signature of the raw transaction. The authenticator has 3
+   * flavors: single signature, multi-signature and multi-agent.
+   * @see {@link https://movement.dev/integration/creating-a-signed-transaction | Creating a Signed Transaction}
+   * @see {@link https://github.com/aptos-labs/aptos-core/blob/main/types/src/transaction/authenticator.rs} for details.
+   * @group Implementation
+   * @category Transactions
+   */
+  constructor(raw_txn: RawTransaction, authenticator: TransactionAuthenticator) {
+    super();
+    this.raw_txn = raw_txn;
+    this.authenticator = authenticator;
+  }
+
+  /**
+   * Serializes the raw transaction and its authenticator using the provided serializer.
+   * This function is essential for preparing the transaction data for transmission or storage.
+   *
+   * @param serializer - The serializer instance used to serialize the transaction and authenticator.
+   * @group Implementation
+   * @category Transactions
+   */
+  serialize(serializer: Serializer): void {
+    this.raw_txn.serialize(serializer);
+    this.authenticator.serialize(serializer);
+  }
+
+  /**
+   * Deserializes a signed transaction from the provided deserializer.
+   * This function allows you to reconstruct a SignedTransaction object from its serialized form, enabling further processing or validation.
+   *
+   * @param deserializer - The deserializer instance used to read the serialized data.
+   * @group Implementation
+   * @category Transactions
+   */
+  static deserialize(deserializer: Deserializer): SignedTransaction {
+    const raw_txn = RawTransaction.deserialize(deserializer);
+    const authenticator = TransactionAuthenticator.deserialize(deserializer);
+    return new SignedTransaction(raw_txn, authenticator);
+  }
+}

package/src/transactions/instances/simpleTransaction.ts

@@ -0,0 +1,83 @@
+// Copyright © Move Industries
+// SPDX-License-Identifier: Apache-2.0
+
+/* eslint-disable @typescript-eslint/naming-convention */
+
+import { Deserializer } from "../../bcs/deserializer";
+import { Serializable, Serializer } from "../../bcs/serializer";
+import { AccountAddress } from "../../core";
+import { RawTransaction } from "./rawTransaction";
+
+/**
+ * Represents a simple transaction type that can be submitted to the Movement chain for execution.
+ *
+ * This transaction type is designed for a single signer and includes metadata such as the Raw Transaction
+ * and an optional sponsor Account Address to cover gas fees.
+ *
+ * @param rawTransaction - The Raw Transaction.
+ * @param feePayerAddress - The optional sponsor Account Address.
+ * @group Implementation
+ * @category Transactions
+ */
+export class SimpleTransaction extends Serializable {
+  public rawTransaction: RawTransaction;
+
+  public feePayerAddress?: AccountAddress | undefined;
+
+  // We don't really need it, we add it for type checking we do
+  // throughout the SDK
+  public readonly secondarySignerAddresses: undefined;
+
+  /**
+   * SimpleTransaction represents a transaction signed by a single account that
+   * can be submitted to the Movement chain for execution.
+   *
+   * @param rawTransaction The Raw Transaction.
+   * @param feePayerAddress The optional sponsor Account Address to pay the gas fees.
+   * @group Implementation
+   * @category Transactions
+   */
+  constructor(rawTransaction: RawTransaction, feePayerAddress?: AccountAddress) {
+    super();
+    this.rawTransaction = rawTransaction;
+    this.feePayerAddress = feePayerAddress;
+  }
+
+  /**
+   * Serializes the transaction data using the provided serializer.
+   * This function ensures that the raw transaction and fee payer address are properly serialized for further processing.
+   *
+   * @param serializer - The serializer instance used to serialize the transaction data.
+   * @group Implementation
+   * @category Transactions
+   */
+  serialize(serializer: Serializer): void {
+    this.rawTransaction.serialize(serializer);
+
+    if (this.feePayerAddress === undefined) {
+      serializer.serializeBool(false);
+    } else {
+      serializer.serializeBool(true);
+      this.feePayerAddress.serialize(serializer);
+    }
+  }
+
+  /**
+   * Deserializes a SimpleTransaction from the given deserializer.
+   * This function helps in reconstructing a SimpleTransaction object from its serialized form.
+   *
+   * @param deserializer - The deserializer instance used to read the serialized data.
+   * @group Implementation
+   * @category Transactions
+   */
+  static deserialize(deserializer: Deserializer): SimpleTransaction {
+    const rawTransaction = RawTransaction.deserialize(deserializer);
+    const feePayerPresent = deserializer.deserializeBool();
+    let feePayerAddress;
+    if (feePayerPresent) {
+      feePayerAddress = AccountAddress.deserialize(deserializer);
+    }
+
+    return new SimpleTransaction(rawTransaction, feePayerAddress);
+  }
+}

package/src/transactions/instances/transactionArgument.ts

@@ -0,0 +1,79 @@
+// Copyright © Move Industries
+// SPDX-License-Identifier: Apache-2.0
+
+import { Serializer } from "../../bcs/serializer";
+import { Hex } from "../../core/hex";
+
+export interface TransactionArgument extends EntryFunctionArgument, ScriptFunctionArgument { }
+
+/**
+ * Represents an argument for entry functions, providing methods to serialize the argument
+ * to BCS-serialized bytes and convert it to different formats.
+ * @group Implementation
+ * @category Transactions
+ */
+export interface EntryFunctionArgument {
+  /**
+   * Serialize an argument to BCS-serialized bytes.
+   *
+   * @param serializer - The serializer instance used for serialization.
+   * @group Implementation
+   * @category Transactions
+   */
+  serialize(serializer: Serializer): void;
+
+  /**
+   * Serialize an argument to BCS-serialized bytes.
+   * Serialize an argument as a type-agnostic, fixed byte sequence. The byte sequence contains
+   * the number of the following bytes followed by the BCS-serialized bytes for a typed argument.
+   *
+   * @param serializer - The serializer used to convert the argument.
+   * @group Implementation
+   * @category Transactions
+   */
+  serializeForEntryFunction(serializer: Serializer): void;
+
+  /**
+   * Convert the argument to BCS-serialized bytes.
+   *
+   * @returns Uint8Array representing the BCS-serialized bytes of the argument.
+   * @group Implementation
+   * @category Transactions
+   */
+  bcsToBytes(): Uint8Array;
+
+  /**
+   * Converts the BCS-serialized bytes of an argument into a hexadecimal representation.
+   * This function is useful for obtaining a Hex instance that encapsulates the BCS-serialized bytes,
+   * allowing for easier manipulation and representation of the data.
+   * @returns A Hex instance containing the BCS-serialized bytes.
+   * @group Implementation
+   * @category Transactions
+   */
+  bcsToHex(): Hex;
+}
+
+/**
+ * Represents an argument for script functions, providing methods to serialize and convert to bytes.
+ * @group Implementation
+ * @category Transactions
+ */
+export interface ScriptFunctionArgument {
+  /**
+   * Serialize an argument to BCS-serialized bytes.
+   * @group Implementation
+   * @category Transactions
+   */
+  serialize(serializer: Serializer): void;
+  /**
+   * Serialize an argument to BCS-serialized bytes as a type aware byte sequence.
+   * The byte sequence contains an enum variant index followed by the BCS-serialized
+   * bytes for a typed argument.
+   * @group Implementation
+   * @category Transactions
+   */
+  serializeForScriptFunction(serializer: Serializer): void;
+
+  bcsToBytes(): Uint8Array;
+  bcsToHex(): Hex;
+}