ar-io / ar-io-node

A scalable and modular gateway built for the permaweb atop the Arweave permanent data storage network.
https://ar.io
GNU Affero General Public License v3.0
97 stars 65 forks source link

feat(io): use ao/io contract for fetching peer data sources #142

Closed dtfiedler closed 4 months ago

dtfiedler commented 4 months ago

The SDK supports a new implementation of the same interfaces using the AO/IO contract.

codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 64.53%. Comparing base (db73c69) to head (42ceb37).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #142 +/- ## =========================================== + Coverage 64.50% 64.53% +0.02% =========================================== Files 25 25 Lines 6469 6474 +5 Branches 293 293 =========================================== + Hits 4173 4178 +5 Misses 2295 2295 Partials 1 1 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

coderabbitai[bot] commented 4 months ago
Walkthrough ## Walkthrough The updates involve upgrading the `@ar.io/sdk` package version, introducing a new constant in the configuration, and renaming and refactoring various imports and initializations to align with the new SDK version. These changes ensure compatibility with the updated SDK and streamline the initialization process using the new `IO_PROCESS_ID`. ## Changes | File | Change Summary | |-------------------------------|-------------------------------------------------------------------------------------------------------------| | `package.json` | Updated `@ar.io/sdk` version from `^1.0.7` to `1.2.0-alpha.1`. | | `src/config.ts` | Added a new constant `IO_PROCESS_ID` with a default value. | | `src/data/ar-io-data-source.ts` | Changed import from `ArIOReadable` to `AoIORead` and updated the `arIO` property accordingly. | | `src/system.ts` | Renamed import from `ArIO` to `IO` and changed the initialization to use `IO_PROCESS_ID` instead of `CONTRACT_ID`. | ## Sequence Diagram(s) (Beta) ```mermaid sequenceDiagram participant Config as src/config.ts participant System as src/system.ts participant DataSource as src/data/ar-io-data-source.ts participant SDK as @ar.io/sdk Config->>System: export const IO_PROCESS_ID System->>SDK: IO.init({ processId: config.IO_PROCESS_ID }) DataSource->>SDK: import { AoIORead } from '@ar.io/sdk' ```

Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between db73c69f9dbf6d98b7126195f06ab4497591dd24 and 42ceb3713da4c3b3dac5adddc32b7d4a0168eba6.
Files ignored due to path filters (1) * `yarn.lock` is excluded by `!**/*.lock`
Files selected for processing (4) * package.json (1 hunks) * src/config.ts (1 hunks) * src/data/ar-io-data-source.ts (3 hunks) * src/system.ts (2 hunks)
Files not reviewed due to errors (1) * src/data/ar-io-data-source.ts (no review received)
Files skipped from review due to trivial changes (2) * package.json * src/config.ts
Additional comments not posted (2)
src/system.ts (2)
`22-22`: Update import to align with new SDK changes. The import statement has been correctly updated from `ArIO` to `IO` to match the new SDK version. --- `82-82`: Update initialization to use new configuration parameter. The initialization of `arIO` has been updated to use `processId` instead of `contractTxId`, aligning with the new SDK's configuration requirements.
--- 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 - [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 Configration 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.