Skip to content

add comment for ABI on contract read/write #117

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

Merged
merged 1 commit into from
Feb 1, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions protobuf/avs.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 6 additions & 2 deletions protobuf/avs.proto
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,9 @@ message ContractWriteNode {
string contract_address = 1;
string call_data = 2;

// abi is necessary to decode the return
// The ABI is only required to decode the return value of a method call.
// If we don’t need the result and only want the transaction hash (which is usually sufficient),
// then we don’t need to provide the ABI.
string contract_abi = 3;
string method = 4;
}
Expand All @@ -133,7 +135,9 @@ message ContractReadNode {
string contract_address = 1;
string call_data = 2;

// abi and method name is necessary to decode the return
// The ABI and method name are required to decode the return value and pass it to the next step.
// Currently, we need to provide the contract ABI as a JSON string.
// We don’t need to include the full ABI—just enough to decode the method call.
string contract_abi = 3;
string method = 4;
}
Expand Down