feat: add option to index transaction signature

Walkthrough

## Walkthrough The recent changes introduce the environment variable `WRITE_TRANSACTION_DB_SIGNATURES` to manage the writing of database transaction signatures. The SQL schema has been updated to allow nullable signatures, and new transaction tables have been created. Enhancements to the `SignatureFetcher` class include new methods for fetching signatures, and the handling of signatures across various components has been modified to align with the new configuration setting. ## Changes | File(s) | Summary | |-----------------------------------------------|-----------------------------------------------------------------------------------------------------------| | `docker-compose.yaml`, `docs/envs.md` | Introduced a new environment variable `WRITE_TRANSACTION_DB_SIGNATURES`, controlling logging of transaction signatures. | | `migrations/*.sql`, `test/core-schema.sql` | Modified SQL schema to add nullable `signature` fields and created new tables for transactions. | | `src/config.ts`, `src/types.d.ts` | Added constant and updated interfaces to support nullable signatures and a new method for fetching transaction signatures. | | `src/data/signature-fetcher.ts`, `src/data/signature-fetcher.test.ts` | Enhanced `SignatureFetcher` with a new dependency and method for fetching transaction signatures. | | `src/database/standalone-sqlite.ts` | Updated handling of signatures to include null checks based on the new configuration setting. |

Recent review details

**Configuration used: CodeRabbit UI** **Review profile: CHILL**

Commits

Files that changed from the base of the PR and between 240c0c47d769d31de170db688e5dff81f17fc1a7 and 229ada578e067cf229c52c15e6c75c571389d6d2.

Files selected for processing (2)

* src/data/signature-fetcher.test.ts (3 hunks) * src/database/standalone-sqlite.ts (10 hunks)

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

* src/data/signature-fetcher.test.ts

Additional context used

Biome

src/database/standalone-sqlite.ts
[error] 3016-3018: Other switch clauses can erroneously access this declaration. Wrap the declaration in a block to restrict its access to the switch clause. The declaration is defined in this switch clause: Unsafe fix: Wrap the declaration in a block. (lint/correctness/noSwitchDeclarations)

Additional comments not posted (5)

src/database/standalone-sqlite.ts (5)
`234-234`: **LGTM! Conditional signature handling is correct.** The change ensures that the signature is only transformed if it is not null, which is a logical improvement. --- `633-635`: **LGTM! Configuration check for signature handling is appropriate.** This change ensures that signatures are only written to the database when explicitly allowed by the configuration. --- `824-827`: **LGTM! Configuration check for signature handling is consistent.** This change aligns with the PR objectives and ensures that signatures are only saved when allowed by the configuration. --- `996-1007`: **LGTM! Conditional signature return is correct.** The change ensures that the signature is only included if it is present, which is a logical improvement. --- `3016-3019`: **Wrap Variable Declaration in Block.** The declaration of `transactionAttributes` should be wrapped in a block to restrict its access to the switch clause and prevent potential access by other clauses. Apply this diff to fix the issue: ```diff case 'getTransactionAttributes': { const transactionAttributes = worker.getTransactionAttributes( args[0], ); parentPort?.postMessage(transactionAttributes); break; } ```

Tools

Biome
[error] 3016-3018: Other switch clauses can erroneously access this declaration. Wrap the declaration in a block to restrict its access to the switch clause. The declaration is defined in this switch clause: Unsafe fix: Wrap the declaration in a block. (lint/correctness/noSwitchDeclarations)

--- 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?

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - 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 testing code 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 and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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 an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - 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/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

Files	Patch %	Lines
src/database/standalone-sqlite.ts	36.84%	36 Missing :warning:
src/lib/encoding.ts	33.33%	2 Missing :warning:

ar-io / ar-io-node

feat: add option to index transaction signature #187

Codecov Report