Txm no longer receives Viem objects by GabrielMartinezRodriguez · Pull Request #298 · HappyChainDevs/happychain

GabrielMartinezRodriguez · 2024-12-06T14:48:18Z

Linked issues

closes https://linear.app/happychain/issue/HAPPY-135/txmanager-add-timeouts-to-rpc-calls

Description

We aimed to configure a timeout for the RPC calls, but to achieve this, we ultimately decided not to expose viem objects in the TXM API. This ensures the TXM remains agnostic of the Web3 library we are using. For more context, please refer to the related issue

Toggle Checklist

Checklist

Basics

B1. I have applied the proper label & proper branch name (e.g. norswap/build-system-caching).
B2. This PR is not so big that it should be split & addresses only one concern.
B3. The PR targets the lowest branch it can (ideally master).

Correctness

C1. Builds and passes tests.
C2. The code is properly parameterized & compatible with different environments.
C3. I have manually tested my changes & connected features.
C4. I have performed a thorough self-review of my code after submitting the PR.

Architecture & Documentation

D1. I made it easy to reason locally about the code.
D2. All public-facing APIs & meaningful internal APIs are properly documented.
D3. If appropriate, the general architecture of the code is documented.

cloudflare-workers-and-pages · 2024-12-06T14:48:19Z

Deploying happychain with Cloudflare Pages

Latest commit:	`1b25f8b`
Status:	✅ Deploy successful!
Preview URL:	https://02f20aa0.happychain.pages.dev
Branch Preview URL:	https://gabriel-txm-timeout.happychain.pages.dev

View logs

GabrielMartinezRodriguez · 2024-12-06T14:48:45Z

Txm no longer receives Viem objects #298 : 2 dependent PRs (#299 , #300 ) 👈 (View in Graphite)
Add flush mechanism #289 : 1 other dependent PR (#297 )
Allow run multiple txm simultaneously within the same service #285
Added docs for txm #272
Mutex in tx monitor #264
Purge transactions #232
Txm hooks #229
Use kysely instead of mikro-orm #250
master

This stack of pull requests is managed by Graphite. Learn more about stacking.

linear · 2024-12-06T15:09:02Z

HAPPY-135 txmanager: Add timeouts to RPC calls

cf. #182 (comment)

aodhgan · 2024-12-09T19:51:29Z

-            transport: webSocket(),
-            chain: anvil,
+            privateKey: env.PRIVATE_KEY,
+            chainId: 31337,


suggestion: why dont we put the chainId in the env file?

Yup, let's do this!

not-reed · 2024-12-11T16:21:58Z

        this.blockTime = _config.blockTime || 2n
        this.finalizedTransactionPurgeTime = _config.finalizedTransactionPurgeTime || 2 * 60 * 1000
