Adding batch timestamp to the public tx API #1740

otherview · 2024-01-10T17:12:37Z

Why this change is needed

Transactions Request should have batch timestamp along side with batch number
Update the folder and test name from obscuro to ten
Update tenscan to display the timestamps

What changes were made as part of this PR

Please provide a high level list of the changes made

PR checks pre-merging

Please indicate below by ticking the checkbox that you have read and performed the required
PR checks

PR checks reviewed and performed

coderabbitai · 2024-01-10T17:12:49Z

Walkthrough

The system has been updated to track the batch timestamp for transactions. The PublicTransaction data structure now includes a BatchTimestamp field to hold this information. Accompanying this change, the database queries have been adjusted to retrieve the batch.header, decode it, and fill in the new BatchTimestamp field when selecting public transactions based on the sender.

Changes

File(s)	Change Summary
`.../common/query_types.go`	Added `BatchTimestamp` field of type `uint64` to `PublicTransaction` struct.
`.../enclave/storage/enclavedb/batch.go`	Modified `queryTxList` SQL query to include `batch.header`; updated `selectPublicTxsBySender` to decode `batchHeader` and populate `BatchTimestamp`.
`.../frontend/src/components/modules/dashboard/recent-transactions.tsx`, `.../frontend/src/components/modules/transactions/columns.tsx`, `.../frontend/src/types/interfaces/TransactionInterfaces.ts`	Added support for displaying and handling the `BatchTimestamp` field in the frontend components and transaction interfaces.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit-tests for this file.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit tests for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository from git and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit tests.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
The JSON schema for the configuration file is available here.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between f72e986 and e6ea0ec.

Files selected for processing (2)

go/common/query_types.go (1 hunks)
go/enclave/storage/enclavedb/batch.go (2 hunks)

Additional comments: 3

go/common/query_types.go (1)

36-36: The addition of the BatchTimestamp field to the PublicTransaction struct is consistent with the PR objectives and is correctly typed as uint64. This change should enhance the transaction metadata as intended.

go/enclave/storage/enclavedb/batch.go (2)

47-47: The modification to the queryTxList SQL query to include batch.header is correct and aligns with the PR objectives to enhance transaction metadata.

512-526: The changes to the selectPublicTxsBySender function, including the decoding of the batchHeader and populating the BatchTimestamp field in the PublicTransaction struct, are correctly implemented using rlp.DecodeBytes.

coderabbitai

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between e6ea0ec and 9d92f63.

Files selected for processing (3)

tools/tenscan/frontend/src/components/modules/dashboard/recent-transactions.tsx (1 hunks)
tools/tenscan/frontend/src/components/modules/transactions/columns.tsx (1 hunks)
tools/tenscan/frontend/src/types/interfaces/TransactionInterfaces.ts (1 hunks)

Files skipped from review due to trivial changes (1)

tools/tenscan/frontend/src/components/modules/dashboard/recent-transactions.tsx

Additional comments: 1

tools/tenscan/frontend/src/types/interfaces/TransactionInterfaces.ts (1)

5-5: The addition of the BatchTimestamp field to the Transaction type is correctly implemented and aligns with the PR objectives to provide additional context to transactions.

tools/tenscan/frontend/src/components/modules/transactions/columns.tsx

otherview · 2024-01-10T17:26:24Z

@Jennievon the timestamp that's displayed doesn't have any treatment (it's a unix timestamp). I wonder if you have some wizard trick to display these nicely ?

Jennievon · 2024-01-10T17:56:26Z

@Jennievon the timestamp that's displayed doesn't have any treatment (it's a unix timestamp). I wonder if you have some wizard trick to display these nicely ?

sure, I'll push an update for it.

BedrockSquirrel

LGTM but maybe Jennie can advise on the formatting comment.

BedrockSquirrel · 2024-01-10T23:26:50Z

tools/tenscan/frontend/src/components/modules/dashboard/recent-transactions.tsx

@@ -17,6 +17,11 @@ export function RecentTransactions({ transactions }: { transactions: any }) {
                #{transaction?.BatchHeight}
              </p>
            </div>
+            <div className="ml-4 space-y-1">
+              <p className="text-sm font-medium leading-none">
+                {transaction?.BatchTimestamp}


Would it work to use {formatTimeAgo(batch?.timestamp)} here, like @Jennievon did in recent-batches.tsx? To get the 'x mins ago' formatting.

coderabbitai

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 9d92f63 and f946cc6.

Files selected for processing (3)

tools/tenscan/frontend/src/components/modules/dashboard/recent-transactions.tsx (2 hunks)
tools/tenscan/frontend/src/components/modules/transactions/columns.tsx (2 hunks)
tools/tenscan/frontend/src/lib/utils.ts (1 hunks)

Files skipped from review as they are similar to previous changes (2)

tools/tenscan/frontend/src/components/modules/dashboard/recent-transactions.tsx
tools/tenscan/frontend/src/components/modules/transactions/columns.tsx

coderabbitai · 2024-01-11T09:06:40Z

tools/tenscan/frontend/src/lib/utils.ts

+export function formatTimeAgo(unixTimestampSeconds: string | number) {
+  if (!unixTimestampSeconds) {
+    return "Unknown";
+  }


The update to formatTimeAgo to accept both string and number types for unixTimestampSeconds adds flexibility. However, ensure that the type conversion with Number() is safe and won't lead to unexpected behavior with different input types. The addition of a falsy check to return "Unknown" is a good defensive programming practice.

Jennievon

LGTM!

Adding batch timestamp to the public tx API

e6ea0ec

otherview requested review from Jennievon and BedrockSquirrel January 10, 2024 17:12

coderabbitai bot reviewed Jan 10, 2024

View reviewed changes

update tenscan for the timestamp fields

9d92f63

coderabbitai bot reviewed Jan 10, 2024

View reviewed changes

tools/tenscan/frontend/src/components/modules/transactions/columns.tsx Outdated Show resolved Hide resolved

BedrockSquirrel approved these changes Jan 10, 2024

View reviewed changes

Format batch time stamp for transactions

f946cc6

coderabbitai bot reviewed Jan 11, 2024

View reviewed changes

Jennievon approved these changes Jan 11, 2024

View reviewed changes

otherview merged commit cdc02eb into main Jan 11, 2024
2 checks passed

otherview deleted the pedro/tx_api_batch_timestamp branch January 11, 2024 10:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding batch timestamp to the public tx API #1740

Adding batch timestamp to the public tx API #1740

otherview commented Jan 10, 2024 •

edited

Loading

coderabbitai bot commented Jan 10, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

CodeRabbit Discord Community

coderabbitai bot left a comment

coderabbitai bot left a comment

otherview commented Jan 10, 2024

Jennievon commented Jan 10, 2024

BedrockSquirrel left a comment

BedrockSquirrel Jan 10, 2024

coderabbitai bot left a comment

coderabbitai bot Jan 11, 2024

Jennievon left a comment

Adding batch timestamp to the public tx API #1740

Adding batch timestamp to the public tx API #1740

Conversation

otherview commented Jan 10, 2024 • edited Loading

Why this change is needed

What changes were made as part of this PR

PR checks pre-merging

coderabbitai bot commented Jan 10, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

otherview commented Jan 10, 2024

Jennievon commented Jan 10, 2024

BedrockSquirrel left a comment

Choose a reason for hiding this comment

BedrockSquirrel Jan 10, 2024

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Jan 11, 2024

Choose a reason for hiding this comment

Jennievon left a comment

Choose a reason for hiding this comment

otherview commented Jan 10, 2024 •

edited

Loading

coderabbitai bot commented Jan 10, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)