Improve pay/reimburse/execute flow #64
Conversation
WalkthroughRecent updates to the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant EscrowContract as EscrowUniversal
participant Event as EventHandler
User->>+EscrowContract: executePayment(transactionID, amount)
EscrowContract->>Event: emit Payment(transactionID, amount, msg.sender)
EscrowContract-->>-User: completePayment
User->>+EscrowContract: reimburse(transactionID, amountReimbursed)
EscrowContract->>Event: emit Payment(transactionID, amountReimbursed, msg.sender)
EscrowContract-->>-User: completeReimbursement
User->>+EscrowContract: resolve(transactionID)
EscrowContract->>Event: emit TransactionResolved(transactionID, Resolution.TransactionExecuted)
EscrowContract-->>-User: completeResolution
Poem
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- contracts/src/EscrowUniversal.sol (3 hunks)
Files not reviewed due to errors (1)
- contracts/src/EscrowUniversal.sol (no review received)
✅ Deploy Preview for kleros-escrow-v2 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- contracts/README.md (1 hunks)
- contracts/deploy/00-escrow.ts (1 hunks)
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...
[uncategorized] ~123-~123: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ... on Public Testnets Same steps as above but appendDevnetto the--networkpara...
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 (3)
contracts/README.md (1)
19-19: Updated deployment link to the new contract address.Please verify that the provided link is correct and active.
contracts/deploy/00-escrow.ts (2)
6-42: Updated dispute template with new schema, dynamic titles, and additional metadata fields.Consider adding comments in the code to explain how template variables like
{{escrowTitle}}and{{deliverableText}}are replaced at runtime.
48-65: Enhanced mapping configuration with GraphQL and IPFS integration.Ensure that the GraphQL endpoint and IPFS URI are correctly configured and operational.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- subgraph/package.json (1 hunks)
- subgraph/subgraph.yaml (1 hunks)
Files skipped from review due to trivial changes (1)
- subgraph/package.json
Additional comments not posted (2)
subgraph/subgraph.yaml (2)
9-9: Updated contract address to '0xd3d61eB06c96F69D03B285392C269d5577ff2342'.Ensure this address is correct and consistent with other parts of the project where the contract address is used.
11-11: UpdatedstartBlockto 56637255.Verify this block number corresponds to the block at which the updated contract was deployed.
contracts to be redeployed
PR-Codex overview
Focus: This PR updates the Escrow system to version 2.0.3 on Arbitrum Sepolia, modifies contract addresses, emits payment events, and enhances dispute templates.
Detailed summary
Summary by CodeRabbit
New Features
PaymentandTransactionResolvedin the escrow transactions.Documentation
EscrowUniversalcontract address in the documentation for Arbitrum Sepolia.Chores
EscrowUniversaldata source address and start block in the subgraph configuration.@kleros/escrow-v2-subgraphfrom2.0.1to2.0.3.