Space and Time (SxT) Proof of SQL SDK

An SDK to help users interact with the Space and Time (SxT) TestNet and execute Proof of SQL queries.

Introduction

The Space and Time Proof of SQL SDK is a Rust crate designed to simplify the process of running SQL queries against the Space and Time TestNet and verifying the results using cryptographic proofs. It leverages the Proof of SQL framework to ensure the integrity and correctness of query results.

Installation

Add the following to your Cargo.toml:

[dependencies]
sxt-proof-of-sql-sdk = "0.1.0"

Then, run:

cargo build

Usage

Running Examples

To run the provided example that counts entries in the Ethereum core table:

cargo run --example cli -- -q "select * from ethereum.blocks" --table-ref "ethereum.blocks"

Basic Usage in Code

Here's how you can use the SxTClient in your Rust application:

use sxt_proof_of_sql_sdk::SxTClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Initialize the SxT client with necessary URLs and API key
    let client = SxTClient::new(
        "https://api.spaceandtime.dev".to_string(),
        "https://proxy.api.spaceandtime.dev".to_string(),
        "https://rpc.testnet.sxt.network".to_string(),
        "your_sxt_api_key".to_string(),
        "path/to/verifier_setup.bin".to_string(),
    );

    // Execute and verify a SQL query
    let result = client
        .query_and_verify("SELECT COUNT(*) FROM ethereum.transactions", "ethereum.transactions")
        .await?;

    println!("Query Result: {:?}", result);
    Ok(())
}

Note: Replace "your_sxt_api_key" with your actual SxT API key, and ensure the verifier_setup.bin file is correctly specified. You can use the file here or fetch the files here.

JavaScript Support

See deno and node in this repo for examples of JavaScript support.

Getting an API Key

To obtain an API key for accessing SxT services, please refer to the Space and Time docs.

License

This project is licensed under the terms of the Cryptographic Open Software License 1.0.