Skip to content

Fix code examples in Brevis SDK documentation #93

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.

Sign up for GitHub

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

Open
reject-i wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix code examples in Brevis SDK documentation #93

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 26 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,11 @@ func (c *AppCircuit) Allocate() (maxReceipts, maxStorage, maxTransactions int) {
return 32, 32, 64
}

func ParseEventID(eventIDHex string) sdk.Bytes32 {
// Implementation of event ID parsing
return sdk.ConstBytes32([]byte{})
}

var ConstEventID = ParseEventID(/* 0x123456... */)

func (c *AppCircuit) Define(api *sdk.CircuitAPI, input sdk.DataInput) error {
Expand All @@ -69,7 +74,7 @@ func (c *AppCircuit) Define(api *sdk.CircuitAPI, input sdk.DataInput) error {
// In this example, by checking these, you are proving to your
// contract that you have checked that all events have a certain
// event ID
sdk.AssertEach(receipts, func(receipt sdk.Receipt) Variable {
sdk.AssertEach(receipts, func(receipt sdk.Receipt) sdk.Variable {
return api.Equal(receipt.Fields[0].EventID, ConstEventID)
})

Expand All @@ -85,9 +90,17 @@ func (c *AppCircuit) Define(api *sdk.CircuitAPI, input sdk.DataInput) error {
})
sum := sdk.Sum(values)

// sdk.Reduce(...)
// sdk.GroupBy(...)
// and more ...
// Example of Reduce
sdk.Reduce(values, sdk.ConstUint248(0), func(acc, val sdk.Uint248) sdk.Uint248 {
return api.Add(acc, val)
})

// Example of GroupBy
sdk.GroupBy(receipts, func(r sdk.Receipt) sdk.Bytes32 {
return r.TxHash
}, func(group []sdk.Receipt) sdk.Uint248 {
return sdk.ConstUint248(uint64(len(group)))
})

// You can output any number of computation results using sdk.OutputXXX APIs
// These results will be available for use in your contract when the proof
Expand All @@ -113,6 +126,12 @@ import (
)

func TestAppCircuit(t *testing.T) {
// Create a Brevis app
app := sdk.NewBrevisApp(1, "RPC_URL", "OutputDir")

// Add necessary data
app.AddReceipt(sdk.ReceiptData{/*...*/})

appCircuit := DefaultAppCircuit()
appCircuitAssignment := &AppCircuit{
MyInput: sdk.ConstUint248(123),
Expand All @@ -121,6 +140,9 @@ func TestAppCircuit(t *testing.T) {
// BuildAppCircuit fetches additional data required to generate proofs from the
// ETH RPC you provided and package the actual queried data into sdk.CircuitInput
circuitInput, err := app.BuildCircuitInput(appCircuitAssignment)
if err != nil {
t.Fatalf("Failed to build circuit input: %v", err)
}

// brevis-sdk/test package

Expand Down