feat(txm): transactions with value

apps/docs/src/pages/txm/getting-started.mdx

@@ -182,4 +182,8 @@ const hookHandler: TxmHookHandler = (tx: Transaction) => {
 }
 
 txm.addHook(TxmHookType.OnStatusChange, hookHandler)
-```
+<<<<<<< HEAD
+```
+=======
+```
+>>>>>>> e24f8b15 (fix: docs)

contracts/package.json

@@ -28,11 +28,10 @@
         "solady": "0.0.237"
     },
     "devDependencies": {
-        "@happy.tech/happybuild": "workspace:0.1.1",
         "@happy.tech/configs": "workspace:0.1.0",
+        "@happy.tech/happybuild": "workspace:0.1.1",
         "@openzeppelin/upgrades-core": "^1.36.0",
         "@types/node": "^22.0.2",
-        "node-jq": "^6.0.1",
         "permissionless": "^0.2.0",
         "solhint": "^5.0.5",
         "viem": "^2.21.53"

packages/txm/lib/GasEstimator.ts

@@ -73,7 +73,7 @@ export class DefaultGasLimitEstimator implements GasEstimator {
             account: transactionManager.viemWallet.account,
             to: transaction.address,
             data: transaction.calldata,
-            value: 0n,
+            value: transaction.value,
         })
 
         if (gasResult.isErr()) {

packages/txm/lib/Transaction.ts

@@ -1,4 +1,4 @@
-import { type Hex, type UUID, bigIntReplacer, bigIntReviver, createUUID } from "@happy.tech/common"
+import { type Hex, type UUID, bigIntReplacer, bigIntReviver, bigIntToZeroPadded, createUUID } from "@happy.tech/common"
 import { context, trace } from "@opentelemetry/api"
 import type { Insertable, Selectable } from "kysely"
 import { type Address, type ContractFunctionArgs, type Hash, encodeFunctionData } from "viem"
@@ -67,6 +67,11 @@ interface TransactionConstructorBaseConfig {
      * The address of the contract that will be called
      */
     address: Address
+    /**
+     * The value of the transaction in wei
+     * Defaults to 0n
+     */
+    value?: bigint
     /**
      * The deadline of the transaction in seconds (optional)
      * This is used to try to cancel the transaction if it is not included in a block after the deadline to save gas
@@ -111,6 +116,8 @@ export class Transaction {
 
     readonly calldata: Hex
 
+    readonly value: bigint
+
     readonly deadline: number | undefined
 
     status: TransactionStatus
@@ -158,6 +165,7 @@ export class Transaction {
         this.from = config.from
         this.chainId = config.chainId
         this.address = config.address
+        this.value = config.value ?? 0n
         this.deadline = config.deadline
         this.status = config.status ?? TransactionStatus.Pending
         this.attempts = config.attempts ?? []
@@ -270,6 +278,7 @@ export class Transaction {
             address: this.address,
             functionName: this.functionName,
             contractName: this.contractName,
+            value: bigIntToZeroPadded(this.value), // We convert the bigint value to a zero-padded string because 'value' can exceed the numeric limits of Number
             calldata: this.calldata,
             args: this.args ? JSON.stringify(this.args, bigIntReplacer) : undefined,
             deadline: this.deadline,
@@ -286,6 +295,7 @@ export class Transaction {
         return new Transaction(
             {
                 ...row,
+                value: BigInt(row.value),
                 args: row.args ? JSON.parse(row.args, bigIntReviver) : undefined,
                 attempts: JSON.parse(row.attempts, bigIntReviver),
                 collectionBlock: row.collectionBlock ? BigInt(row.collectionBlock) : undefined,

packages/txm/lib/TransactionManager.ts

@@ -122,7 +122,7 @@ export type TransactionManagerConfig = {
     /** The private key of the account used for signing transactions. */
     privateKey: Hex
 
-    gas: {
+    gas?: {
         /** Optional EIP-1559 parameters. If not provided, defaults to the OP stack's stock parameters. */
         eip1559?: EIP1559Parameters
         /**
@@ -179,7 +179,7 @@ export type TransactionManagerConfig = {
      * This is a record of aliases to ABIs. The aliases are used to reference the ABIs in the
      * transactions.
      */
-    abis: Record<string, Abi>
+    abis?: Record<string, Abi>
 
     /**
      * The expected interval (in seconds) for the creation of a new block on the blockchain.
@@ -402,14 +402,14 @@ export class TransactionManager {
         this.rpcLivenessMonitor = new RpcLivenessMonitor(this)
 
         this.chainId = _config.chainId
-        this.eip1559 = _config.gas.eip1559 ?? opStackDefaultEIP1559Parameters
-        this.abiManager = new ABIManager(_config.abis)
-
-        this.baseFeeMargin = _config.gas.baseFeePercentageMargin ?? 20n
-        this.maxPriorityFeePerGas = _config.gas.maxPriorityFeePerGas
-        this.minPriorityFeePerGas = _config.gas.minPriorityFeePerGas
-        this.priorityFeeTargetPercentile = _config.gas.priorityFeeTargetPercentile ?? 50
-        this.priorityFeeAnalysisBlocks = _config.gas.priorityFeeAnalysisBlocks ?? 2
+        this.eip1559 = _config.gas?.eip1559 ?? opStackDefaultEIP1559Parameters
+        this.abiManager = new ABIManager(_config.abis ?? {})
+
+        this.baseFeeMargin = _config.gas?.baseFeePercentageMargin ?? 20n
+        this.maxPriorityFeePerGas = _config.gas?.maxPriorityFeePerGas
+        this.minPriorityFeePerGas = _config.gas?.minPriorityFeePerGas
+        this.priorityFeeTargetPercentile = _config.gas?.priorityFeeTargetPercentile ?? 50
+        this.priorityFeeAnalysisBlocks = _config.gas?.priorityFeeAnalysisBlocks ?? 2
 
         this.rpcAllowDebug = _config.rpc.allowDebug ?? false
         this.blockTime = _config.blockTime ?? 2n

packages/txm/lib/TransactionSubmitter.ts

@@ -128,7 +128,7 @@ export class TransactionSubmitter {
                 from: this.txmgr.viemWallet.account.address,
                 to: transaction.address,
                 data: transaction.calldata,
-                value: 0n,
+                value: transaction.value,
                 nonce: attempt.nonce,
                 maxFeePerGas: attempt.maxFeePerGas,
                 maxPriorityFeePerGas: attempt.maxPriorityFeePerGas,

packages/txm/lib/db/migrations/Migration20250421120000.ts

@@ -0,0 +1,8 @@
+import type { Kysely } from "kysely"
+import type { Database } from "../types"
+
+export async function up(db: Kysely<Database>) {
+    await db.schema.alterTable("transaction").addColumn("value", "text").execute()
+}
+
+export const migration20250421120000 = { up }

packages/txm/lib/db/migrations/index.ts

@@ -3,11 +3,13 @@ import { migration20241111223000 } from "./Migration20241111223000"
 import { migration20241205104400 } from "./Migration20241205104400"
 import { migration20250121110600 } from "./Migration20250121110600"
 import { migration20250410123000 } from "./Migration20250410123000"
+import { migration20250421120000 } from "./Migration20250421120000"
 
 export const migrations = {
     "20241111163800": migration20241111163800,
     "20241111223000": migration20241111223000,
     "20241205104400": migration20241205104400,
     "20250121110600": migration20250121110600,
     "20250410123000": migration20250410123000,
+    "20250421120000": migration20250421120000,
 }

packages/txm/lib/db/types.ts

@@ -7,6 +7,7 @@ export interface TransactionTable {
     from: Address
     chainId: number
     address: Address
+    value: string
     functionName: string | undefined
     args: string | undefined
     contractName: string | undefined

packages/txm/test/txm.test.ts

@@ -35,6 +35,7 @@ import {
 import { deployMockContracts } from "./utils/contracts"
 import { assertIsDefined, assertIsOk, assertReceiptReverted, assertReceiptSuccess } from "./utils/customAsserts"
 import { cleanDB, getPersistedTransaction } from "./utils/db"
+import { bigIntToZeroPadded } from "@happy.tech/common"
 
 const retryManager = new TestRetryManager()
 
@@ -612,6 +613,42 @@ test("Transaction cancelled due to deadline passing", async () => {
     })
 })
 
+test("Execute a transaction with value", async () => {
+    const value = BigInt(1000)
+    const transactionToSend = await txm.createTransaction({
+        address: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
+        calldata: "0x",
+        value,
+    })
+
+    transactionQueue.push(transactionToSend)
+
+    await mineBlock(2)
+
+    const transactionExecuted = await txm.getTransaction(transactionToSend.intentId)
+
+    if (!assertIsOk(transactionExecuted)) return
+
+    const transactionExecutedValue = transactionExecuted.value
+
+    if (!assertIsDefined(transactionExecutedValue)) return
+
+    const blockchainTransaction = await directBlockchainClient.getTransaction({
+        hash: transactionExecutedValue.attempts[0].hash,
+    })
+
+    const blockchainTransactionReceipt = await directBlockchainClient.getTransactionReceipt({
+        hash: blockchainTransaction.hash,
+    })
+
+    const persistedTransaction = await getPersistedTransaction(transactionToSend.intentId)
+
+    expect(blockchainTransactionReceipt?.status).toBe("success")
+    expect(blockchainTransaction.value).toBe(value)
+    expect(persistedTransaction).toBeDefined()
+    expect(persistedTransaction?.value).toBe(bigIntToZeroPadded(value))
+})
+
 test("Correctly calculates baseFeePerGas after a block with high gas usage", async () => {
     const transactionBurner = await txm.createTransaction({
         address: deployment.MockGasBurner,
@@ -885,4 +922,4 @@ test("RPC liveness monitor works correctly", async () => {
         value: previousLivenessWindow,
         configurable: true,
     })
-})
+})

support/common/lib/utils/bigint.ts

@@ -31,9 +31,19 @@ export const bigIntReviver = (_key: string, value: unknown): unknown => {
 }
 
 /**
- * Converts a bigint to a zero-padded string
+ * The maximum number of digits in the max uint256 value
  */
-export function bigIntToZeroPadded(value: bigint, totalDigits: number): string {
+export const DIGITS_MAX_UINT256 = 78
+
+/**
+ * Converts a bigint to a zero-padded string representation
+ * @param value - The bigint value to convert
+ * @param totalDigits - The total number of digits in the resulting string (defaults to {@link DIGITS_MAX_UINT256})
+ * @returns A string representation of the bigint with leading zeros to match the specified length
+ * @example
+ * bigIntToZeroPadded(123n, 5) // returns "00123"
+ */
+export function bigIntToZeroPadded(value: bigint, totalDigits: number = DIGITS_MAX_UINT256): string {
     const str = value.toString()
     return str.padStart(totalDigits, "0")
 }