Report a Bug · Request a Feature · Ask a Question

Osiris

This repo contains an easy to use Starknet full node installer and tracker/monitoring script that supports any clients available on Starknet and that will be used by Starknode plug'n'play to track its performances.

💻 Installation

To install a Starknet full node and start monitoring it please run the following command:

git clone https://github.com/kasarlabs/myOsiris
cd myOsiris

Next you'll need to run the installation/manager script. You can chose to either to install and run a node (recomended):

bash setup.sh

Or also start the node monitoring using:

bash setup.sh --track

1. Chose your client

Now you need to choose a client between:

• Papyrus from Starkware (infos)
• Pathfinder from Equilibrium (infos)
• Juno from Nethermind (infos)

2. Fill your node infos

Then you'll need to enter a name for your node (can be whatever), reference your RPC url (from any RPC provider, if you dont have one yet please check this tutorial here) and you can leave the Osiris Key field empty for now (coming soon).

3. Manage your node

If you did not start the tracker or you want to stop, restart or permanently delete your node you can launch the node manager again:

bash setup.sh

It will detect if one of the 3 clients is runing and propose you to manage it:

📊 Data

At this point the following data is returned from the tracker

System monitoring

CPU tracker

• sys.cpu.last Actual CPU usage
• sys.cpu.max Max CPU usage
• sys.cpu.min Min CPU usage
• sys.cpu.avg Average CPU usage

Memory tracker

• sys.memory.last Actual memory usage
• sys.memory.max Max memory usage
• sys.memory.min Min memory usage
• sys.memory.avg Average memory usage

Storage tracker

• sys.storage.last Actual storage usage
• sys.storage.max Max storage usage
• sys.storage.min Min storage usage
• sys.storage.avg Average storage usage

Temperature tracker

• sys.temp.last Actual temperature
• sys.temp.max Max temperature
• sys.temp.min Min temperature
• sys.temp.avg Average temperature

L1 State

Last block data

• l1.Block.ParentHash Parent hash
• l1.Block.UncleHash Uncle hash
• l1.Block.Coinbase Coinbase
• l1.Block.Root State root
• l1.Block.TxHash Transactions root
• l1.Block.ReceiptHash Receipts root
• l1.Block.Difficulty Difficulty
• l1.Block.Number Block number
• l1.Block.GasLimit Gas limit
• l1.Block.GasUsed Gas used
• l1.Block.Time Timestamp
• l1.Block.Extra Extra data
• l1.Block.MixDigest Mix hash
• l1.Block.BaseFee Base fee per gas (optional)

Sync time

• l1.SyncTime.Last Last sync time
• l1.SyncTime.Min Minimum sync time
• l1.SyncTime.Max Maximum sync time
• l1.SyncTime.Avg Average sync time
• l1.SyncTime.Count Sync count

L2 State

Block data

• l2.Block.Hash Block hash
• l2.Block.Number Block number
• l2.Block.New_root New root
• l2.Block.Parent_hash Parent hash
• l2.Block.Sequencer_address Sequencer address
• l2.Block.Status Status
• l2.Block.Timestamp Timestamp
• l2.Block.Transactions Transactions
• l2.Block.Local Local

Sync time

• l2.SyncTime.Last Last sync time
• l2.SyncTime.Min Minimum sync time
• l2.SyncTime.Max Maximum sync time
• l2.SyncTime.Avg Average sync time
• l2.SyncTime.Count Sync count

📍 Roadmap

This script is the first tool of the Osiris trilogy containing an API, and an online node manager + dashboard. This project is expecting a lot of updates and maintenance. Checkout what's next:

myOsiris

• Integration of beerus light client
• Fast, Light and Full sync options
• Updated snapshot for fast sync
• More and more data + detailed config

OsirisAPI (soon)

• Get your nodes data from anywhere at any moment

Osiris (soon)

• The hearth of this project, the first Starknet node crawler and a personal space were you'll be able to check your node stats dashboard using OsirisAPI and myOsiris

Node docs (soon)

• A detailed doc around Starknet full nodes
• A comparison dashboard for each clients performances

Sequencer (soon)

• Work in progress

🌐 Contact us

This is a KasarLabs project If you need any help about myOsiris or anything else related to Starknet please feel free to open an issue or contact us via telegram here.