Skip to main content

​
Canonical repository

Satellite source code and deployment metadata live in:

​
Deployed contract sets

The repository includes environment deployment manifests:
  • deployments/prod.json
  • deployments/stage.json
These files map chain IDs to satellite contract addresses and known cross-chain connections.

​
Interface entry points

For Solidity integrations, start from:
  • solidity/src/interfaces/ISatellite.sol
This interface aggregates module surfaces, including:
  • fact reads/proving interfaces,
  • MMR state and growth operations,
  • messaging and registry functions,
  • data processor task authentication methods.

​
Importing into your project

​
NPM dependency

npm install https://github.com/HerodotusDev/satellite

import { ISatellite } from "@HerodotusDev/satellite/solidity/src/interfaces/ISatellite.sol";

​
Foundry dependency

forge install HerodotusDev/satellite

import { ISatellite } from "lib/satellite/solidity/src/interfaces/ISatellite.sol";
With remapping: 
remappings = [
  "@HerodotusDev/satellite/=lib/satellite/",
]
For practical integration:
  1. Read For End Users.
  2. Review Storage Proof API Contracts docs.
  3. Use environment deployment manifests for target chain addresses.
  4. Integrate only the specific read/prove surfaces your contract needs.