SDK

The Aligned SDK aims to help developers interact with Aligned in a simple way. Some of its functionalities include submitting and verifying proofs through the Aligned Batcher, as well as checking the inclusion of the verified proofs on-chain. This guide provides an overview of the SDK, its installation, usage, and API details.

You can check the list of supported verifiers here.

Installation

To use this SDK in your Rust project, add the following to your Cargo.toml:

[dependencies]
aligned-sdk = { git = "https://github.com/yetanotherco/aligned_layer", tag="v0.3.0" }

To find the latest release tag go to releases and copy the version of the release that has the latest badge.

API Reference

submit

Submits a proof to the batcher to be verified and returns an aligned verification data struct.

pub async fn submit(
    batcher_addr: &str,
    verification_data: &VerificationData,
    wallet: Wallet<SigningKey>,
) -> Result<Option<AlignedVerificationData>, errors::SubmitError>

Arguments

batcher_addr - The address of the batcher to which the proof will be submitted.
verification_data - The verification data for the proof.
wallet - The wallet used to sign the proof.

Returns

Result<Option<AlignedVerificationData>>, SubmitError> - An aligned verification data or an error.

Errors

MissingRequiredParameter if the verification data vector is empty.
ProtocolVersionMismatch if the version of the SDK is lower than the expected one.
UnexpectedBatcherResponse if the batcher doesn't respond with the expected message.
SerializationError if there is an error deserializing the message sent from the batcher.
WebSocketConnectionError if there is an error connecting to the batcher.
WebSocketClosedUnexpectedlyError if the connection with the batcher is closed unexpectedly.
GenericError if the error doesn't match any of the previous ones.

submit_multiple

Submits multiple proofs to the batcher to be verified and returns an aligned verification data array.

pub async fn submit_multiple(
    batcher_addr: &str,
    verification_data: &[VerificationData],
    wallet: Wallet<SigningKey>,
) -> Result<Option<Vec<AlignedVerificationData>>, errors::SubmitError>

Arguments

batcher_addr - The address of the batcher to which the proof will be submitted.
verification_data - A verification data array.
wallet - The wallet used to sign the proof.

Returns

Result<Option<Vec<AlignedVerificationData>>>, SubmitError> - An aligned verification data array or an error.

Errors

MissingRequiredParameter if the verification data vector is empty.
ProtocolVersionMismatch if the version of the SDK is lower than the expected one.
UnexpectedBatcherResponse if the batcher doesn't respond with the expected message.
SerializationError if there is an error deserializing the message sent from the batcher.
WebSocketConnectionError if there is an error connecting to the batcher.
WebSocketClosedUnexpectedlyError if the connection with the batcher is closed unexpectedly.
GenericError if the error doesn't match any of the previous ones.

submit_and_wait

Submits a proof to the batcher to be verified, waits for the verification on ethereum and returns an aligned verification data struct.

pub async fn submit_and_wait(
    batcher_addr: &str,
    eth_rpc_url: &str,
    chain: Chain,
    verification_data: &VerificationData,
    wallet: Wallet<SigningKey>,
) -> Result<Option<AlignedVerificationData>, errors::SubmitError>

Arguments

batcher_addr - The address of the batcher to which the proof will be submitted.
eth_rpc_url - The URL of the Ethereum RPC node.
chain - The chain on which the verification will be done.
verification_data - The verification data for the proof.
wallet - The wallet used to sign the proof.

Returns

Result<Option<AlignedVerificationData>>, SubmitError> - An aligned verification data or an error.

Errors

MissingRequiredParameter if the verification data vector is empty.
ProtocolVersionMismatch if the version of the SDK is lower than the expected one.
UnexpectedBatcherResponse if the batcher doesn't respond with the expected message.
SerializationError if there is an error deserializing the message sent from the batcher.
WebSocketConnectionError if there is an error connecting to the batcher.
WebSocketClosedUnexpectedlyError if the connection with the batcher is closed unexpectedly.
EthereumProviderError if there is an error in the connection with the RPC provider.
HexDecodingError if there is an error decoding the Aligned service manager contract address.
BatchVerificationTimeout if there is a timeout waiting for the batch verification.
GenericError if the error doesn't match any of the previous ones.

submit_multiple_and_wait

Submits multiple proofs to the batcher to be verified, waits for the verification on Ethereum and returns an aligned verification data array.

pub async fn submit_multiple_and_wait(
    batcher_addr: &str,
    eth_rpc_url: &str,
    chain: Chain,
    verification_data: &[VerificationData],
    wallet: Wallet<SigningKey>,
) -> Result<Option<Vec<AlignedVerificationData>>, errors::SubmitError>

Arguments

batcher_addr - The address of the batcher to which the proof will be submitted.
eth_rpc_url - The URL of the Ethereum RPC node.
chain - The chain on which the verification will be done.
verification_data - A verification data array.
wallet - The wallet used to sign the proof.

Returns

Result<Option<Vec<AlignedVerificationData>>>, SubmitError> - An aligned verification data array or an error.

Errors

MissingRequiredParameter if the verification data vector is empty.
ProtocolVersionMismatch if the version of the SDK is lower than the expected one.
UnexpectedBatcherResponse if the batcher doesn't respond with the expected message.
SerializationError if there is an error deserializing the message sent from the batcher.
WebSocketConnectionError if there is an error connecting to the batcher.
WebSocketClosedUnexpectedlyError if the connection with the batcher is closed unexpectedly.
EthereumProviderError if there is an error in the connection with the RPC provider.
HexDecodingError if there is an error decoding the Aligned service manager contract address.
BatchVerificationTimeout if there is a timeout waiting for the batch verification.
GenericError if the error doesn't match any of the previous ones.

verify_proof_onchain

Checks if the proof has been verified with Aligned and is included in the batch on-chain.

pub async fn verify_proof_onchain(
    aligned_verification_data: AlignedVerificationData,
    chain: Chain,
    eth_rpc_url: &str,
) -> Result<bool, errors::VerificationError>

Arguments

aligned_verification_data - The aligned verification data obtained when submitting the proofs.
chain - The chain on which the verification will be done.
eth_rpc_url - The URL of the Ethereum RPC node.

Returns

Result<bool, VerificationError> - A boolean indicating whether the proof was verified on-chain and is included in the batch or an error.

Errors

EthereumProviderError if there is an error in the connection with the RPC provider.
EthereumCallError if there is an error in the Ethereum call.
HexDecodingError if there is an error decoding the Aligned service manager contract address.

get_commitment

Generates a keccak256 hash commitment of the verification key.

pub fn get_commitment(
    content: &[u8]
) -> [u8; 32]

Arguments

content - A byte slice of the verification key.

Returns

[u8; 32] - A 32-byte array representing the keccak256 hash of the verification key.

PreviousSubmitting proofs NextIntegrating Aligned into your Application

Last updated 1 year ago