BoundlessMarket

Inherits: IBoundlessMarket, Initializable, EIP712Upgradeable, Ownable2StepUpgradeable, UUPSUpgradeable

State Variables

VERSION

The version of the contract, with respect to upgrades.

uint64 public constant VERSION = 1;

requestLocks

Mapping of request ID to lock-in state. Non-zero for requests that are locked in.

mapping(RequestId => RequestLock) public requestLocks;

accounts

Mapping of address to account state.

mapping(address => Account) internal accounts;

VERIFIER

Note: oz-upgrades-unsafe-allow: state-variable-immutable

IRiscZeroVerifier public immutable VERIFIER;

ASSESSOR_ID

Note: oz-upgrades-unsafe-allow: state-variable-immutable

bytes32 public immutable ASSESSOR_ID;

imageUrl

string private imageUrl;

STAKE_TOKEN_CONTRACT

Note: oz-upgrades-unsafe-allow: state-variable-immutable

address public immutable STAKE_TOKEN_CONTRACT;

DEFAULT_MAX_GAS_FOR_VERIFY

If no selector is specified as part of the request's requirements, the prover must provide a proof that can be verified with at most the amount of gas specified by this constant. This requirement exists to ensure that by default, the client can then post the given proof in a new transaction as part of the application.

uint256 public constant DEFAULT_MAX_GAS_FOR_VERIFY = 50000;

SLASHING_BURN_BPS

When a prover is slashed for failing to fulfill a request, a portion of the stake is burned, and the remaining portion is either send to the prover that ultimately fulfilled the order, or to the market treasury. This fraction controls that ratio.

The fee is configured as a constant to avoid accessing storage and thus paying for the gas of an SLOAD. Can only be changed via contract upgrade.

uint256 public constant SLASHING_BURN_BPS = 7500;

MARKET_FEE_BPS

When an order is fulfilled, the market takes a fee based on the price of the order. This fraction is multiplied by the price to decide the fee.

The fee is configured as a constant to avoid accessing storage and thus paying for the gas of an SLOAD. Can only be changed via contract upgrade.

uint96 public constant MARKET_FEE_BPS = 0;

Functions

constructor

Note: oz-upgrades-unsafe-allow: constructor

constructor(IRiscZeroVerifier verifier, bytes32 assessorId, address stakeTokenContract);

initialize

function initialize(address initialOwner, string calldata _imageUrl) external initializer;

setImageUrl

function setImageUrl(string calldata _imageUrl) external onlyOwner;

_authorizeUpgrade

function _authorizeUpgrade(address newImplementation) internal override onlyOwner;

submitRequest

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;

_lockRequest

Locks the request to the prover. Deducts funds from the client for payment and funding from the prover for locking stake.

function _lockRequest(
    ProofRequest calldata request,
    bytes32 requestDigest,
    address client,
    uint32 idx,
    address prover,
    uint64 lockDeadline,
    uint64 deadline
) internal;

priceRequest

Validates the request and records the price to transient storage such that it can be fulfilled within the same transaction without taking a lock on it.

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) public;

verifyDelivery

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

function verifyDelivery(Fulfillment calldata fill, AssessorReceipt calldata assessorReceipt) public 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) public view;

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);

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)
    public
    returns (bytes memory paymentError);

fulfillBatch

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

function fulfillBatch(Fulfillment[] calldata fills, AssessorReceipt calldata assessorReceipt)
    public
    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);

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)
    public
    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)
    public
    returns (bytes[] memory paymentError);

_fulfillAndPay

Complete the fulfillment logic after having verified the app and assessor receipts.

function _fulfillAndPay(Fulfillment calldata fill, address prover) internal returns (bytes memory paymentError);

_fulfillAndPayLocked

For a request that is currently locked. Marks the request as fulfilled, and transfers payment if eligible.

It is possible for anyone to fulfill a request at any time while the request has not expired. If the request is currently locked, only the prover can fulfill it and receive payment

function _fulfillAndPayLocked(
    RequestLock memory lock,
    RequestId id,
    address client,
    uint32 idx,
    bytes32 requestDigest,
    bool fulfilled,
    address assessorProver
) internal returns (bytes memory paymentError);

_fulfillAndPayWasLocked

For a request that was locked, and now the lock has expired. Marks the request as fulfilled, and transfers payment if eligible.

It is possible for anyone to fulfill a request at any time while the request has not expired. If the request was locked, and now the lock has expired, and the request as a whole has not expired, anyone can fulfill it and receive payment.

function _fulfillAndPayWasLocked(
    RequestLock memory lock,
    RequestId id,
    address client,
    uint32 idx,
    bytes32 requestDigest,
    bool fulfilled,
    address assessorProver
) internal returns (bytes memory paymentError);

_fulfillAndPayNeverLocked

For a request that has never been locked. Marks the request as fulfilled, and transfers payment if eligible.

If a never locked request is fulfilled, but fails the requirements for payment, no payment can ever be rendered for this order in the future.

function _fulfillAndPayNeverLocked(
    RequestId id,
    address client,
    uint32 idx,
    bytes32 requestDigest,
    bool fulfilled,
    address assessorProver
) internal returns (bytes memory paymentError);

_applyMarketFee

function _applyMarketFee(uint96 proverPayment) internal returns (uint96);

_executeCallback

Execute the callback for a fulfilled request if one is specified

This function is called after payment is processed and handles any callback specified in the request

function _executeCallback(
    RequestId id,
    address callbackAddr,
    uint96 callbackGasLimit,
    bytes32 imageId,
    bytes calldata journal,
    bytes calldata seal
) internal;

submitRoot

Submit a new root to a set-verifier.

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

function submitRoot(address setVerifierAddress, 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;

imageInfo

Returns the assessor imageId and its url.

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

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() public payable;

_withdraw

function _withdraw(address account, uint256 value) internal;

withdraw

Withdraw Ether from the market.

Value is debited from msg.sender.

function withdraw(uint256 value) public;

balanceOf

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

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

withdrawFromTreasury

Withdraw funds from the market's treasury.

Value is debited from the market's account.

function withdrawFromTreasury(uint256 value) public onlyOwner;

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;

_depositStake

function _depositStake(address from, uint256 value) internal;

withdrawStake

Withdraw stake from the market.

function withdrawStake(uint256 value) public;

balanceOfStake

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

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

withdrawFromStakeTreasury

Withdraw funds from the market' stake treasury.

Value is debited from the market's account.

function withdrawFromStakeTreasury(uint256 value) public onlyOwner;

requestIsFulfilled

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

function requestIsFulfilled(RequestId id) public view returns (bool);

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 id) public 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 id) 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 id) 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 id) external view returns (uint64);

_verifyClientSignature

function _verifyClientSignature(ProofRequest calldata request, address addr, bytes calldata clientSignature)
    internal
    view
    returns (bytes32);

_extractProverAddress

function _extractProverAddress(bytes32 requestHash, bytes calldata proverSignature) internal pure returns (address);

eip712DomainSeparator

EIP 712 domain separator getter.

function eip712DomainSeparator() external view returns (bytes32);

revertWith

Internal utility function to revert with a pre-encoded error.

function revertWith(bytes memory err) internal pure;