Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: contract function params, redeployed #69

Merged
merged 1 commit into from
Jun 26, 2024

Conversation

jaybuidl
Copy link
Member

@jaybuidl jaybuidl commented Jun 26, 2024

PR-Codex overview

The PR updates the version, contract addresses, and start block number for the Arbitrum Sepolia subgraph. It also refactors the EscrowUniversal contract by removing unnecessary parameters.

Detailed summary

  • Updated version to 2.0.6 in package.json
  • Changed EscrowUniversal contract addresses in README and subgraph.yaml
  • Updated start block number in subgraph.yaml
  • Removed unnecessary parameters in EscrowUniversal contract and IEscrow interface

The following files were skipped due to too many changes: contracts/deployments/arbitrumSepoliaDevnet/EscrowUniversal.json

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Summary by CodeRabbit

  • New Features

    • Updated contract address for EscrowUniversal under Arbitrum Sepolia in documentation.
  • Changes

    • Simplified the interfaces for createNativeTransaction and createERC20Transaction by removing unnecessary parameters.
    • Updated EscrowUniversal data source address and start block value in subgraph.yaml.
  • Versioning

    • Increased the version of @kleros/escrow-v2-subgraph from 2.0.4 to 2.0.6.

Copy link
Contributor

coderabbitai bot commented Jun 26, 2024

Walkthrough

The recent updates focus on three main areas: simplifying the EscrowUniversal contract by removing unnecessary parameters, updating associated interface definitions to match these changes, and adjusting addresses and versioning in configuration files. These changes streamline the contract's functions and ensure consistency across the codebase and documentation.

Changes

Files Change Summaries
contracts/README.md Updated link for EscrowUniversal under Arbitrum Sepolia with a new address.
contracts/src/EscrowUniversal.sol, contracts/src/interfaces/IEscrow.sol Removed _templateData and _templateDataMappings parameters from createNativeTransaction and createERC20Transaction functions, simplifying their interfaces.
subgraph/package.json Updated version from 2.0.4 to 2.0.6.
subgraph/subgraph.yaml Changed EscrowUniversal data source address and startBlock values.

Poem

Amidst the lines of code so neat,
Transactions now bear a simpler beat.
Contracts flow with just the core,
New addresses open doors.
Version bumps and mappings wane,
In clarity, we now gain.

[((\ ( -.- ) ))]


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 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

netlify bot commented Jun 26, 2024

Deploy Preview for kleros-escrow-v2 ready!

Name Link
🔨 Latest commit 370ea64
🔍 Latest deploy log https://app.netlify.com/sites/kleros-escrow-v2/deploys/667c0515a6c53c00084b6fb3
😎 Deploy Preview https://deploy-preview-69--kleros-escrow-v2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@jaybuidl jaybuidl force-pushed the chore/update-mappings-in-create-transaction-flow branch from b246d3e to 370ea64 Compare June 26, 2024 12:09
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6e3fbb7 and 370ea64.

Files selected for processing (5)
  • contracts/README.md (1 hunks)
  • contracts/src/EscrowUniversal.sol (2 hunks)
  • contracts/src/interfaces/IEscrow.sol (2 hunks)
  • subgraph/package.json (1 hunks)
  • subgraph/subgraph.yaml (1 hunks)
Files skipped from review due to trivial changes (3)
  • contracts/src/EscrowUniversal.sol
  • subgraph/package.json
  • subgraph/subgraph.yaml
Additional context used
LanguageTool
contracts/README.md

[uncategorized] ~69-~69: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ... env vars are required: - PRIVATE_KEY: the private key of the deployer account...


[uncategorized] ~70-~70: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...or the testnets. - MAINNET_PRIVATE_KEY: the private key of the deployer account...


[uncategorized] ~71-~71: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...unt used for Mainnet. - INFURA_API_KEY: the API key for infura. The ones below...


[uncategorized] ~75-~75: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...low are optional: - ETHERSCAN_API_KEY: to verify the source of the newly deplo...


[uncategorized] ~76-~76: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...s on Etherscan. - ARBISCAN_API_KEY: to verify the source of the newly deplo...


[uncategorized] ~77-~77: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ... on Arbitrum. - GNOSISSCAN_API_KEY: to verify the source of the newly deplo...


[uncategorized] ~81-~81: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2)
Context: ...ed for the kleros-v2 contracts currently so this would fail. For now consider deplo...


[typographical] ~81-~81: Consider adding a comma here. (FOR_NOW_COMMA)
Context: ...contracts currently so this would fail. For now consider deploying to a testnet fork (n...


[grammar] ~89-~89: The word ‘deploy’ is a verb. Did you mean the noun “deployment” (= release, placement)? (PREPOSITION_VERB)
Context: ...node --tags nothing **Shell 2: the deploy script** bash yarn deploy --network...


[grammar] ~105-~105: The word ‘deploy’ is a verb. Did you mean the noun “deployment” (= release, placement)? (PREPOSITION_VERB)
Context: ... start-testnet-fork **Shell 2: the deploy script** bash yarn deploy-devnet-fo...

Markdownlint
contracts/README.md

12-12: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


15-15: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


9-9: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines


10-10: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines


16-16: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines


17-17: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines


83-83: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading


89-89: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading


97-97: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading


105-105: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading


127-127: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading


133-133: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading

Additional comments not posted (2)
contracts/README.md (1)

19-19: Updated EscrowUniversal address is correct.

The updated link correctly points to the new address on the Arbitrum Sepolia blockchain explorer. This change is crucial for users to access the correct contract information.

contracts/src/interfaces/IEscrow.sol (1)

84-84: Simplified createNativeTransaction function signature.

The removal of _templateData and _templateDataMappings parameters simplifies the function signature. Ensure that all implementations and calls to this function across the project have been updated to match this new signature.

Verification successful

Simplified createNativeTransaction function signature verified.

The function signature for createNativeTransaction has been updated to remove the _templateData and _templateDataMappings parameters. The new signature is correctly reflected in the following files:

  • contracts/src/EscrowUniversal.sol
  • contracts/src/interfaces/IEscrow.sol
Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify all calls to `createNativeTransaction` use the new signature.

# Test: Search for the function usage. Expect: Only occurances of the new signature.
ast-grep --lang solidity --pattern $'interface IEscrow { $$$ function createNativeTransaction($_, $_, $_) { $$$ } $$$ }'

Length of output: 238



Script:

#!/bin/bash
# Description: Verify all calls to `createNativeTransaction` use the new signature.

# Search for function definitions and calls to `createNativeTransaction` in Solidity files
rg -t solidity 'createNativeTransaction' 

Length of output: 73



Script:

#!/bin/bash
# Description: Verify all calls to `createNativeTransaction` use the new signature.

# Search for all occurrences of `createNativeTransaction` in the codebase
rg 'createNativeTransaction'

Length of output: 74710

@jaybuidl jaybuidl merged commit 5e51baa into master Jun 26, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant