Added docs for txm by GabrielMartinezRodriguez · Pull Request #272 · HappyChainDevs/happychain

GabrielMartinezRodriguez · 2024-11-28T07:04:47Z

Linked Issues

closes https://linear.app/happychain/issue/HAPPY-152/documentation-for-the-transaction-manager

Description

This PR adds the Transaction Manager documentation to the VOCs repository. In addition, it includes some inline documentation for the Transaction Manager itself

In this link you will have more context about the docs:
https://www.notion.so/happychain/Transaction-Manager-13104b72a58580b185dcde1cf84baa98?pvs=4

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).

Reminder: PR review guidelines

Correctness

C1. Builds and passes tests.
C2. The code is properly parameterized & compatible with different environments (e.g. local,
testnet, mainnet, standalone wallet, ...).
C3. I have manually tested my changes & connected features.

< INDICATE BROWSER, DEMO APP & OTHER ENV DETAILS USED FOR TESTING HERE >

< INDICATE TESTED SCENARIOS (USER INTERFACE INTERACTION, CODE FLOWS) HERE >

C4. I have performed a thorough self-review of my code after submitting the PR,
and have updated the code & comments accordingly.

Architecture & Documentation

D1. I made it easy to reason locally about the code, by (1) using proper abstraction boundaries,
(2) commenting these boundaries correctly, (3) adding inline comments for context when needed.
D2. All public-facing APIs & meaningful (non-local) internal APIs are properly documented in code
comments.
D3. If appropriate, the general architecture of the code is documented in a code comment or
in a Markdown document.

GabrielMartinezRodriguez · 2024-11-28T07:05:07Z

Add flush mechanism #289 : 2 dependent PRs (#297 , #298 )
Allow run multiple txm simultaneously within the same service #285
Added docs for txm #272 👈 (View in Graphite)
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.

cloudflare-workers-and-pages · 2024-11-28T07:06:33Z

Deploying happychain with Cloudflare Pages

Latest commit:	`8869e42`
Status:	✅ Deploy successful!
Preview URL:	https://35904f0a.happychain.pages.dev
Branch Preview URL:	https://gabriel-txm-doc.happychain.pages.dev

View logs

linear · 2024-12-03T09:32:57Z

HAPPY-152 Documentation for the Transaction Manager

norswap · 2025-01-06T17:39:43Z

+ * who have a strict requirement on the block number or timestamp on or after which they should land.
+ *
+ * For example, in the randomness service, we need to emit the reveal transaction at precisely the right block.
+ * This transaction would fail if executed before the correct block, so when you try to simulate it, you'll receive a failure.


Would remove this paragraph as the user doesn't necessarily know what the randomness service is.

norswap · 2025-01-06T17:50:24Z


 export enum TransactionStatus {
+    /**
+     * The transaction is waiting to be included in a block


Right, pending is the default state. Let's explain that. Something like "Default state for new transaction: the transaction is awaiting processing by TXM or has been submitted in the mempool and is waiting to be included in a block."

Maybe we want to split this in two states? "Processing" and "Pending"? "Processing" transactions are never saved to the DB if I'm not mistaken.

norswap · 2025-01-06T17:56:02Z

+     */
    Expired = "Expired",
+    /**
+     * The transaction has expired and we are trying to cancel it to save gas


Okay, good point. Let's say ".. trying to cancel it to save gas compared to having it land on chain and either revert or do something we no longer care about."

norswap · 2025-01-06T17:58:13Z

+     * The transaction has been successfully executed
+     */
    Success = "Success",
 }


Gotcha, so gas estimation will be retried by the tx monitor next time?
We probably ought to have a special kind of feedback for these kind of transactions, I'll enqueue an issue for this.

norswap · 2025-01-06T18:05:40Z

+ * The module must be initialized first. During initialization, it retrieves the transaction count from the RPC,
+ * which represents the expected next nonce without considering potential pending transactions in the mempool.
+ * To handle this scenario, we check for pending transactions in our database and identify the last nonce of these transactions.
+ * We also check for gaps in the pending transactions, aiming to use these gaps before assigning new nonces, thus eliminating nonce gaps.


https://linear.app/happychain/issue/HAPPY-281/update-txm-docshttps://linear.app/happychain/issue/HAPPY-281/update-txm-docs

This was referenced Nov 28, 2024

Txm hooks #229

Merged

Purge transactions #232

Merged

Use kysely instead of mikro-orm #250

Merged

Mutex in tx monitor #264

Merged

GabrielMartinezRodriguez force-pushed the gabriel/txm-doc branch from c5bddb5 to 2a35bd2 Compare November 28, 2024 07:10

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

GabrielMartinezRodriguez marked this pull request as ready for review December 3, 2024 09:42

GabrielMartinezRodriguez requested a review from AryanGodara December 3, 2024 09:42

GabrielMartinezRodriguez changed the title ~~feat(txm): added docs for txm~~ Added docs for txm Dec 3, 2024

