renovate-bot / x-oss-byte-_-juno Goto Github PK

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

⚙️ Installation

Prerequisites

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

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 \
  --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

Goerli

Goerli2

Run Juno Using Snapshot

1. Download Snapshot

   Fetch the snapshot from the provided URL:

   curl -o juno_mainnet_166353.tar https://juno-snapshot.s3.us-east-2.amazonaws.com/mainnet/juno_mainnet_v0.6.0_166353.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_166353.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 \
     --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.12.1 support.

• JSON-RPC v0.4.0:

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

• Juno's JSON-RPC:

  • juno_version
  • juno_getTransactionStatus

• 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

Phase 2

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