Skip to content

Latest commit

 

History

History
324 lines (248 loc) · 10.7 KB

README.md

File metadata and controls

324 lines (248 loc) · 10.7 KB
Raw

Juno Logo

Juno is a golang Starknet node implementation by Nethermind with the aim of decentralising Starknet.

📌 Looking for a Starknet RPC Provider?

Access Nethermind's Starknet RPC service for free at https://data.voyager.online.

⚙️ Installation

Prerequisites

  • Golang 1.22 or higher is required to build and run the project. You can find the installer on the official Golang download page.

  • Rust.

  • A C compiler: gcc or clang.

  • Install jemalloc on your system:

    • macOS

      brew install jemalloc

    • Ubuntu

      sudo apt-get install -y libjemalloc-dev

  • To ensure a successful build, you either need to synchronize the tags from the upstream repository or create a new tag.

Build and Run

make juno
./build/juno

Use the --help flag for configuration information. Flags and their values can also be placed in a .yaml file that is passed in through --config.

Run with Docker

To run Juno with Docker, use the following command. Make sure to create the $HOME/juno directory on your local machine before running the command.

docker run -d \
  --name juno \
  -p 6060:6060 \
  -v $HOME/juno:/var/lib/juno \
  nethermind/juno \
  --http \
  --http-port 6060 \
  --http-host 0.0.0.0 \
  --db-path /var/lib/juno \
  --eth-node <YOUR-ETH-NODE>

You should replace <YOUR-ETH-NODE> with your actual Ethereum node address. If you're using Infura, your Ethereum node address might look something like: wss://mainnet.infura.io/ws/v3/your-infura-project-id. Make sure you are using the websocket URL ws/wss and not the http URL http/https.

To view logs from the Docker container, use the following command:

docker logs -f juno

📸 Snapshots

Use the provided snapshots to quickly sync your Juno node with the current state of the network.

Mainnet

Version Size Block Download Link
>=v0.9.2 182 GB 640855 juno_mainnet.tar

Sepolia

Version Size Block Download Link
>=v0.9.2 5 GB 66477 juno_sepolia.tar

Run Juno Using Snapshot

  1. Download Snapshot

    Fetch the snapshot from the provided URL:

    wget -O juno_mainnet.tar https://juno-snapshots.nethermind.dev/mainnet/juno_mainnet_v0.11.7_640855.tar

  2. Prepare Directory

    Ensure you have a directory at $HOME/snapshots. If it doesn't exist yet, create it:

    mkdir -p $HOME/snapshots

  3. Extract Tarball

    Extract the contents of the .tar file:

    tar -xvf juno_mainnet.tar -C $HOME/snapshots

  4. Run Juno

    Execute the Docker command to run Juno, ensuring that you're using the correct snapshot path $HOME/snapshots/juno_mainnet:

    docker run -d \
  --name juno \
  -p 6060:6060 \
  -v $HOME/snapshots/juno_mainnet:/var/lib/juno \
  nethermind/juno \
  --http \
  --http-port 6060 \
  --http-host 0.0.0.0 \
  --db-path /var/lib/juno \
  --eth-node <YOUR-ETH-NODE>

After following these steps, Juno should be up and running on your machine, utilizing the provided snapshot.

