eigerco/beerus

A stateless trustless Starknet light client in Rust 🦀

beerus's Issues

Add test coverage

Description

We should add test coverage measurement in the project and add it in the CI

Add Rest API wrapper

Description

Add a Rest API wrapper to interact with Beerus Light Client Features

Acceptance Criteria

• Rest API exposes features of Beerus
• Associated tests are created

Increase test coverage round 1

Description

Increase test coverage. First pass.

feat: Starknet RPC "get_class" call

Description

Implement "get_class" Starknet RPC call

Starknet-RS Implementation
https://github.com/xJonathanLEI/starknet-rs/blob/da72d0130eb48cc84288c9948d983f5f78cf6054/starknet-providers/src/jsonrpc/mod.rs#L227

Acceptance Criteria

• Beerus can query a Starknet's block number
• Associated cli command
• Associated rest api wrapper
• Helios integration
• Units tests
• Integration tests

feat: Ethereum RPC "get_transaction_count" call

Description

Implement "get_transaction_count" Ethereum RPC call

Helios implmentation: https://github.com/a16z/helios/blob/94bf458d941f30e34faeaa7d2484898dba54234d/client/src/rpc.rs#L59

Acceptance Criteria

• Beerus can query a Ethereum's block number
• Associated cli command
• Associated rest api wrapper
• Helios integration
• Units tests
• Integration tests

dev: beerus-cli usage

Description

Beerus-cli usage is inaccessible without setting appropriate environment variables making it impossible to get usage like beerus-cli -v or beerus-cli -h. Things like tag checking to implement #6 will be easier with proper usage implementation.

Acceptance Criteria

• beerus-cli -v available when environment variables aren't set
• beerus-cli -h available when environment variables aren't set

feat: Ethereum RPC " get_transaction_by_hash" call

Description

Implement "get_transaction_by_hash" Ethereum RPC call

Helios implmentation: https://github.com/a16z/helios/blob/94bf458d941f30e34faeaa7d2484898dba54234d/client/src/rpc.rs#L94

Acceptance Criteria

• Beerus can query a Ethereum's block number
• Associated cli command
• Associated rest api wrapper
• Helios integration
• Units tests
• Integration tests

dev: Change blockTag implementations

Currently block Number is set to "latest", there is a need to change it so the argument comes from the command line or the REST API call.

Add cache for dependencies in CI

Description

CI workflows are currently slow, we can speed up the process by caching dependencies.

@LucasLvy

feat: Ethereum RPC "get_code" call

Description

Implement "get_code" Ethereum RPC call

Helios implmentation: https://github.com/a16z/helios/blob/94bf458d941f30e34faeaa7d2484898dba54234d/client/src/rpc.rs#L61

Acceptance Criteria

• Beerus can query a Ethereum's block number
• Associated cli command
• Associated rest api wrapper
• Helios integration
• Units tests
• Integration tests

feat: Ethereum RPC "get_logs" call

Description

Implement "get_logs" Ethereum RPC call

Helios implmentation: https://github.com/a16z/helios/blob/ac8a145ae33e72b62e017749fd0d3e1887d3999e/client/src/rpc.rs#L101

Acceptance Criteria

• Beerus can query a Ethereum's tx logs
• Associated cli command
• Associated rest api wrapper
• Helios integration
• Units tests
• Integration tests

feat: Ethereum RPC " get_block_by_hash" call

Description

Implement "get_block_by_hash" Ethereum RPC call

Helios implmentation: https://github.com/a16z/helios/blob/94bf458d941f30e34faeaa7d2484898dba54234d/client/src/rpc.rs#L81

Acceptance Criteria

• Beerus can query a Ethereum's block number
• Associated cli command
• Associated rest api wrapper
• Helios integration
• Units tests
• Integration tests

Mock http server

Description

Mock ethereum full node and StarkNet full node for integration tests

Acceptance criteria

• Pathfinder is mockable
• Ethereum full node is mockable

Implement Beerus endpoint `get_contract_storage_value`

Description

This beerus endpoint will return the specified storage value after being verified with the contract state root + the starknet state root
Function:

pub fn get_contract_storage_value(contract_address: Felt, storage_var_key: Felt) -> Result<Felt, Error>

Acceptance criteria

