Crestal Documentation

Retrieves a filtered list of deployments based on user address, proposal ID, or deployment hash parameters.

List Deployments

Comprehensive deployment configuration and status

Base proposal structure with common configuration parameters

Additional configuration parameters and setup details

Ongoing maintenance cost estimate per period

Service Level Agreement uptime guarantee in seconds

bearerAuth

Discover, Design, Deploy. Crestal is the Web3 Infrastructure Lego Platform. Build optimized architecture for your app, from 0 to Mainnet.

Introduction

Guide for getting started with Crestal Carbon testnet.

Testnet Guide

Learn how to participate in Crestal Carbon’s Testnet Incentives Program and earn Crestal Rocks.

Incentives Program Guide

Guide to earning rewards in Crestal Carbon’s referral program.

Referral Program Guide

Overview of supported networks in Crestal, including RPC endpoints, network details, and faucet options.

Supported Networks

Learn how to build a rollup with Avail, including setting up the Avail Alt DA server, configuring the OP Stack, and deploying contracts.

Build a Rollup with Avail DA and OP Stack

Build and manage AI agents with powerful capabilities

Overview

This guide will help you set up IntentKit quickly, whether you prefer using Docker for a streamlined installation or setting up a local development environment for customization and coding.

IntentKit Setup: Docker and Local Development

Agent Setup: Creation and Configuration

Create and manage custom skills for IntentKit agents

Skills Setup: Creation and Customization

Guide to integrating Twitter with IntentKit agents.

Twitter Integration

This API enables interaction with agents, their creation and management, and health monitoring of the API server.

API Overview

Check the health status of the API server.

Check API health

Sends a query to a specific agent and receives its response.

Chat with an AI agent

Retrieve a list of all agents along with their quota information.

Get all agents

Allows the creation or update of an agent’s configuration.

Create or update an agent

Learn how to integrate with Crestal as a DA provider - from listening to proposal requests to submitting your DA solution.

Solver Integration: Data Availability

This guide showcases sample code and testing steps for DA solver integration with Crestal. Use it to explore how to set up listeners, generate a test proposal, and submit it to understand the flow before implementing a production setup.

Solver Integration: Data Availability Sample Integration

This guide provides a comprehensive overview of Crestal's worker deployment process, including the architecture, smart contract functions, and API integrations.

Worker Integration: Data Availability

This guide showcases sample code and testing steps for DA worker integration with Crestal. Use it to explore how to set up listeners, submit a test deployment request and proof of deployment, to understand the flow before implementing a production setup.

Worker Integration: Data Availability Sample Integration

Performs a comprehensive health check of the API service, verifying all critical system components and dependencies are operational.

Check System Health

Generates a cryptographically secure nonce for wallet-based authentication flow. This nonce should be signed by the user's wallet to complete authentication.

Get Auth Nonce

Establishes an authenticated session using either traditional wallet-based authentication or Privy integration for Web2/Web3 unified login experience.

Authenticate User

Generates a new authentication token using the current valid session, enabling continuous authenticated access without requiring re-authentication.

Refresh Auth Token

Retrieves comprehensive project information filtered by user address, proposal ID, or deployment ID.

List User Projects

Establishes a new project record, primarily used for tracking user activity and project lifecycle in the frontend.

Create New Project

Updates project status to terminated state, initiating necessary cleanup and resource deallocation.

Terminate a Project

Updates project status to cancelled state, handling necessary cleanup while preserving project data.

Cancel an Active Project

Fetches comprehensive project information including current status, associated resources, and metadata.

Get Project Details

Modifies existing project information, primarily used for tracking user activity and project lifecycle changes.

Update Project Details

Fetches detailed information about a specific deployment including status, configuration, and associated resources.

Retrieve Deployment Information

Retrieves deployment information specific to worker nodes based on request identifier.

Fetch Worker Deployment Status

Creates a new deployment instance for worker nodes with specified configuration parameters.

Create Worker Deployment

Modifies the operational status of an existing worker deployment, reflecting its current state.

Update Worker Deployment Status

Stores dynamic Data Availability (DA) metrics including performance indicators and operational costs.

Record Node DA Metrics

Fetches current metrics and performance indicators for specified Data Availability systems.

Retrieve System Metrics for DA

Establishes a new metrics record for Data Availability systems, capturing performance and cost indicators.

Create DA Metrics Record

Fetches static configuration and capability information for Data Availability systems (Deprecated endpoint).

Fetch Legacy DA Information

Fetches static configuration and capability information for Data Availability systems.

Fetch Static Configuration for DA

Fetches historical performance metrics and indicators for Data Availability systems within a specified time range.

Retrieve Historical Performance Metrics for DA

Fetches comprehensive information about a specific proposal, including configuration and current status.

Retrieve Proposal Details

Fetches optimized proposal recommendations from solver nodes based on specified requirements.

Retrieve Solver Proposal Recommendations

Processes and records a batch of proposals from solver nodes, validating their configurations and requirements.

Submit Solver Proposals

Retrieves a comprehensive list of active worker nodes and their current operational status.

List Active Workers

Fetches detailed information about a specific worker node including performance metrics and status.

Retrieve Worker Details

Fetches comprehensive information about a specific solver node, including performance metrics and reputation data.

Fetch Solver Details

Fetches the complete chat interaction history for a specific project.

Retrieve Chat History

Transmits a new chat message to the chat processing server for handling and response.

Send Chat Message

Fetches a comprehensive list of all available platform quests and their requirements.

List Available Quests

Fetches the complete quest progression status for the authenticated user.

Retrieve User Quest Progress

Fetches the current week's quest completion status for all participating users.

Retrieve Weekly Quest Status

Fetches user's referral history including generated codes, timestamps, and claim status.

Fetch Referral Information

Validates and processes a referral code claim, updating reward status for both referrer and referee.

Process Referral Code Claim

Checks whitelist status for specific platform features and capabilities.

Check Whitelist Status

Fetches comprehensive system metrics and performance indicators across various categories.

🚀 Getting Started

🌐 Networks

🛠️ Build

🤖 IntentKit

🧠 Integrations

🔐 API Reference

Metadata

List Deployments

Authorizations

Query Parameters

Response