GitHub Repository

Herodotus Cloud Services

Introduction

Get started with Herodotus Cloud Services in minutes

Quick Start

How to authenticate with the Herodotus Cloud Services APIs

Authentication

Legacy Authentication

Atlantic is a managed ZK Prover service that allows developers to easily integrate with StarkWare’s SHARP

Getting Started

Examples

Prepare appropriate request body based on your input and desired outcome.

Sending Query

How to check the status of your Atlantic queries

Query Status

How to download PIE and PROOF files from your Atlantic queries

Downloading PIE & PROOF

Integrity allows you to verify STARK proofs on Starknet. It also registers all verified proofs in its storage, so other Cairo contracts can access them. It is crucial to understand how programs are stored inside Integrity’s Fact Registry.

Integrity Verifier

Proof verification with [Integrity](/atlantic-legacy/integrity-verifier) using `dynamic` or `all_cairo` layouts.

Dynamic Layout on L2

Contract Addresses

Trace generation is a process of running Cairo program on given inputs and generating `pie.zip` file. Pie represents exact execution of Cairo program and is necessary for proof generation.

Trace Generation

Proof generation is a process of converting `pie.zip` file into STARK proof (`proof.json` file), which can be later verified at a lower cost compared to running the program itself and without revealing private inputs. Proof can be generated with either Starkware's Sharp Prover or Stone Prover hosted by Herodotus.

Proof Generation

STARK proofs can be verified on L1 (Ethereum), so that other contracts deployed on Ethereum can use FactRegistry contract to check whether given proof was verified.

L1 Proof Verification

STARK proofs can be verified on L2 (Starknet) with [Integrity](https://github.com/HerodotusDev/integrity) verifier, so that other contracts deployed on Starknet can use its FactRegistry contract to check whether given proof was verified.

L2 Proof Verification

Console

Swagger UI

Submit a Atlantic query. You can choose to just generate a proof or generate and verify a proof. You can also choose to use a program file + input file (we will compute trace generation for you) or a pie file.

Submit query

Get query

Provide the Atlantic query id to get the jobs for a given Atlantic query.

Get query jobs

Provide your API key to get list of Atlantic queries you have submitted.

List queries

Returns a confirmation that the server is operational

Is Alive

All about the Herodotus Data Processor (HDP)

Full Documentation

API for submitting and managing batch queries for blockchain data proofs

Handles batch queries for interacting with storage slot data.

Submit a batch query

Allows you to estimate the cost of a batch query before submitting it, the body is the same as the submit batch query body, use that endpoint for reference on how to build the body.

Estimate batch query cost

Provide the batch query id to get the status of your batch query.

Get the status of your batch query

Simple health check endpoint

Returns a list of available origin and destination chain connections

Retrieve available chain connections

Returns a dictionary of chain IDs and their corresponding names

Retrieve chain definitions

Returns a list of contracts used for supporting each chain connection

Retrieve chain connection contracts

Overview of the Data Structure Indexer API

Get all accumulators

Get root hash of an accumulator and helper data

Get peaks of a MMR

Get proofs for MMR

Get all remappers

Get remappersbinsearch path

Post remappersblocks mapped to timestamps

Get block header by timestamp

Get remapper peaks by remapper id

If you belong to any organization working with us provide us with organization name you work for. eg. starkware

Organizations

Choose the appropriate endpoint based on your input and desired outcome.

Endpoints Manual

Proof generation is a process of converting `pie.zip` file into STARK proof (`proof.json` file), which can be later verified at a lower cost compared to running the program itself. Proof can be generated with either Starkware's Sharp Prover or Stone Prover hosted by Herodotus.

Trace Generation and Proof Generation

This endpoint allows for proof generation and verification for Layer 1 (L1) in a single request. It takes a `pie.zip` file, generates a proof and verifies it in a smart contract on the Ethereum blockchain. This allows for secure on-chain verification of zero-knowledge proofs at L1 suitable for high security use cases but with potentially higher gas costs.

L1 Proof Generation Verification

You can verify your STARK proofs on Starknet (L2) using [Integrity verifier](/atlantic-legacy/integrity-verifier). It is faster and much cheaper compared to verifying on L1 and especially useful if you need an interaction with Starknet contracts.

L2 Proof Generation Verification

These endpoints provide a complete workflow for generating trace, proof and verifying the proof on L1 and L2 respectively.

L1/L2 Atlantic Query

This endpoint allows you to submit a compiled Cairo program to the program registry. Once submitted, the system registers the program and generates a unique program hash. This hash can be used for future proof and trace generation requests without needing to re-upload the program file, making the process more efficient for repeated queries.

Submit Program To Program Registry

Submit an Atlantic proof generation query

Submit an Atlantic trace generation query

Submit an Atlantic trace and proof generation query

Submit an L1 Atlantic query

Submit an L1 proof generation and verification query

Submit an L2 Atlantic query

Submit an L2 Atlantic proof generation and verification query

Submit an L2 Atlantic proof verification query

Endpoint for calculating fact hash for L1 using the provided pie file.

Calculate fact hash for L1

Endpoint for calculating fact hash for L2 using the provided pie file.

Calculate fact hash for L2

Get the list of Atlantic queries you have submitted.

Get Atlantic Query

Provide the Atlantic query ID to get the jobs for a given Atlantic query.

Get the Atlantic query jobs for a given Atlantic query

Health check endpoint

Submit a program to the program registry


    Submit a batch query to the system. The system will process the query and return a batchId and taskHashes.
    The taskHashes are the hashes of the tasks that were submitted to the system.
  

Provide your API key and the batch query id to get the status of your batch query.