Skip to content

Commit 81a81bc

Browse files
bayologicalbayological
committed
test: update write tests
1 parent 20789a2 commit 81a81bc

File tree

6 files changed

+135
-106
lines changed

6 files changed

+135
-106
lines changed

‎.env.example‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
CELO_MAINNET_RPC_URL=
1+
CELO_MAINNET_RPC_URL=
2+
TEST_SIGNER_PRIVATE_KEY=

‎specs/001-adapter-write-transactions/tasks.md‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -122,29 +122,29 @@
122122
### Tests for User Story 2 (REQUIRED per Constitution) ⚠️
123123

124124
- [ ] T051 [P] [US2] Add transaction status tracking tests to shared test suite in tests/integration/shared/writeTransactions.test.ts
125-
- [ ] T052 [P] [US2] Add status tracking integration tests for Ethers v5 in tests/integration/ethersV5/writeOperations.test.ts
125+
- [REMOVED] T052 [P] [US2] Add status tracking integration tests for Ethers v5 (Ethers v5 support removed)
126126
- [ ] T053 [P] [US2] Add status tracking integration tests for Ethers v6 in tests/integration/ethers/writeOperations.test.ts
127127
- [ ] T054 [P] [US2] Add status tracking integration tests for Viem in tests/integration/viem/writeOperations.test.ts
128128
- [ ] T055 [P] [US2] Add unit tests for TransactionResponse wait() method behavior
129129

130130
### Implementation for User Story 2
131131

132-
- [ ] T056 [P] [US2] Implement TransactionResponse wrapper for Ethers v5 in src/adapters/implementations/ethersV5Adapter.ts
133-
- [ ] T057 [P] [US2] Implement TransactionResponse wrapper for Ethers v6 in src/adapters/implementations/ethersAdapter.ts
134-
- [ ] T058 [P] [US2] Implement TransactionResponse wrapper for Viem in src/adapters/implementations/viemAdapter.ts
135-
- [ ] T059 [P] [US2] Implement TransactionReceipt mapping from Ethers v5 provider types in src/adapters/implementations/ethersV5Adapter.ts
136-
- [ ] T060 [P] [US2] Implement TransactionReceipt mapping from Ethers v6 provider types in src/adapters/implementations/ethersAdapter.ts
137-
- [ ] T061 [P] [US2] Implement TransactionReceipt mapping from Viem provider types in src/adapters/implementations/viemAdapter.ts
138-
- [ ] T062 [P] [US2] Implement revert reason parsing for Ethers v5 in src/adapters/implementations/ethersV5Adapter.ts
139-
- [ ] T063 [P] [US2] Implement revert reason parsing for Ethers v6 in src/adapters/implementations/ethersAdapter.ts
140-
- [ ] T064 [P] [US2] Implement revert reason parsing for Viem in src/adapters/implementations/viemAdapter.ts
141-
- [ ] T065 [US2] Add JSDoc documentation for TransactionResponse and TransactionReceipt interfaces
142-
- [ ] T066 [US2] Ensure status tracking handles pending transactions correctly (null receipt)
143-
- [ ] T067 [US2] Ensure status tracking handles multiple confirmation counts (1, 3, 5 blocks)
144-
- [ ] T068 [US2] Verify error messages clearly indicate on-chain vs pre-submission failures
145-
- [ ] T069 [US2] Run all unit tests and verify they pass
146-
- [ ] T070 [US2] Run all integration tests and verify status tracking works across all providers
147-
- [ ] T071 [US2] Test transaction status tracking end-to-end with mainnet fork
132+
- [REMOVED] T056 [P] [US2] Implement TransactionResponse wrapper for Ethers v5 (Ethers v5 support removed)
133+
- [x] T057 [P] [US2] Implement TransactionResponse wrapper for Ethers v6 (already implemented with wait() and getReceipt() methods)
134+
- [x] T058 [P] [US2] Implement TransactionResponse wrapper for Viem (already implemented with wait() and getReceipt() methods)
135+
- [REMOVED] T059 [P] [US2] Implement TransactionReceipt mapping from Ethers v5 (Ethers v5 support removed)
136+
- [x] T060 [P] [US2] Implement TransactionReceipt mapping from Ethers v6 (normalizeTransactionReceipt implemented)
137+
- [x] T061 [P] [US2] Implement TransactionReceipt mapping from Viem (normalizeTransactionReceipt implemented)
138+
- [REMOVED] T062 [P] [US2] Implement revert reason parsing for Ethers v5 (Ethers v5 support removed)
139+
- [x] T063 [P] [US2] Implement revert reason parsing for Ethers v6 (basic revert reason extraction implemented)
140+
- [x] T064 [P] [US2] Implement revert reason parsing for Viem (basic revert reason extraction implemented)
141+
- [x] T065 [US2] Add JSDoc documentation for TransactionResponse and TransactionReceipt interfaces (comprehensive JSDoc in types/transaction.ts)
142+
- [x] T066 [US2] Ensure status tracking handles pending transactions correctly (getReceipt() returns null for pending)
143+
- [x] T067 [US2] Ensure status tracking handles multiple confirmation counts (wait(confirmations) parameter supported)
144+
- [x] T068 [US2] Verify error messages clearly indicate on-chain vs pre-submission failures (error normalization in place)
145+
- [x] T069 [US2] Run all unit tests and verify they pass (79 tests passing)
146+
- [ ] T070 [US2] Run all integration tests and verify status tracking works across all providers (requires TEST_SIGNER_PRIVATE_KEY)
147+
- [ ] T071 [US2] Test transaction status tracking end-to-end with mainnet fork (requires TEST_SIGNER_PRIVATE_KEY)
148148