• User can call get_contract_storage_value
• get_contract_storage_value has associated unit tests and integration tests
• Function is tested on testnet

Refactor code to make it test / mock friendly

Description

Currently the project is not really test friendly since it has a lot of external dependencies.
We need to make it more flexible and suitable for proper testing architecture.

The plan is to be able to use mockall to mock external dependencies.

feat: `l2ToL1Messages`

Feature Request

Describe the Feature Request

As a user, I would like to query l2ToL1Messages of the StarkNetCore contract.

Describe Preferred Solution

l2ToL1Messages is accessible in the core library, and as a CLI command, and a REST API endpoint.

Describe Alternatives

Related Code

• beerus_core

• beerus_cli

• beerus_rest_api

• Yes

• No

Implement `verify_storage_proofs`

Description

We need to implement the verification of the storage proof when we access StarkNet state.
To do that we must use pathfinder_getStorageProofs endpoint.

The PR in PathFinder is here: eqlabs/pathfinder#726
It has been merge.

Acceptance criteria

• verify_storage_proofs is implemented in core library
• associated unit tests are implemented
• implementation is tested against a path finder node on a testnet

CLI and Rest API Wrapper will be done in follow up PRs.

feat: `l1ToL2Messages`

Feature Request

Describe the Feature Request

As a user, I would like to query l1ToL2Messages of the StarkNetCore contract.

Describe Preferred Solution

l1ToL2Messages is accessible in the core library, and as a CLI command, and a REST API endpoint.

Describe Alternatives

Related Code

• beerus_core

• beerus_cli

• beerus_rest_api

• Yes

• No

feat: Starknet RPC " get_transaction_by_hash" call

Description

Implement "get_transaction_by_hash" Starknet RPC call

Starknet-RS Implementation
https://github.com/xJonathanLEI/starknet-rs/blob/da72d0130eb48cc84288c9948d983f5f78cf6054/starknet-providers/src/jsonrpc/mod.rs#L187

Acceptance Criteria

• Beerus can query a Starknet's block number
• Associated cli command
• Associated rest api wrapper
• Helios integration
• Units tests
• Integration tests

bug: fresh install shows `sh: line 121: beerus_cli: command not found`

Bug Report

Beerus version: 0.1.0

Current behavior:

When doing a fresh install of beerusup using

curl -sL https://raw.githubusercontent.com/keep-starknet-strange/beerus/main/beerusup | sh

beerus_cli is added to path but line 121 throws an error because it's being called as if it has been added to $PATH but the $PROFILE hasn't been sourced yet.

Expected behavior:

No error and instead version is shown.

Steps to reproduce:

Do a fresh install of beerusup using

curl -sL https://raw.githubusercontent.com/keep-starknet-strange/beerus/main/beerusup | sh

Related code:

Other information:

feat: Ethereum RPC "get_block_transaction_count_by_hash" call

Description

Implement "get_block_transaction_count_by_hash" Ethereum RPC call

Helios implmentation: https://github.com/a16z/helios/blob/ac8a145ae33e72b62e017749fd0d3e1887d3999e/client/src/rpc.rs#L61

Acceptance Criteria

• Beerus can query a Ethereum's block txs count given a block hash
• Associated cli command
• Associated rest api wrapper
• Helios integration
• Units tests
• Integration tests

feat: Starknet RPC " chain_id" call

Description

Implement "chain_id" Starknet RPC call

Starknet-RS Implementation
https://github.com/xJonathanLEI/starknet-rs/blob/da72d0130eb48cc84288c9948d983f5f78cf6054/starknet-providers/src/jsonrpc/mod.rs#L342

Acceptance Criteria

• Beerus can query a Starknet's block number
• Associated cli command
• Associated rest api wrapper
• Helios integration
• Units tests
• Integration tests

Switch to using Rust workspace

Description

Use Rust workspace for the project.

Specifically the workspace must have the following members:

• core
• cli
• rest-api

feat: Ethereum RPC "estimate_gas" call

Description

Implement "estimate_gas" Ethereum RPC call

Helios implmentation: https://github.com/a16z/helios/blob/ac8a145ae33e72b62e017749fd0d3e1887d3999e/client/src/rpc.rs#L70

Acceptance Criteria

