Document not found (404)
-This URL is invalid, sorry. Please use the navigation bar or search to continue.
- -diff --git a/book/book.toml b/book.toml similarity index 55% rename from book/book.toml rename to book.toml index b9028fd..ded0587 100644 --- a/book/book.toml +++ b/book.toml @@ -1,10 +1,10 @@ [book] -authors = ["SP1 Vector Team"] +authors = ["Ratan Kaliani"] language = "en" multilingual = false -src = "src" +src = "book" title = "SP1 Vector Documentation" [output.html] -git-repository-url = "https://github.com/yourusername/sp1-vector" +git-repository-url = "https://github.com/succinctlabs/sp1-vector" git-repository-icon = "fa-github" diff --git a/book/src/SUMMARY.md b/book/SUMMARY.md similarity index 100% rename from book/src/SUMMARY.md rename to book/SUMMARY.md diff --git a/book/book/.nojekyll b/book/book/.nojekyll deleted file mode 100644 index f173110..0000000 --- a/book/book/.nojekyll +++ /dev/null @@ -1 +0,0 @@ -This file makes sure that Github Pages doesn't process mdBook's output. diff --git a/book/book/404.html b/book/book/404.html deleted file mode 100644 index 78b0ae0..0000000 --- a/book/book/404.html +++ /dev/null @@ -1,237 +0,0 @@ - - -
- - -This URL is invalid, sorry. Please use the navigation bar or search to continue.
- -An SP1 Vector implementation has a few key components:
-SP1Vector
contract. Contains the logic for verifying SP1 Vector proofs, storing the
-latest data from the Avail chain, including the headers and data commitments. Matches the interface
-of the existing VectorX contract so it can be upgraded in-place.SP1Verifier
contract. Verifies arbitrary SP1 programs. Most chains will have canonical deployments
-upon SP1's mainnet launch. Until then, users can deploy their own SP1Verifier
contracts to verify
-SP1 programs on their chain. The SP1 Vector implementation will use the SP1Verifier
contract to verify
-the proofs of the SP1 Vector programs.SP1Vector
contract and an Avail chain, determines the block to request, requests for/generates a proof, and relays the proof to
-the SP1Vector
contract.You can find a list of actively deployed contracts in this deployments.json.
- -Here's how to deploy an SP1 Vector contract for an Avail chain.
-To deploy an SP1 Vector contract for an Avail chain do the following.
-Get the genesis parameters for the SP1Vector
contract.
cd script
-
-# Example with Avail Turing Testnet.
-AVAIL_URL=wss://turing-rpc.avail.so/ws cargo run --bin genesis --release
-
-Add the genesis parameters to /contracts/.env
mirroring contracts/.env.example
.
Parameter | Description |
---|---|
GENESIS_HEIGHT | The block height of the genesis block for the Avail chain |
GENESIS_HEADER | The header of the genesis block for the Avail chain |
GENESIS_AUTHORITY_SET_ID | The ID of the initial authority set for the Avail chain |
GENESIS_AUTHORITY_SET_HASH | The hash of the initial authority set for the Avail chain |
SP1_VECTOR_PROGRAM_VKEY | The verification key for the SP1 Vector program |
HEADER_RANGE_COMMITMENT_TREE_SIZE | The size of the Merkle tree used for header range commitments (Default 1024) |
Deploy the SP1Vector
contract with genesis parameters.
cd ../contracts
-
-forge install
-
-SP1_PROVER={mock, network} CHAINS=sepolia forge script script/Deploy.s.sol --private-key $PRIVATE_KEY --multi --broadcast --verify
-
-If you see the following error, add --legacy
to the command.
Error: Failed to get EIP-1559 fees
-
-Your deployed contract address will be printed to the terminal.
-== Return ==
-0: address <SP1_VECTOR_ADDRESS>
-
-This will be used when you run the operator in step 5.
-Export your SP1 Prover Network configuration
-# Export the PRIVATE_KEY you will use to relay proofs.
-export PRIVATE_KEY=<PRIVATE_KEY>
-
-# Optional
-# If you're using the Succinct network, set SP1_PROVER to "network". Otherwise, set it to "local" or "mock".
-export SP1_PROVER={network|local|mock}
-# Only required if SP1_PROVER is set "network".
-export SP1_PRIVATE_KEY=<SP1_PRIVATE_KEY>
-
-Run the SP1 Vector operator to update the LC continuously.
-cd ../script
-
-AVAIL_URL=wss://turing-rpc.avail.so/ws AVAIL_CHAIN_ID=turing CHAIN_ID=11155111 RPC_URL=https://ethereum-sepolia.publicnode.com/ CONTRACT_ADDRESS=<SP1_VECTOR_ADDRESS> VECTORX_QUERY_URL=https://vectorx-query.succinct.xyz
-cargo run --bin operator --release
-
-An example contract using SP1 Vector can be found on Sepolia here.
- -Implementation of zero-knowledge proof circuits for Vector, Avail's Data Attestation Bridge in SP1.
-/program
: The SP1 Vector program./primitives
: Libraries for types and helper functions used in the program./script
: Scripts for getting the contract's genesis parameters and deploying the operator to
-update the light client./services
: RPC fetcher for the script
+ the justification indexer./contracts
: The contract's source code and deployment scripts./query
: Contains the logic for querying data root proofs from the contracts. Automatically deploys to https://vectorx-query.succinct.xyz.