Skip to content

Commit

Permalink
Merge pull request #444 from smartcontractkit/BCI-3334-implement-log-…
Browse files Browse the repository at this point in the history 
…functionality

implement starknet_getEvent in chain client
  • Loading branch information
@skippaDaBitFlippa
skippaDaBitFlippa authored May 31, 2024
2 parents a7cd87f + e0ec761 commit f297a8d
Show file tree
Hide file tree
Showing 2 changed files with 125 additions and 6 deletions.
29 changes: 27 additions & 2 deletions relayer/pkg/starknet/chain_client.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ type BatchBuilder interface {
RequestChainID() BatchBuilder
// RequestLatestPendingBlock() (BatchBuilder)
RequestLatestBlockHashAndNumber() BatchBuilder
// RequestEventsByFilter(f starknetrpc.EventFilter) (BatchBuilder)
RequestEventsByFilter(f starknetrpc.EventsInput) BatchBuilder
// RequestTxReceiptByHash(h *felt.Felt) (BatchBuilder)
Build() []gethrpc.BatchElem
}
Expand All @@ -30,6 +30,15 @@ type batchBuilder struct {
args []gethrpc.BatchElem
}

func (b *batchBuilder) RequestEventsByFilter(e starknetrpc.EventsInput) BatchBuilder {
b.args = append(b.args, gethrpc.BatchElem{
Method: "starknet_getEvents",
Args: []interface{}{e},
Result: &starknetrpc.EventChunk{},
})
return b
}