• Beerus can estimate Ethereum's transaction gas
• Associated cli command
• Associated rest api wrapper
• Helios integration
• Units tests
• Integration tests

Initiate PathFinder endpoints client

Description

We need to implement a client to consume PathFinder endpoints

Acceptance Criteria

• PathFinder client is implemented and enable to consume full node endpoints
  • for this ticket we consider the work done when one endpoint is fully implemented
• Associated test should be created and pass

feat: Ethereum RPC " chain_id" call

Description

Implement "chain_id" Ethereum RPC call

Helios implmentation: https://github.com/a16z/helios/blob/94bf458d941f30e34faeaa7d2484898dba54234d/client/src/rpc.rs#L67

Acceptance Criteria

• Beerus can query a Ethereum's block number
• Associated cli command
• Associated rest api wrapper
• Helios integration
• Units tests
• Integration tests

Increase Beerus core coverage to 90%

Description

Beerus needs to be fully tested so we need to increase the test coverage

Acceptance criteria

Beerus core coverage is at least at 90%

dev: add tests for storage proofs

Currently, only a single test is present for storage proof. It would be nice to add some more complicated tests (see #120 )

I imagine this can go hand-in-hand with #20

Implement beerusup command to install smoothly

Description

Add a handy script to install beerus.

Inspiration: https://github.com/a16z/helios/blob/master/heliosup/install

Acceptance Criteria

• script is created and enable to install beerus very easily
• readme is modified with instructions (c.f https://github.com/a16z/helios#installing)

feat: Ethereum RPC "estimate_gas" call

Description

Implement "estimate_gas" Ethereum RPC call

Helios implmentation: https://github.com/a16z/helios/blob/94bf458d941f30e34faeaa7d2484898dba54234d/client/src/rpc.rs#L65

Acceptance Criteria

• Beerus can query a Ethereum's block number
• Associated cli command
• Associated rest api wrapper
• Helios integration
• Units tests
• Integration tests

feat: Starknet RPC " block_number" call

Description

Implement "block_number" Starknet RPC call

Starknet-RS Implementation
https://github.com/xJonathanLEI/starknet-rs/blob/da72d0130eb48cc84288c9948d983f5f78cf6054/starknet-providers/src/jsonrpc/mod.rs#L329

Acceptance Criteria

• Beerus can query a Starknet's block number
• Associated cli command
• Associated rest api wrapper
• Helios integration
• Units tests
• Integration tests

Support for OpenAPI specification

Description

The Rest API should support Open API specification.

https://spec.openapis.org/oas/latest.html

feat: `l1ToL2MessageCancellations`

Feature Request

Describe the Feature Request

As a user, I would like to query l1ToL2MessageCancellations of the StarkNetCore contract.

Describe Preferred Solution

l1ToL2MessageCancellations is accessible in the core library, and as a CLI command, and a REST API endpoint.

Describe Alternatives

Related Code

• beerus_core

• beerus_cli

• beerus_rest_api

• Yes

• No

feat: Ethereum RPC "get_transaction_count" call

Description

Implement "get_transaction_count" Ethereum RPC call

Helios implmentation: https://github.com/a16z/helios/blob/ac8a145ae33e72b62e017749fd0d3e1887d3999e/client/src/rpc.rs#L59

Acceptance Criteria

• Beerus can query a Ethereum's txs count
• Associated cli command
• Associated rest api wrapper
• Helios integration
• Units tests
• Integration tests

feat: Ethereum RPC "max_priority_fee_per_gas" call

Description

Implement "max_priority_fee_per_gas" Ethereum RPC call

Helios implmentation: https://github.com/a16z/helios/blob/ac8a145ae33e72b62e017749fd0d3e1887d3999e/client/src/rpc.rs#L76

Acceptance Criteria

• Beerus can query a Ethereum's max priority fee per gas
• Associated cli command
• Associated rest api wrapper
• Helios integration
• Units tests
• Integration tests

feat: `l1ToL2MessageNonce`

Feature Request

Describe the Feature Request

As a user, I would like to query l1ToL2MessageNonce of the StarkNetCore contract.

Describe Preferred Solution

l1ToL2MessageNonce is accessible in the core library, and as a CLI command, and a REST API endpoint.

Describe Alternatives

Related Code

• beerus_core

• beerus_cli

• beerus_rest_api

• Yes

• No

Implement endpoint to retrieve StarkNet state root

Description

We should expose a library endpoint to retrieve StarkNet state root.

Things to consider:
- What is the value of the StarkNet contract address? (hardcoded, configurable, etc)

We decided to have the StarkNet contract address configurable, defaulted with a hardcoded value (likely a mapping of known networks to contract address).

Acceptance criteria

• library endpoint is implemented
• endpoint is properly tested

Test `starknet_state_root` in `BeerusLightClient`

Description

Now that we have a testable and mockable architecture, we can start to increase the test coverage of the project.

Let's start with the starknet_state_root of BeerusLightClient.

Acceptance criteria

• Integrate mockall crate and setup test archi
• Nominal case for starknet_state_root is tested
• Error cases for starknet_state_root are tested

Create PathFinder full node instance

Description

The light client needs a connection to a full node in order to operate.
Note that this connection is trustless and can be insecure, since the light client verifies storage proofs.

Acceptance criteria

• instance of PathFinder is created on AWS
• instance is publicly accessible

feat: Ethereum RPC "query_block_number" call

Description

Implement "query_block_number" Ethereum RPC call

Helios implmentation: https://github.com/a16z/helios/blob/94bf458d941f30e34faeaa7d2484898dba54234d/client/src/rpc.rs#L73

Acceptance Criteria

• Beerus can query a Ethereum's block number
• Associated cli command
• Associated rest api wrapper
• Helios integration
• Units tests
• Integration tests

CLI wrapper for `starknet_state_root`

feat: Ethereum RPC " get_block_by_number" call

Description

Implement "get_block_by_number" Ethereum RPC call

Helios implmentation: https://github.com/a16z/helios/blob/94bf458d941f30e34faeaa7d2484898dba54234d/client/src/rpc.rs#L75

Acceptance Criteria

• Beerus can query a Ethereum's block number
• Associated cli command
• Associated rest api wrapper
• Helios integration
• Units tests
• Integration tests

Rest wrapper for `starknet_state_root`

Setup integration testing infrastructure

Description

Setup an infrastructure for integration testing.

Should include:

• CI
• deployment scripts
• integrations tests

Create empty `get_contract_storage_value` endpoint

Description

In order to prepare the get_contract_storage_value we need to have the structure of the endpoint in the library, cli and rest api.

Acceptance criteria

• Create the beerus client empty shell endpoint get_contract_storage_value
• Associated cli call command
• Associated rest api wrapper
• Test structure for each new function
• Starknet.rs Felt type integration

Testing of Rest API endpoints using Rocket

Description

We should test the REST API endpoints using rocket testing capabilities. See https://rocket.rs/v0.5-rc/guide/testing/

feat: Starknet RPC "block_hash_and_number" call

Description

Implement "block_hash_and_number" Starknet RPC call

Starknet-RS Implementation
https://github.com/xJonathanLEI/starknet-rs/blob/da72d0130eb48cc84288c9948d983f5f78cf6054/starknet-providers/src/jsonrpc/mod.rs#L334

Acceptance Criteria

• Beerus can query a Starknet's block number
• Associated cli command
• Associated rest api wrapper
• Helios integration
• Units tests
• Integration tests

feat: Ethereum RPC "gas_price" call

Description

Implement "gas_price" Ethereum RPC call

Helios implmentation: https://github.com/a16z/helios/blob/94bf458d941f30e34faeaa7d2484898dba54234d/client/src/rpc.rs#L69

Acceptance Criteria

• Beerus can query a Ethereum's block number
• Associated cli command
• Associated rest api wrapper
• Helios integration
• Units tests
• Integration tests

Implement `get_contract_storage_proof`

Description

In order to verify the value sent by the full node we need the contract storage proof.

Acceptance criteria

• Beerus can query a starknet full node to get the contract storage root
• Associated cli command
• Associated rest api wrapper
• Starknet.rs full node integration
• Units tests
• Integration tests

Implement get last proved block

Description

We need the latest proved block for starknet to know the block number for pathfinder query

Acceptance criteria

• Fetches the last proven block https://goerli.etherscan.io/address/0xde29d060D45901Fb19ED6C6e959EB22d8626708e#readProxyContract#F14