+
+        if ((timeout + retryDelay) * retries > this.blockTime * 1000n) {


maybe its me but this line feels like a lot to parse 😅

I'm pretty okay with it. Maybe:

const timePerRetry = timeout + retryDelay if (timePerRetry * retries > this.blockTime * 1000n) {

not-reed · 2024-12-11T16:23:31Z

+        let transport: ViemTransport
+        if (protocol.value === "http") {
+            transport = viemHttpTransport(_config.rpc.url, {
+                timeout,
+                retryCount: retries,
+                retryDelay,
+            })
+        } else {
+            transport = viemWebSocketTransport(_config.rpc.url, {
+                timeout,
+                retryCount: retries,
+                retryDelay,
+            })
+        }


might be nice to extract this to some utility

const transport = getViemTransport(protocol, _config.rpc)

I don't mind too much, it's only used here, and this is pretty simple function that is just a long list of things being initialized, so it's not like it pollutes reasoning about what's otherwise a complex flow.

not-reed · 2024-12-11T16:25:23Z

+        // Get the chain ID of the RPC node
+        const rpcChainIdPromise = this.viemClient.safeGetChainId()
+
        // Start the transaction repository
        await this.transactionRepository.start()

        // Start the nonce manager, which depends on the transaction repository
        await this.nonceManager.start()

+        const rpcChainId = await rpcChainIdPromise


why seperate rpcChainIdPromise like this?

const rpcChainId = await this.viemClient.safeGetChainId()

Latency optimization: kick off the call early, then do the initialization, then come back and wait until the id is there. Otherwise we would have to wait the entire network roundtrip for chainid without doing any useful work locally.

Yes, I do it this way for the reasons @norswap mentions

…er match

GabrielMartinezRodriguez mentioned this pull request Dec 6, 2024

Notify user if txm fails saving transactions #297

Merged

10 tasks

GabrielMartinezRodriguez changed the title ~~Simplify TransactionManager configuration~~ Txm no longer receives Viem objects Dec 6, 2024

GabrielMartinezRodriguez marked this pull request as ready for review December 6, 2024 15:09

GabrielMartinezRodriguez requested a review from norswap December 6, 2024 15:11

GabrielMartinezRodriguez added the reviewing-1 Ready for, or undergoing first-line review label Dec 6, 2024

This was referenced Dec 9, 2024

Add retry policy manager for failed transactions #299

Merged

Add SQLite persistence to randomness service #300

Merged

aodhgan reviewed Dec 9, 2024

View reviewed changes

This was referenced Dec 10, 2024

Refactors the randomness service to be able to process pending commitments #303

Merged

Add NewBlock hook #304

Merged

Only prune finalized randomness entries #305

Merged

not-reed reviewed Dec 11, 2024

View reviewed changes

GabrielMartinezRodriguez mentioned this pull request Dec 13, 2024

Random oracle contracts #307

Merged

10 tasks

GabrielMartinezRodriguez force-pushed the gabriel/flush-mechanism branch from 28048b1 to b3b5c1d Compare December 20, 2024 11:23

GabrielMartinezRodriguez force-pushed the gabriel/txm-timeout branch from 0f3cbd7 to 7bd3300 Compare December 20, 2024 11:30

GabrielMartinezRodriguez mentioned this pull request Dec 20, 2024

Submit drand numbers #318

Merged

10 tasks

GabrielMartinezRodriguez force-pushed the gabriel/flush-mechanism branch from b3b5c1d to 83842ef Compare December 26, 2024 10:14

GabrielMartinezRodriguez force-pushed the gabriel/txm-timeout branch from 7bd3300 to ade9e83 Compare December 26, 2024 10:14

This was referenced Dec 26, 2024

Script to easily launch the randomness service locally #324

Merged

Script to monitor randomness service #325

Merged

GabrielMartinezRodriguez force-pushed the gabriel/flush-mechanism branch from 83842ef to 2765c4e Compare January 6, 2025 15:31

GabrielMartinezRodriguez force-pushed the gabriel/txm-timeout branch from ade9e83 to ba1b173 Compare January 6, 2025 15:31

GabrielMartinezRodriguez force-pushed the gabriel/flush-mechanism branch from 2765c4e to e1e535a Compare January 7, 2025 09:50

GabrielMartinezRodriguez force-pushed the gabriel/txm-timeout branch from a599824 to 3674db3 Compare January 7, 2025 09:50

GabrielMartinezRodriguez force-pushed the gabriel/flush-mechanism branch from e1e535a to 6d6cd5c Compare January 7, 2025 09:55

Base automatically changed from gabriel/flush-mechanism to master January 7, 2025 10:13

GabrielMartinezRodriguez added 4 commits January 7, 2025 11:44

feat(txm): remove viem objects and allow configurable timeout

93e306e

chore(txm): check if rpc chain id and the chain id provided by the us…

53b315d

…er match

chore(randomnness): chain id moved to env

71e4631

chore(txm): improve txm warning calculation

1b25f8b

GabrielMartinezRodriguez force-pushed the gabriel/txm-timeout branch from 3674db3 to 1b25f8b Compare January 7, 2025 10:48

GabrielMartinezRodriguez merged commit 2bfefd5 into master Jan 7, 2025

GabrielMartinezRodriguez deleted the gabriel/txm-timeout branch January 7, 2025 10:52

This was referenced Feb 3, 2025

Add config contract #404

Merged

Deploy randomness service #416

Merged

This was referenced Feb 11, 2025

Added Interrupted status to transaction entity #434

Merged

debug #435

Closed

Implemented block inactivity timeout #441

Merged

GabrielMartinezRodriguez mentioned this pull request Feb 25, 2025

Fix: random() reverts once every 3 blocks #458

Merged

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Txm no longer receives Viem objects#298

Txm no longer receives Viem objects#298
GabrielMartinezRodriguez merged 4 commits into
masterfrom
gabriel/txm-timeout

GabrielMartinezRodriguez commented Dec 6, 2024 •

edited

Loading

Uh oh!

cloudflare-workers-and-pages Bot commented Dec 6, 2024 •

edited

Loading

Uh oh!

GabrielMartinezRodriguez commented Dec 6, 2024 •

edited

Loading

Uh oh!

linear Bot commented Dec 6, 2024

Uh oh!

aodhgan Dec 9, 2024

Uh oh!

norswap Jan 5, 2025

Uh oh!

not-reed Dec 11, 2024

Uh oh!

norswap Jan 5, 2025

Uh oh!

not-reed Dec 11, 2024

Uh oh!

norswap Jan 5, 2025

Uh oh!

not-reed Dec 11, 2024

Uh oh!

norswap Jan 5, 2025

Uh oh!

GabrielMartinezRodriguez Jan 6, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

GabrielMartinezRodriguez commented Dec 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Linked issues

Description

Checklist

Basics

Correctness

Architecture & Documentation

Uh oh!

cloudflare-workers-and-pages Bot commented Dec 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying happychain with Cloudflare Pages

Uh oh!

GabrielMartinezRodriguez commented Dec 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

linear Bot commented Dec 6, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GabrielMartinezRodriguez Jan 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

GabrielMartinezRodriguez commented Dec 6, 2024 •

edited

Loading

cloudflare-workers-and-pages Bot commented Dec 6, 2024 •

edited

Loading

GabrielMartinezRodriguez commented Dec 6, 2024 •

edited

Loading

GabrielMartinezRodriguez Jan 6, 2025 •

edited

Loading