fatiudeen/juno

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

⚙️ Installation

Prerequisites

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

• Rust 1.85.1 or higher.

• A C compiler: gcc.

• Install some dependencies on your system:

  • macOS

    brew install jemalloc
    brew install pkg-config
    make install-deps

  • Ubuntu

    sudo apt-get install -y libjemalloc-dev libjemalloc2 pkg-config libbz2-dev
    make install-deps

• 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

📚 Documentation

You can find the full documentation here.

📸 Snapshots

Use the provided snapshots to quickly sync your Juno node with the current state of the network. Fresh snapshots are automatically uploaded once a week and are available under the links below.

Mainnet

Sepolia

Sepolia-Integration

Getting the size for each snapshot

$date
Thu  1 Aug 2024 09:49:30 BST

$curl -s -I -L https://juno-snapshots.nethermind.io/files/mainnet/latest | gawk -v IGNORECASE=1 '/^Content-Length/ { printf "%.2f GB\n", $2/1024/1024/1024 }'
172.47 GB

$curl -s -I -L https://juno-snapshots.nethermind.io/files/sepolia/latest | gawk -v IGNORECASE=1 '/^Content-Length/ { printf "%.2f GB\n", $2/1024/1024/1024 }'
5.67 GB

$curl -s -I -L https://juno-snapshots.nethermind.io/files/sepolia-integration/latest | gawk -v IGNORECASE=1 '/^Content-Length/ { printf "%.2f GB\n", $2/1024/1024/1024 }'
2.4 GB

Run Juno Using Snapshot

1. Download Snapshot

   Fetch the snapshot from the provided URL:

   wget -O juno_mainnet.tar https://juno-snapshots.nethermind.io/files/mainnet/latest

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.5 support.

• JSON-RPC v0.8.1 (Available under /v0_8 and default/ endpoints)

  Chain/Network Information:

  • starknet_chainId
  • starknet_specVersion
  • starknet_syncing

  Block Related:

  • starknet_blockNumber
  • starknet_blockHashAndNumber
  • starknet_getBlockWithTxHashes
  • starknet_getBlockWithTxs
  • starknet_getBlockWithReceipts
  • starknet_getBlockTransactionCount

  Transaction Related:

  • starknet_getTransactionByHash
  • starknet_getTransactionReceipt
  • starknet_getTransactionByBlockIdAndIndex
  • starknet_getTransactionStatus
  • starknet_getMessagesStatus

  State & Storage:

  • starknet_getNonce
  • starknet_getStorageAt
  • starknet_getStorageProof
  • starknet_getStateUpdate

  Contract Related:

  • starknet_getClassHashAt
  • starknet_getClass
  • starknet_getClassAt
  • starknet_getCompiledCasm
  • starknet_call

  Event Related:

  • starknet_getEvents

  Write Operations:

  • starknet_addInvokeTransaction
  • starknet_addDeclareTransaction
  • starknet_addDeployAccountTransaction

  Fee Estimation & Simulation:

  • starknet_estimateFee
  • starknet_estimateMessageFee
  • starknet_simulateTransactions

  Tracing & Debug:

  • starknet_traceTransaction
  • starknet_traceBlockTransactions

  Websocket Subscriptions:

  • starknet_subscribeNewHeads
  • starknet_subscribeEvents
  • starknet_subscribeTransactionStatus
  • starknet_subscribePendingTransactions
  • starknet_unsubscribe

• Juno's JSON-RPC:

  • juno_version

• JSON-RPC v0.7.1 (Available under /v0_7 endpoint)

• 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.

• Plugins

🛣 Roadmap

Phase 1: Permissionless access to Starknet ✅

Phase 2: Full JSON RPC Support ✅

Phase 3: Starknet decentralization begins 🚧

Phase 4: Juno becomes a Starknet Sequencer 🔜

👍 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.

For more details on how to get started, check out our contributing guidelines.

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.