func NewBatchBuilder() BatchBuilder {
return &batchBuilder{
args: nil,
Expand Down Expand Up @@ -91,7 +100,7 @@ type ChainClient interface {
// returns block number and block has of latest finalized block
LatestBlockHashAndNumber(ctx context.Context) (starknetrpc.BlockHashAndNumberOutput, error)
// get block logs, event logs, etc.
// EventsByFilter(ctx context.Context, f starknetrpc.EventFilter) ([]starknetrpc.EmittedEvent, error)
EventsByFilter(ctx context.Context, f starknetrpc.EventsInput) (starknetrpc.EventChunk, error)
// TxReceiptByHash(ctx context.Context, h *felt.Felt) (starknetrpc.TransactionReceipt, error)
Batch(ctx context.Context, builder BatchBuilder) ([]gethrpc.BatchElem, error)
}
Expand Down Expand Up @@ -184,6 +193,22 @@ func (c *Client) LatestBlockHashAndNumber(ctx context.Context) (starknetrpc.Bloc
return *info, nil
}

func (c *Client) EventsByFilter(ctx context.Context, f starknetrpc.EventsInput) (starknetrpc.EventChunk, error) {
if c.defaultTimeout != 0 {
var cancel context.CancelFunc
ctx, cancel = context.WithTimeout(ctx, c.defaultTimeout)
defer cancel()
}

chunk, err := c.Provider.Events(ctx, f)

if err != nil {
return starknetrpc.EventChunk{}, fmt.Errorf("error in EventsByFilter: %w", err)
}

return *chunk, nil
}

func (c *Client) Batch(ctx context.Context, builder BatchBuilder) ([]gethrpc.BatchElem, error) {
if c.defaultTimeout != 0 {
var cancel context.CancelFunc
Expand Down
102 changes: 98 additions & 4 deletions relayer/pkg/starknet/chain_client_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import (
var (
myTimeout = 100 * time.Second
blockNumber = 48719
uintBlockNum = uint64(blockNumber)
blockHash, _ = new(felt.Felt).SetString("0x725407fcc3bd43e50884f50f1e0ef32aa9f814af3da475411934a7dbd4b41a")
blockResponse = []byte(`
"result": {
Expand Down Expand Up @@ -66,12 +67,69 @@ var (
]
}]
}`)
eventResponse = []byte(`
"result": {
"events": [
{
"from_address": "0x517567ac7026ce129c950e6e113e437aa3c83716cd61481c6bb8c5057e6923e",
"keys": [
"0x297be67eb977068ccd2304c6440368d4a6114929aeb860c98b6a7e91f96e2ef",
"0x496e76656e746f7279"
],
"data": [
"0x2",
"0x4690005",
"0x2",
"0xa",
"0x1",
"0x4a61fe0",
"0xa3013f8",
"0x0",
"0x0",
"0x2",
"0xaf",
"0x41f",
"0x81",
"0xb50a"
],
"block_number": 48719,
"block_hash": "0x725407fcc3bd43e50884f50f1e0ef32aa9f814af3da475411934a7dbd4b41a",
"transaction_hash": "0x27a9a9bc927efc37658acfb9c27b1fc56e7cfcf7a30db1ecdd9820bb2dddf0c"
},
{
"from_address": "0x517567ac7026ce129c950e6e113e437aa3c83716cd61481c6bb8c5057e6923e",
"keys": [
"0x297be67eb977068ccd2304c6440368d4a6114929aeb860c98b6a7e91f96e2ef",
"0x436f6e74726f6c"
],
"data": [
"0x1",
"0x116c0007",
"0x1",
"0x4eb"
],
"block_number": 48719,
"block_hash": "0x725407fcc3bd43e50884f50f1e0ef32aa9f814af3da475411934a7dbd4b41a",
"transaction_hash": "0x27a9a9bc927efc37658acfb9c27b1fc56e7cfcf7a30db1ecdd9820bb2dddf0c"
}
],
"continuation_token": "48719-2"
}`)
blockHashAndNumberResponse = fmt.Sprintf(`{"block_hash": "%s", "block_number": %d}`,
"0x725407fcc3bd43e50884f50f1e0ef32aa9f814af3da475411934a7dbd4b41a",
48719,
)
// hex-encoded value for "SN_SEPOLIA"
chainIDHex = "0x534e5f5345504f4c4941"
chainIDHex = "0x534e5f5345504f4c4941"
eventsInput = starknetrpc.EventsInput{
EventFilter: starknetrpc.EventFilter{
FromBlock: starknetrpc.BlockID{Number: &uintBlockNum},
ToBlock: starknetrpc.BlockID{Number: &uintBlockNum},
},
ResultPageRequest: starknetrpc.ResultPageRequest{
ChunkSize: 2,
},
}
)

func TestChainClient(t *testing.T) {
Expand Down Expand Up @@ -99,6 +157,8 @@ func TestChainClient(t *testing.T) {
out = []byte(fmt.Sprintf(`{"result": %s}`, blockHashAndNumberResponse))
case "starknet_chainId":
out = []byte(fmt.Sprintf(`{"result": "%s"}`, chainIDHex))
case "starknet_getEvents":
out = []byte(fmt.Sprintf(`{ %s }`, eventResponse))
default:
require.False(t, true, "unsupported RPC method %s", call.Method)
}
Expand Down Expand Up @@ -139,11 +199,17 @@ func TestChainClient(t *testing.T) {
"jsonrpc": "2.0",
"id": %d,
"result": %s
},
{
"jsonrpc": "2.0",
"id": %d,
%s
}
]`, batchCall[0].ID, chainIDHex,
batchCall[1].ID, blockResponse,
batchCall[2].ID, blockResponse,
batchCall[3].ID, blockHashAndNumberResponse,
batchCall[4].ID, eventResponse,
)

out = []byte(response)
Expand Down Expand Up @@ -185,25 +251,39 @@ func TestChainClient(t *testing.T) {
assert.Equal(t, chainIDHex, output)
})

t.Run("get Events", func(t *testing.T) {
blockNumber := uint64(blockNumber)
events, err := client.EventsByFilter(context.TODO(), eventsInput)
require.NoError(t, err)

assert.Equal(t, 2, len(events.Events))
assert.Equal(t, "48719-2", events.ContinuationToken)
for _, event := range events.Events {
assert.NotNil(t, event)
assert.Equal(t, blockNumber, event.BlockNumber)
assert.Equal(t, blockHash, event.BlockHash)
}
})

t.Run("get Batch", func(t *testing.T) {
builder := NewBatchBuilder()
builder.
RequestChainID().
RequestBlockByHash(blockHash).
RequestBlockByNumber(uint64(blockNumber)).
RequestLatestBlockHashAndNumber()
RequestLatestBlockHashAndNumber().
RequestEventsByFilter(eventsInput)

results, err := client.Batch(context.TODO(), builder)
require.NoError(t, err)

assert.Equal(t, 4, len(results))
assert.Equal(t, 5, len(results))

t.Run("gets ChainID in Batch", func(t *testing.T) {
assert.Equal(t, "starknet_chainId", results[0].Method)
assert.Nil(t, results[0].Error)
id, ok := results[0].Result.(*string)
assert.True(t, ok)
fmt.Println(id)
assert.Equal(t, chainIDHex, *id)
})

Expand Down Expand Up @@ -231,5 +311,19 @@ func TestChainClient(t *testing.T) {
assert.Equal(t, blockHash, info.BlockHash)
assert.Equal(t, uint64(blockNumber), info.BlockNumber)
})

t.Run("gets EventsByFilter in Batch", func(t *testing.T) {
assert.Equal(t, "starknet_getEvents", results[4].Method)
assert.Nil(t, results[4].Error)
events, ok := results[4].Result.(*starknetrpc.EventChunk)
assert.True(t, ok)
assert.Equal(t, 2, len(events.Events))
assert.Equal(t, "48719-2", events.ContinuationToken)
for _, event := range events.Events {
assert.NotNil(t, event)
assert.Equal(t, uint64(blockNumber), event.BlockNumber)
assert.Equal(t, blockHash, event.BlockHash)
}
})
})
}

0 comments on commit f297a8d

Please sign in to comment.