IBoundlessMarket

Functions

requestIsLocked

Check if the given request has been locked (i.e. accepted) by a prover.

When a request is locked, only the prover it is locked to can be paid to fulfill the job.

function requestIsLocked(RequestId requestId) external view returns (bool);

requestIsSlashed

Check if the given request resulted in the prover being slashed (i.e. request was locked in but proof was not delivered)

Note it is possible for a request to result in a slash, but still be fulfilled if for example another prover decided to fulfill the request altruistically. This function should not be used to determine if a request was fulfilled.

function requestIsSlashed(RequestId requestId) external view returns (bool);

requestIsFulfilled

Check if the given request has been fulfilled (i.e. a proof was delivered).

function requestIsFulfilled(RequestId requestId) external view returns (bool);

requestLockDeadline

For a given locked request, returns when the lock expires.

If the request is not locked, this function will revert.

function requestLockDeadline(RequestId requestId) external view returns (uint64);

requestDeadline

For a given locked request, returns when request expires.

If the request is not locked, this function will revert.

function requestDeadline(RequestId requestId) external view returns (uint64);

deposit

Deposit Ether into the market to pay for proof.

Value deposited is msg.value and it is credited to the account of msg.sender.

function deposit() external payable;

withdraw

Withdraw Ether from the market.

Value is debited from msg.sender.

function withdraw(uint256 value) external;

balanceOf

Check the deposited balance, in Ether, of the given account.

function balanceOf(address addr) external view returns (uint256);

withdrawFromTreasury

Withdraw funds from the market's treasury.

Value is debited from the market's account.

function withdrawFromTreasury(uint256 value) external;

withdrawFromStakeTreasury

Withdraw funds from the market' stake treasury.

Value is debited from the market's account.

function withdrawFromStakeTreasury(uint256 value) external;

depositStake

Deposit stake into the market to pay for lockin stake.

Before calling this method, the account owner must approve the contract as an allowed spender.

function depositStake(uint256 value) external;

depositStakeWithPermit

Permit and deposit stake into the market to pay for lockin stake.

This method requires a valid EIP-712 signature from the account owner.

function depositStakeWithPermit(uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s) external;

withdrawStake

Withdraw stake from the market.

function withdrawStake(uint256 value) external;

balanceOfStake

Check the deposited balance, in HP, of the given account.

function balanceOfStake(address addr) external view returns (uint256);

submitRequest

Submit a request such that it is publicly available for provers to evaluate and bid on. Any msg.value sent with the call will be added to the balance of msg.sender.

Submitting the transaction only broadcasts it, and is not a required step. This method does not validate the signature or store any state related to the request. Verifying the signature here is not required for protocol safety as the signature is checked when the request is locked, and during fulfillment (by the assessor).

function submitRequest(ProofRequest calldata request, bytes calldata clientSignature) external payable;

lockRequest

Lock the request to the prover, giving them exclusive rights to be paid to fulfill this request, and also making them subject to slashing penalties if they fail to deliver. At this point, the price for fulfillment is also set, based on the reverse Dutch auction parameters and the time at which this transaction is processed.

This method should be called from the address of the prover.

function lockRequest(ProofRequest calldata request, bytes calldata clientSignature) external;

lockRequestWithSignature

Lock the request to the prover, giving them exclusive rights to be paid to fulfill this request, and also making them subject to slashing penalties if they fail to deliver. At this point, the price for fulfillment is also set, based on the reverse Dutch auction parameters and the time at which this transaction is processed.

This method uses the provided signature to authenticate the prover.

function lockRequestWithSignature(
    ProofRequest calldata request,
    bytes calldata clientSignature,
    bytes calldata proverSignature
) external;

fulfill

Fulfill a request by delivering the proof for the application. If the order is locked, only the prover that locked the order may receive payment. If another prover delivers a proof for an order that is locked, this method will revert unless paymentRequired is set to false on the Fulfillment struct.

function fulfill(Fulfillment calldata fill, AssessorReceipt calldata assessorReceipt)
    external
    returns (bytes memory paymentError);

fulfillBatch

Fulfills a batch of requests. See IBoundlessMarket.fulfill for more information.

function fulfillBatch(Fulfillment[] calldata fills, AssessorReceipt calldata assessorReceipt)
    external
    returns (bytes[] memory paymentError);

fulfillAndWithdraw

Fulfill a request by delivering the proof for the application and withdraw from the prover balance. If the order is locked, only the prover that locked the order may receive payment. If another prover delivers a proof for an order that is locked, this method will revert unless paymentRequired is set to false on the Fulfillment struct.

