SDK API Reference

API Reference

submit

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

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

Arguments

  • batcher_url - The url 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. Should be using correct chain id. See get_chain_id.

  • nonce - The nonce of the submitter address. See get_next_nonce.

Returns

  • Result<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.

  • InvalidSignature if the signature is invalid.

  • InvalidNonce if the nonce is invalid.

  • InvalidProof if the proof is invalid.

  • ProofTooLarge if the proof is too large.

  • InsufficientBalance if the sender balance is not enough or unlocked

  • ProofQueueFlushed if there is an error in the batcher and the proof queue is flushed.

  • 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_url: &str,
    verification_data: &[VerificationData],
    wallet: Wallet<SigningKey>,
    nonce: U256,
) -> Result<Vec<AlignedVerificationData>, errors::SubmitError>

Arguments

  • batcher_url - The url of the batcher to which the proof will be submitted.

  • verification_data - A verification data array.

  • wallet - The wallet used to sign the proof. Should be using correct chain id. See get_chain_id.

  • nonce - The nonce of the submitter address. See get_next_nonce.

Returns

  • Result<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.

  • InvalidSignature if the signature is invalid.

  • InvalidNonce if the nonce is invalid.

  • InvalidProof if the proof is invalid.

  • ProofTooLarge if the proof is too large.

  • InsufficientBalance if the sender balance is not enough or unlocked

  • ProofQueueFlushed if there is an error in the batcher and the proof queue is flushed.

  • GenericError if the error doesn't match any of the previous ones.

submit_and_wait_verification

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_verification(
    batcher_url: &str,
    eth_rpc_url: &str,
    chain: Chain,
    verification_data: &VerificationData,
    wallet: Wallet<SigningKey>,
    nonce: U256,
    payment_service_addr: &str,
) -> Result<AlignedVerificationData, errors::SubmitError>

Arguments

  • batcher_url - The url 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. Should be using correct chain id. See get_chain_id.

  • nonce - The nonce of the submitter address. See get_next_nonce.

  • payment_service_addr - The address of the batcher payment service contract.

Returns

  • Result<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.

  • InvalidSignature if the signature is invalid.

  • InvalidNonce if the nonce is invalid.

  • InvalidProof if the proof is invalid.

  • ProofTooLarge if the proof is too large.

  • InsufficientBalance if the sender balance is not enough or unlocked

  • ProofQueueFlushed if there is an error in the batcher and the proof queue is flushed.

  • GenericError if the error doesn't match any of the previous ones.

submit_multiple_and_wait_verification

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_verification(
    batcher_url: &str,
    eth_rpc_url: &str,
    chain: Chain,
    verification_data: &[VerificationData],
    wallet: Wallet<SigningKey>,
    nonce: U256,
    payment_service_addr: &str,
) -> Result<Vec<AlignedVerificationData>, errors::SubmitError>

Arguments

  • batcher_url - The url 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. Should be using correct chain id. See get_chain_id.

  • nonce - The nonce of the submitter address. See get_next_nonce.

  • payment_service_addr - The address of the batcher payment service contract.

Returns

  • Result<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.

  • InvalidSignature if the signature is invalid.

  • InvalidNonce if the nonce is invalid.

  • InvalidProof if the proof is invalid.

  • ProofTooLarge if the proof is too large.

  • InsufficientBalance if the sender balance is not enough or unlocked

  • ProofQueueFlushed if there is an error in the batcher and the proof queue is flushed.

  • GenericError if the error doesn't match any of the previous ones.

is_proof_verified

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

pub async fn is_proof_verified(
    aligned_verification_data: AlignedVerificationData,
    chain: Chain,
    eth_rpc_url: &str,
    payment_service_addr: &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.

  • payment_service_addr - The address of the batcher payment service contract.

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.

get_next_nonce

Returns the nonce to use for a given address.

pub async fn get_next_nonce(
    eth_rpc_url: &str,
    submitter_addr: Address,
    payment_service_addr: &str,
) -> Result<U256, errors::NonceError>

Arguments

  • eth_rpc_url - The URL of the Ethereum RPC node.

  • submitter_addr - The address of the proof submitter for which the nonce will be retrieved.

  • payment_service_addr - The address of the batcher payment service contract.

Returns

  • Result<U256, NonceError> - The nonce to use 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.

get_chain_id

Returns the chain id for a given rpc url.

Should be used before submitting proofs to the batcher. Wallet chain id needs to be set with:

wallet = wallet.with_chain_id(chain_id);

Arguments

  • eth_rpc_url - The URL of the Ethereum RPC node.

Returns

  • Result<U256, ChainIdError> - The nonce to use 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.

PreviousSDK IntroNextGenerating proofs for Aligned

Last updated