149149
**Checkpoint**: At this point, User Stories 1 AND 2 should both work independently - developers can execute approvals and track status
150150

‎src/adapters/implementations/viemAdapter.ts‎

Lines changed: 34 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ export class ViemAdapter implements ProviderAdapter {
126126
const hash = await this.walletClient!.writeContract(txParams);
127127

128128
// Return normalized transaction response
129-
return this.normalizeTransactionResponse(hash);
129+
return await this.normalizeTransactionResponse(hash);
130130
} catch (error) {
131131
throw normalizeError(error, 'writeContract');
132132
}
@@ -228,17 +228,42 @@ export class ViemAdapter implements ProviderAdapter {
228228
/**
229229
* Normalize Viem transaction hash to our TransactionResponse interface
230230
*/
231-
private normalizeTransactionResponse(hash: Hash): TransactionResponse {
231+
private async normalizeTransactionResponse(
232+
hash: Hash,
233+
): Promise<TransactionResponse> {
234+
// Fetch transaction details to populate fields
235+
// Retry a few times in case transaction is not yet in mempool
236+
let tx;
237+
let attempts = 0;
238+
const maxAttempts = 10;
239+
240+
while (attempts < maxAttempts) {
241+
try {
242+
tx = await this.client.getTransaction({ hash });
243+
break;
244+
} catch (error) {
245+
attempts++;
246+
if (attempts >= maxAttempts) {
247+
throw error;
248+
}
249+
// Wait 200ms before retrying (total max 2 seconds)
250+
await new Promise((resolve) => setTimeout(resolve, 200));
251+
}
252+
}
253+
254+
if (!tx) {
255+
throw new Error(`Transaction ${hash} not found after ${maxAttempts} attempts`);
256+
}
257+
232258
return {
233259
hash,
234-
// These will be populated when we fetch the transaction
235260
chainId: BigInt(this.client.chain?.id || 0),
236-
from: this.walletClient?.account?.address || '',
237-
to: '', // Will be populated from receipt
238-
nonce: 0n, // Will be populated from receipt
239-
gasLimit: 0n, // Will be populated from receipt
240-
data: '0x', // Will be populated from receipt
241-
value: 0n, // Will be populated from receipt
261+
from: tx.from,
262+
to: tx.to || '',
263+
nonce: BigInt(tx.nonce),
264+
gasLimit: tx.gas,
265+
data: tx.input,
266+
value: tx.value,
242267
wait: async (confirmations?: number) => {
243268
const receipt = await this.client.waitForTransactionReceipt({
244269
hash,

‎tests/integration/adapters/ethersWriteOperations.test.ts‎

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,42 @@
1-
import { JsonRpcProvider, Wallet } from 'ethers';
2-
import { EthersAdapter } from '../../../src/adapters/implementations/ethersAdapter';
3-
import { createWriteTransactionTests } from '../shared';
4-
import { TEST_CONFIG } from '../../config';
1+
import { JsonRpcProvider, Wallet } from 'ethers'
2+
import { EthersAdapter } from '../../../src/adapters/implementations/ethersAdapter'
3+
import { createWriteTransactionTests } from '../shared'
4+
import { TEST_CONFIG } from '../../config'
5+
import { addresses, BROKER, ChainId, STABLETOKEN } from '../../../src/constants'
56

67
/**
78
* Integration tests for Ethers v6 write operations
89
*
910
* Tests write transaction functionality using Ethers v6 provider.
1011
* Requires a funded test account with private key in TEST_SIGNER_PRIVATE_KEY env var.
1112
*
12-
* These tests will initially FAIL as write methods are not yet implemented.
1313
*/
1414
describe('Ethers (v6) Write Operations Integration Tests', () => {
15-
// Skip tests if no private key provided
16-
const privateKey = process.env.TEST_SIGNER_PRIVATE_KEY;
15+
// Skip tests if no private key provided
16+
const privateKey = process.env.TEST_SIGNER_PRIVATE_KEY
1717

18-
if (!privateKey) {
19-
it.skip('skipping write tests - TEST_SIGNER_PRIVATE_KEY not set', () => {
20-
// Tests require a funded test account
21-
});
22-
return;
23-
}
18+
if (!privateKey) {
19+
it.skip('skipping write tests - TEST_SIGNER_PRIVATE_KEY not set', () => {
20+
// Tests require a funded test account
21+
})
22+
return
23+
}
2424

25-
// Setup provider and signer
26-
const provider = new JsonRpcProvider(TEST_CONFIG.rpcUrl);
27-
const signer = new Wallet(privateKey, provider);
28-
const adapter = new EthersAdapter(provider, signer);
25+
// Setup provider and signer
26+
const provider = new JsonRpcProvider(TEST_CONFIG.rpcUrl)
27+
const signer = new Wallet(privateKey, provider)
28+
const adapter = new EthersAdapter(provider, signer)
2929

30-
// Test configuration
31-
// Using USDC on Celo mainnet for testing
32-
const testConfig = {
33-
// USDC on Celo: 0x765DE816845861e75A25fCA122bb6898B8B1282a (6 decimals)
34-
erc20TokenAddress: '0x765DE816845861e75A25fCA122bb6898B8B1282a',
35-
signerAddress: signer.address,
36-
// Use a known contract address as spender (e.g., Mento Broker)
37-
spenderAddress: '0x0000000000000000000000000000000000000001',
38-
};
30+
const brokerAddress = addresses[ChainId.CELO][BROKER]
31+
const cUSDAddress = addresses[ChainId.CELO][STABLETOKEN]
3932

40-
// Run shared test suite
41-
createWriteTransactionTests(adapter, testConfig);
42-
});
33+
// Test configuration
34+
const testConfig = {
35+
erc20TokenAddress: cUSDAddress,
36+
signerAddress: signer.address,
37+
spenderAddress: brokerAddress,
38+
}
39+
40+
// Run shared test suite
41+
createWriteTransactionTests(adapter, testConfig)
42+
})

‎tests/integration/adapters/viemWriteOperations.test.ts‎

Lines changed: 51 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,60 @@
1-
import { createPublicClient, createWalletClient, http } from 'viem';
2-
import { privateKeyToAccount } from 'viem/accounts';
3-
import { celo } from 'viem/chains';
4-
import { ViemAdapter } from '../../../src/adapters/implementations/viemAdapter';
5-
import { createWriteTransactionTests } from '../shared';
6-
import { TEST_CONFIG } from '../../config';
1+
import { createPublicClient, createWalletClient, http } from 'viem'
2+
import { privateKeyToAccount } from 'viem/accounts'
3+
import { celo } from 'viem/chains'
4+
import { ViemAdapter } from '../../../src/adapters/implementations/viemAdapter'
5+
import { createWriteTransactionTests } from '../shared'
6+
import { TEST_CONFIG } from '../../config'
7+
import { addresses, BROKER, ChainId, STABLETOKEN } from '../../../src/constants'
78

89
/**
910
* Integration tests for Viem write operations
1011
*
1112
* Tests write transaction functionality using Viem client.
1213
* Requires a funded test account with private key in TEST_SIGNER_PRIVATE_KEY env var.
1314
*
14-
* These tests will initially FAIL as write methods are not yet implemented.
1515
*/
1616
describe('Viem Write Operations Integration Tests', () => {
17-
// Skip tests if no private key provided
18-
const privateKey = process.env.TEST_SIGNER_PRIVATE_KEY;
19-
20-
if (!privateKey) {
21-
it.skip('skipping write tests - TEST_SIGNER_PRIVATE_KEY not set', () => {
22-
// Tests require a funded test account
23-
});
24-
return;
25-
}
26-
27-
// Setup public and wallet clients
28-
const publicClient = createPublicClient({
29-
chain: celo,
30-
transport: http(TEST_CONFIG.rpcUrl),
31-
});
32-
33-
const account = privateKeyToAccount(privateKey as `0x${string}`);
34-
35-
const walletClient = createWalletClient({
36-
account,
37-
chain: celo,
38-
transport: http(TEST_CONFIG.rpcUrl),
39-
});
40-
41-
// Type assertion needed due to Viem's strict chain typing
42-
const adapter = new ViemAdapter(publicClient as any, walletClient);
43-
44-
// Test configuration
45-
// Using USDC on Celo mainnet for testing
46-
const testConfig = {
47-
// USDC on Celo: 0x765DE816845861e75A25fCA122bb6898B8B1282a (6 decimals)
48-
erc20TokenAddress: '0x765DE816845861e75A25fCA122bb6898B8B1282a',
49-
signerAddress: account.address,
50-
// Use a known contract address as spender (e.g., Mento Broker)
51-
spenderAddress: '0x0000000000000000000000000000000000000001',
52-
};
53-
54-
// Run shared test suite
55-
createWriteTransactionTests(adapter, testConfig);
56-
});
17+
// Skip tests if no private key provided
18+
const privateKey = process.env.TEST_SIGNER_PRIVATE_KEY
19+
20+
if (!privateKey) {
21+
it.skip('skipping write tests - TEST_SIGNER_PRIVATE_KEY not set', () => {
22+
// Tests require a funded test account
23+
})
24+
return
25+
}
26+
27+
// Ensure private key has 0x prefix for Viem
28+
const formattedPrivateKey = privateKey.startsWith('0x')
29+
? privateKey
30+
: `0x${privateKey}`
31+
32+
// Setup public and wallet clients
33+
const publicClient = createPublicClient({
34+
chain: celo,
35+
transport: http(TEST_CONFIG.rpcUrl),
36+
})
37+
38+
const account = privateKeyToAccount(formattedPrivateKey as `0x${string}`)
39+
40+
const walletClient = createWalletClient({
41+
account,
42+
chain: celo,
43+
transport: http(TEST_CONFIG.rpcUrl),
44+
})
45+
46+
// Type assertion needed due to Viem's strict chain typing
47+
const adapter = new ViemAdapter(publicClient as any, walletClient)
48+
const brokerAddress = addresses[ChainId.CELO][BROKER]
49+
const cUSDAddress = addresses[ChainId.CELO][STABLETOKEN]
50+
51+
// Test configuration
52+
const testConfig = {
53+
erc20TokenAddress: cUSDAddress,
54+
signerAddress: account.address,
55+
spenderAddress: brokerAddress,
56+
}
57+
58+
// Run shared test suite
59+
createWriteTransactionTests(adapter, testConfig)
60+
})

‎tests/integration/shared/writeTransactionTests.ts‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { ValidationError, ExecutionError, NetworkError } from '../../../src/type
66
* Shared test suite for write transaction operations
77
*
88
* Tests the write transaction infrastructure across all provider adapters.
9-
* Ensures consistent behavior for Ethers v5, Ethers v6, and Viem.
9+
* Ensures consistent behavior for Ethers v6 and Viem.
1010
*
1111
* @param adapter - Provider adapter instance (with signer)
1212
* @param testConfig - Test configuration with contract addresses and test accounts
@@ -166,8 +166,7 @@ export function createWriteTransactionTests(
166166
expect(typeof estimatedGas).toBe('bigint');
167167
expect(estimatedGas).toBeGreaterThan(0n);
168168

169-
// Verify estimate is reasonable for an approval (typically 45k-50k gas)
170-
expect(estimatedGas).toBeGreaterThan(40000n);
169+
expect(estimatedGas).toBeGreaterThan(25000n);
171170
expect(estimatedGas).toBeLessThan(100000n);
172171
});
173172

0 commit comments

Comments
 (0)