function fulfillAndWithdraw(Fulfillment calldata fill, AssessorReceipt calldata assessorReceipt)
    external
    returns (bytes memory paymentError);

fulfillBatchAndWithdraw

Fulfills a batch of requests and withdraw from the prover balance. See IBoundlessMarket.fulfill for more information.

function fulfillBatchAndWithdraw(Fulfillment[] calldata fills, AssessorReceipt calldata assessorReceipt)
    external
    returns (bytes[] memory paymentError);

verifyDelivery

Verify the application and assessor receipts, ensuring that the provided fulfillment satisfies the request.

function verifyDelivery(Fulfillment calldata fill, AssessorReceipt calldata assessorReceipt) external view;

verifyBatchDelivery

Verify the application and assessor receipts for the batch, ensuring that the provided fulfillments satisfy the requests.

function verifyBatchDelivery(Fulfillment[] calldata fills, AssessorReceipt calldata assessorReceipt) external view;

priceRequest

Checks the validity of the request and then writes the current auction price to transient storage.

When called within the same transaction, this method can be used to fulfill a request that is not locked. This is useful when the prover wishes to fulfill a request, but does not want to issue a lock transaction e.g. because the stake is too high or to save money by avoiding the gas costs of the lock transaction.

function priceRequest(ProofRequest calldata request, bytes calldata clientSignature) external;

priceAndFulfill

A combined call to IBoundlessMarket.priceRequest and IBoundlessMarket.fulfill. The caller should provide the signed request and signature for each unlocked request they want to fulfill. Payment for unlocked requests will go to the provided prover address.

function priceAndFulfill(
    ProofRequest calldata request,
    bytes calldata clientSignature,
    Fulfillment calldata fill,
    AssessorReceipt calldata assessorReceipt
) external returns (bytes memory paymentError);

priceAndFulfillBatch

A combined call to IBoundlessMarket.priceRequest and IBoundlessMarket.fulfillBatch. The caller should provide the signed request and signature for each unlocked request they want to fulfill. Payment for unlocked requests will go to the provided prover address.

function priceAndFulfillBatch(
    ProofRequest[] calldata requests,
    bytes[] calldata clientSignatures,
    Fulfillment[] calldata fills,
    AssessorReceipt calldata assessorReceipt
) external returns (bytes[] memory paymentError);

priceAndFulfillAndWithdraw

A combined call to IBoundlessMarket.priceRequest and IBoundlessMarket.fulfillAndWithdraw. The caller should provide the signed request and signature for each unlocked request they want to fulfill. Payment for unlocked requests will go to the provided prover address.

function priceAndFulfillAndWithdraw(
    ProofRequest calldata request,
    bytes calldata clientSignature,
    Fulfillment calldata fill,
    AssessorReceipt calldata assessorReceipt
) external returns (bytes memory paymentError);

priceAndFulfillBatchAndWithdraw

A combined call to IBoundlessMarket.priceRequest and IBoundlessMarket.fulfillBatchAndWithdraw. The caller should provide the signed request and signature for each unlocked request they want to fulfill. Payment for unlocked requests will go to the provided prover address.

function priceAndFulfillBatchAndWithdraw(
    ProofRequest[] calldata requests,
    bytes[] calldata clientSignatures,
    Fulfillment[] calldata fills,
    AssessorReceipt calldata assessorReceipt
) external returns (bytes[] memory paymentError);

submitRoot

Submit a new root to a set-verifier.

Consider using submitRootAndFulfillBatch to submit the root and fulfill in one transaction.

function submitRoot(address setVerifier, bytes32 root, bytes calldata seal) external;

submitRootAndFulfillBatch

Combined function to submit a new root to a set-verifier and call fulfillBatch.

Useful to reduce the transaction count for fulfillments.

function submitRootAndFulfillBatch(
    address setVerifier,
    bytes32 root,
    bytes calldata seal,
    Fulfillment[] calldata fills,
    AssessorReceipt calldata assessorReceipt
) external returns (bytes[] memory paymentError);

submitRootAndFulfillBatchAndWithdraw

Combined function to submit a new root to a set-verifier and call fulfillBatchAndWithdraw.

Useful to reduce the transaction count for fulfillments.

function submitRootAndFulfillBatchAndWithdraw(
    address setVerifier,
    bytes32 root,
    bytes calldata seal,
    Fulfillment[] calldata fills,
    AssessorReceipt calldata assessorReceipt
) external returns (bytes[] memory paymentError);

slash

When a prover fails to fulfill a request by the deadline, this method can be used to burn the associated prover stake.

The provers stake has already been transferred to the contract when the request was locked. This method just burn the stake.

function slash(RequestId requestId) external;

eip712DomainSeparator

