atlantic

Documentation

Index

• type Client
• type GenerateProofRequest
• type GenerateProofResponse
• type Layout
  • func (l Layout) MarshalJSON() ([]byte, error)
  • func (l Layout) String() string
  • func (l *Layout) UnmarshalJSON(data []byte) error
• type ListProofsRequest
• type ListProofsResponse
• type Prover
  • func (p Prover) MarshalJSON() ([]byte, error)
  • func (p Prover) String() string
  • func (p *Prover) UnmarshalJSON(data []byte) error
• type Query

Types

type Client

type Client interface {
	// Proofs
	GenerateProof(ctx context.Context, req *GenerateProofRequest) (*GenerateProofResponse, error)
	ListProofs(ctx context.Context, req *ListProofsRequest) (*ListProofsResponse, error)
	GetProof(ctx context.Context, atlanticQueryID string) (*Query, error)
}

Client defines the interface for interacting with the Atlantic API

type GenerateProofRequest

type GenerateProofRequest struct {
	PieFile []byte
	Layout  Layout
	Prover  Prover
}

Request/Response types for Proof Generation

type GenerateProofResponse

type GenerateProofResponse struct {
	AtlanticQueryID string `json:"atlanticQueryId"`
}

type Layout

type Layout int

Layout represents the supported proof layout types

const (
	LayoutUnknown Layout = iota
	LayoutAuto
	LayoutRecursive
	LayoutRecursiveWithPoseidon
	LayoutSmall
	LayoutDex
	LayoutStarknet
	LayoutStarknetWithKeccak
	LayoutDynamic
)

func (Layout) MarshalJSON

func (l Layout) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface

func (Layout) String

func (l Layout) String() string

func (*Layout) UnmarshalJSON

func (l *Layout) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface

type ListProofsRequest

type ListProofsRequest struct {
	Limit  *int `json:"limit,omitempty"`
	Offset *int `json:"offset,omitempty"`
}

Request/Response types for Listing Proofs

type ListProofsResponse

type ListProofsResponse struct {
	SharpQueries []Query `json:"sharpQueries"`
	Total        int     `json:"total"`
}

type Prover

type Prover int

Prover represents the supported prover types

const (
	ProverUnknown        Prover = iota // ProverUnknown is the unknown prover
	ProverStarkwareSharp               // ProverStarkwareSharp is the Starkware SHARP prover
)

func (Prover) MarshalJSON

func (p Prover) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface

func (Prover) String

func (p Prover) String() string

func (*Prover) UnmarshalJSON

func (p *Prover) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface

type Query

type Query struct {
	ID                string     `json:"id"`
	SubmittedByClient string     `json:"submittedByClient"`
	Status            string     `json:"status"`
	Step              string     `json:"step"`
	ProgramHash       string     `json:"programHash"`
	Layout            string     `json:"layout"`
	ProgramFactHash   string     `json:"programFactHash"`
	Price             string     `json:"price"`
	GasUsed           int64      `json:"gasUsed"`
	CreditsUsed       int64      `json:"creditsUsed"`
	TraceCreditsUsed  int64      `json:"traceCreditsUsed"`
	IsFactMocked      bool       `json:"isFactMocked"`
	Prover            Prover     `json:"prover"`
	Chain             string     `json:"chain"`
	Steps             []string   `json:"steps"`
	CreatedAt         time.Time  `json:"createdAt"`
	CompletedAt       *time.Time `json:"completedAt,omitempty"`
}

Query represents a proof generation query