aodhgan reviewed Dec 3, 2024

View reviewed changes

Comment thread packages/docs/docs/pages/transaction-manager/getting-started.mdx

aodhgan reviewed Dec 3, 2024

View reviewed changes

Comment thread packages/transaction-manager/lib/AbiManager.ts Outdated

aodhgan reviewed Dec 3, 2024

View reviewed changes

Comment thread packages/transaction-manager/lib/Transaction.ts Outdated

not-reed reviewed Dec 4, 2024

View reviewed changes

GabrielMartinezRodriguez force-pushed the gabriel/tx-monitor-lock branch from e20494b to 96c21fc Compare December 4, 2024 10:26

GabrielMartinezRodriguez force-pushed the gabriel/txm-doc branch from 17474a2 to 7066f94 Compare December 4, 2024 10:27

GabrielMartinezRodriguez mentioned this pull request Dec 4, 2024

Allow run multiple txm simultaneously within the same service #285

Merged

10 tasks

not-reed approved these changes Dec 4, 2024

View reviewed changes

GabrielMartinezRodriguez added reviewing-2 Ready for, or undergoing final review and removed reviewing-1 Ready for, or undergoing first-line review labels Dec 4, 2024

GabrielMartinezRodriguez force-pushed the gabriel/tx-monitor-lock branch from 96c21fc to 7a69327 Compare December 5, 2024 10:47

GabrielMartinezRodriguez force-pushed the gabriel/txm-doc branch from 7066f94 to 6509fe0 Compare December 5, 2024 10:48

GabrielMartinezRodriguez force-pushed the gabriel/tx-monitor-lock branch from 7a69327 to 65b547a Compare December 5, 2024 11:34

GabrielMartinezRodriguez force-pushed the gabriel/txm-doc branch from 6509fe0 to 7199d82 Compare December 5, 2024 11:35

GabrielMartinezRodriguez force-pushed the gabriel/tx-monitor-lock branch from 65b547a to 2ecd54a Compare December 5, 2024 15:29

GabrielMartinezRodriguez force-pushed the gabriel/txm-doc branch from 7199d82 to a4d48c9 Compare December 5, 2024 15:30

GabrielMartinezRodriguez mentioned this pull request Dec 5, 2024

Add flush mechanism #289

Merged

10 tasks

GabrielMartinezRodriguez force-pushed the gabriel/tx-monitor-lock branch from 2ecd54a to 3c8d970 Compare December 6, 2024 10:01

GabrielMartinezRodriguez force-pushed the gabriel/txm-doc branch from caaf521 to 5b00c8c Compare January 6, 2025 12:23

GabrielMartinezRodriguez changed the base branch from graphite-base/272 to master January 6, 2025 12:23

GabrielMartinezRodriguez added reviewing-2 Ready for, or undergoing final review and removed updating Updating after review labels Jan 6, 2025

GabrielMartinezRodriguez requested a review from norswap January 6, 2025 12:23

norswap approved these changes Jan 6, 2025

View reviewed changes

norswap added merge-after-changes Can be merged after requested changes are made and removed reviewing-2 Ready for, or undergoing final review labels Jan 6, 2025

GabrielMartinezRodriguez added 7 commits January 7, 2025 10:34

feat(txm): added docs for txm

304dc9e

chore(docs): added HookManager doc

0a5e296

chore(docs): modified txm doc header

911fc6d

chore(docs): improve txm docs

47f368d

chore(txm): modified contractName doc

b3bfcf6

chore(docs): improve txm docs

0596693

chore(txm): updated comments

8869e42

GabrielMartinezRodriguez force-pushed the gabriel/txm-doc branch from 500c1de to 8869e42 Compare January 7, 2025 09:35

GabrielMartinezRodriguez merged commit 19c86f4 into master Jan 7, 2025

GabrielMartinezRodriguez deleted the gabriel/txm-doc branch January 7, 2025 09:47

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

linear Bot mentioned this pull request Apr 10, 2025

Txm transactions support arbitrary calldata #596

Merged

11 tasks

Uh oh!

Conversation

GabrielMartinezRodriguez commented Nov 28, 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!

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

Uh oh!

Uh oh!

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

Uh oh!

Deploying happychain with Cloudflare Pages

Uh oh!

linear Bot commented Dec 3, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

norswap Jan 6, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

norswap Jan 6, 2025

Choose a reason for hiding this comment

Uh oh!

norswap Jan 6, 2025

Choose a reason for hiding this comment

Uh oh!

norswap Jan 6, 2025

Choose a reason for hiding this comment

Uh oh!

norswap Jan 6, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

GabrielMartinezRodriguez commented Nov 28, 2024 •

edited

Loading

GabrielMartinezRodriguez commented Nov 28, 2024 •

edited

Loading

cloudflare-workers-and-pages Bot commented Nov 28, 2024 •

edited

Loading