EIP 712 domain separator getter.

function eip712DomainSeparator() external view returns (bytes32);

imageInfo

Returns the assessor imageId and its url.

function imageInfo() external view returns (bytes32, string memory);

STAKE_TOKEN_CONTRACT

Returns the address of the token used for stake deposits.

function STAKE_TOKEN_CONTRACT() external view returns (address);

Events

RequestSubmitted

Event logged when a new proof request is submitted by a client.

Note that the signature is not verified by the contract and should instead be verified by the receiver of the event.

event RequestSubmitted(RequestId indexed requestId);

RequestLocked

Event logged when a request is locked in by the given prover.

event RequestLocked(RequestId indexed requestId, address prover);

RequestFulfilled

Event logged when a request is fulfilled.

event RequestFulfilled(RequestId indexed requestId);

ProofDelivered

Event logged when a proof is delivered that satisfies the request's requirements.

It is possible for this event to be logged multiple times for a single request. This is usually logged as part of order fulfillment, however it can also be logged by a prover sending the proof without payment.

event ProofDelivered(RequestId indexed requestId);

ProverSlashed

Event when a prover is slashed is made to the market.

event ProverSlashed(RequestId indexed requestId, uint256 stakeBurned, uint256 stakeTransferred, address stakeRecipient);

Deposit

Event when a deposit is made to the market.

event Deposit(address indexed account, uint256 value);

Withdrawal

Event when a withdrawal is made from the market.

event Withdrawal(address indexed account, uint256 value);

StakeDeposit

Event when a stake deposit is made to the market.

event StakeDeposit(address indexed account, uint256 value);

StakeWithdrawal

Event when a stake withdrawal is made to the market.

event StakeWithdrawal(address indexed account, uint256 value);

Upgraded

Event when the contract is upgraded to a new version.

event Upgraded(uint64 indexed version);

PaymentRequirementsFailed

Event emitted during fulfillment if a request was fulfilled, but payment was not transferred because at least one condition was not met. See the documentation on IBoundlessMarket.fulfillBatch for more information.

The payload of the event is an ABI encoded error, from the errors on this contract. If there is an unexpired lock on the request, the order, the prover holding the lock may still be able to receive payment by sending another transaction.

event PaymentRequirementsFailed(bytes error);

CallbackFailed

Event emitted when a callback to a contract fails during fulfillment

event CallbackFailed(RequestId indexed requestId, address callback, bytes error);

Errors

RequestIsLocked

Error when a request is locked when it was not required to be.

error RequestIsLocked(RequestId requestId);

RequestIsExpiredOrNotPriced

Error when a request is expired or not priced when it was required to be. Either locking the request, or calling the IBoundlessMarket.priceRequest function in the same transaction will satisfy this requirement.

error RequestIsExpiredOrNotPriced(RequestId requestId);

RequestIsNotLocked

Error when a request is not locked when it was required to be.

error RequestIsNotLocked(RequestId requestId);

RequestIsFulfilled

Error when a request is fulfilled when it was not required to be.

error RequestIsFulfilled(RequestId requestId);

RequestIsSlashed

Error when a request is slashed when it was not required to be.

error RequestIsSlashed(RequestId requestId);

RequestLockIsExpired

Error when a request lock is no longer valid, as the lock deadline has passed.

error RequestLockIsExpired(RequestId requestId, uint64 lockDeadline);

RequestIsExpired

Error when a request is no longer valid, as the deadline has passed.

error RequestIsExpired(RequestId requestId, uint64 deadline);

RequestIsNotExpired

Error when a request is still valid, as the deadline has yet to pass.

error RequestIsNotExpired(RequestId requestId, uint64 deadline);

InvalidRequestFulfillment

Error when request being fulfilled doesn't match the request that was locked.

This can happen if a client signs multiple requests with the same ID (i.e. multiple versions of the same request) and a prover locks one version but then tries to call fulfill using a different version.

error InvalidRequestFulfillment(RequestId requestId, bytes32 provided, bytes32 locked);

InsufficientBalance

Error when unable to complete request because of insufficient balance.

error InsufficientBalance(address account);

InvalidSignature

Error when a signature did not pass verification checks.

error InvalidSignature();

InvalidRequest

Error when a request is malformed or internally inconsistent.

error InvalidRequest();

TransferFailed

Error when transfer of funds to an external address fails.

error TransferFailed();

SelectorMismatch

Error when providing a seal with a different selector than required.

error SelectorMismatch(bytes4 required, bytes4 provided);

BatchSizeExceedsLimit

Error when the batch size exceeds the limit.

error BatchSizeExceedsLimit(uint256 batchSize, uint256 limit);