✔ Supported Features

  • Starknet v0.13.1 support.

  • JSON-RPC v0.7.0 (Available under /v0_7 and default/ endpoints)

    • starknet_chainId
    • starknet_blockNumber
    • starknet_blockHashAndNumber
    • starknet_getBlockWithTxHashes
    • starknet_getBlockWithTxs
    • starknet_getBlockWithReceipts
    • starknet_getTransactionByHash
    • starknet_getTransactionReceipt
    • starknet_getBlockTransactionCount
    • starknet_getTransactionByBlockIdAndIndex
    • starknet_getStateUpdate
    • starknet_getNonce
    • starknet_getStorageAt
    • starknet_getTransactionStatus
    • starknet_getClassHashAt
    • starknet_getClass
    • starknet_getClassAt
    • starknet_syncing
    • starknet_getEvents
    • starknet_call
    • starknet_estimateFee
    • starknet_addInvokeTransaction
    • starknet_addDeclareTransaction
    • starknet_addDeployAccountTransaction
    • starkent_estimateMessageFee
    • starknet_traceTransaction
    • starknet_traceBlockTransactions
    • starknet_simulateTransactions
    • starknet_specVersion

  • Juno's JSON-RPC:

    • juno_version

  • JSON-RPC v0.6.0 (Available under /v0_6 endpoint)

  • Integration of CairoVM.

  • Verification of State from L1.

  • Handle L1 and L2 Reorgs.

  • Starknet state construction and storage using a path-based Merkle Patricia trie.

  • Feeder gateway synchronisation of Blocks, Transactions, Receipts, State Updates and Classes.

  • Block and Transaction hash verification.

🛣 Roadmap

Phase 1: Permissionless access to Starknet ✅

  • Flat DB implementation of trie
  • Go implementation of crypto primitives
    • Pedersen hash
    • Starknet_Keccak
    • Felt
  • Feeder gateway synchronisation
    • State Update
    • Blocks
    • Transactions
    • Class
  • Implement the following core data structures, and their Hash calculations
    • Blocks
    • Transactions and Transaction Receipts
    • Contracts and Classes
  • Storing blocks, transactions and State updates in a local DB
  • Basic RPC (in progress)
    • starknet_chainId
    • starknet_blockNumber
    • starknet_blockHashAndNumber
    • starknet_getBlockWithTxHashes
    • starknet_getBlockWithTxs
    • starknet_getTransactionByHash
    • starknet_getTransactionReceipt
    • starknet_getBlockTransactionCount
    • starknet_getTransactionByBlockIdAndIndex
    • starknet_getStateUpdate

Phase 2: Full JSON RPC Support ✅

The focus of Phase 2 will be to Verify the state from layer 1 and implement the remaining JSON-RPC endpoints.

  • Starknet v0.11.0 support
    • Poseidon state trie support
  • Blockchain: implement blockchain reorganization logic.
  • Synchronisation: implement verification of state from layer 1.
  • JSON-RPC API v0.3.0:
    • Implement the remaining endpoints:
      • starknet_syncing
      • starknet_getNonce
      • starknet_getStorageAt
      • starknet_getClassHashAt
      • starknet_getClass
      • starknet_getClassAt
      • starknet_getEvents
  • Integration of CairoVM:
    • starknet_call
    • starknet_estimateFee
  • JSON-RPC Write API v0.3.0:
    • starknet_addInvokeTransaction
    • starknet_addDeclareTransaction
    • starknet_addDeployAccountTransaction

Phase 3: Starknet decentralization begins 🚧

Juno can synchronize Starknet state from other full nodes with the aim of decentralizing Starknet by removing the dependency from the centralized sequencer.

Snap sync is implemented, significantly reducing sync times.

Phase 4: Juno becomes a Starknet Sequencer 🔜

The decentralization of Starknet is complete! Juno becomes a sequencer and participates in L2 consensus to secure the network. Juno has multiple modes of operation: ‍

• Light client: provides fast permissionless access to Starknet with minimal verification.

• Full Node: complete verification of Starknet state along with transaction execution.

• Sequencer: secure the network by taking part in the L2 consensus mechanism.

👍 Contribute

We welcome PRs from external contributors and would love to help you get up to speed. Let us know you're interested in the Discord server and we can discuss good first issues. There are also many other ways to contribute. Here are some ideas:

  • Run a node.
  • Add a GitHub Star to the project.
  • Tweet about Juno.
  • Add a Github issue if you find a bug, or you need or want a new feature.

🤝 Partnerships

To establish a partnership with the Juno team, or if you have any suggestion or special request, feel free to reach us via email.

⚠️ License

Copyright (c) 2022-present, with the following contributors.

Juno is open-source software licensed under the Apache-2.0 License.