IEscrow

This interface outlines the functions necessary for an escrow system in a marketplace trading ERC721 and ERC20 tokens.

Any contract implementing this interface can act as an escrow in the marketplace.

CreateSale

event CreateSale(uint256 saleId, enum IEscrow.State state, address buyer, address spender, address erc20, uint256 price, bytes32 tier, address seller, address erc721, uint256 tokenId, string metadata)

Emitted when a sale is created.

UpdateSale

event UpdateSale(uint256 saleId, enum IEscrow.State newState)

Emitted when a sale's state is updated.

SaleTaxesUpdated

event SaleTaxesUpdated(uint256 saleId, uint256 amount, uint256 countryCode, uint256 regionCode)

Emitted when a sale's tax is updated.

updateSaleTaxesToCollect

function updateSaleTaxesToCollect(uint256 _saleId, struct Tax _taxes) external

Updates the sales tax for a pre-pending sale.

Parameters

Name	Type	Description
_saleId	uint256	The id of the sale.
_taxes	struct Tax	The new taxes to collect in ERC20 tokens.

RoyaltyPayout

event RoyaltyPayout(uint256 saleId, address receiver, uint256 amount)

Emitted when a royalty is paid out.

CommissionPayout

event CommissionPayout(uint256 saleId, address receiver, uint256 amount)

Emitted when a commission is paid out.

TaxCollected

event TaxCollected(uint256 saleId, address receiver, uint256 taxes, uint256 country, uint256 region)

Emitted when a sale is completed and any on-chain tax are collected/to be remitted.

SaleComplete

event SaleComplete(uint256 saleId, uint256 payoutAmount)

Emitted when a sale is complete.

SaleCancelled

event SaleCancelled(uint256 saleId, address erc20ReturnedTo, address erc721ReturnedTo)

Emitted when a sale is cancelled.

BuyerChallengeWindowChanged

event BuyerChallengeWindowChanged(uint256 numberOfHours)

Emitted when the challenge window for buyers is changed.

SaleFundingWindowChanged

event SaleFundingWindowChanged(uint256 numberOfHours)

Emitted when the funding window for a sale is changed.

State

enum State {
  AwaitingSettlement,
  AwaitingERC20Deposit,
  PendingSale,
  ProcessingSale,
  ShippingToBuyer,
  Received,
  ShippingToColleForAuthentication,
  ColleProcessingSale,
  ShippingToColleForDispute,
  IssueWithDelivery,
  IssueWithProduct,
  SaleCancelled,
  SaleSuccess
}

Sale

struct Sale {
  uint256 id;
  address buyer;
  address spender;
  address erc20;
  uint256 price;
  struct Tax taxes;
  bytes32 tier;
  address seller;
  address erc721;
  uint256 tokenId;
  enum IEscrow.State state;
  uint256 createdTimestamp;
  uint256 receivedTimestamp;
}

setBuyerChallengeWindow

function setBuyerChallengeWindow(uint256 _hours) external

Sets the time window during which buyers can challenge a sale.

Parameters

Name	Type	Description
_hours	uint256	The new challenge window in hours.

buyerChallengeWindow

function buyerChallengeWindow() external view returns (uint256)

Returns the current challenge window for buyers.

Return Values

Name	Type	Description
[0]	uint256	uint256 The challenge window in hours.

setSaleFundingWindow

function setSaleFundingWindow(uint256 _hours) external

Sets the time window during which a sale can be funded. Can only be called by the colle.

Parameters

Name	Type	Description
_hours	uint256	The new funding window in hours.

saleFundingWindow

function saleFundingWindow() external view returns (uint256)

Returns the current funding window for buyers.

Return Values

Name	Type	Description
[0]	uint256	uint256 The funding window in hours.

createSale

function createSale(address _buyer, address _spender, address _erc20, uint256 _price, address _seller, address _erc721, uint256 _tokenId) external

Creates a new sale.

Parameters

Name	Type	Description
_buyer	address	The buyer's address.
_spender	address	The address spending the ERC20 tokens.
_erc20	address	The address of the ERC20 token being used as currency.
_price	uint256	The price in ERC20 tokens.
_seller	address	The seller's address.
_erc721	address	The address of the ERC721 token being sold.
_tokenId	uint256	The id of the ERC721 token being sold.

getSale

function getSale(uint256 _saleId) external view returns (struct IEscrow.Sale)

Returns details of a sale.

Parameters

Name	Type	Description
_saleId	uint256	The id of the sale.

Return Values

Name	Type	Description
[0]	struct IEscrow.Sale	Sale The details of the sale.

hasActiveSale

function hasActiveSale(address _erc721, uint256 _tokenId) external view returns (bool)

Checks if a particular ERC721 token is currently part of an active sale.

Parameters

Name	Type	Description
_erc721	address	The address of the ERC721 token.
_tokenId	uint256	The id of the ERC721 token.

Return Values

Name	Type	Description
[0]	bool	bool Whether the token is part of an active sale or not.

updateSale

function updateSale(uint256 _saleId, enum IEscrow.State _newState) external

Updates the state of a sale.

Parameters

Name	Type	Description
_saleId	uint256	The id of the sale.
_newState	enum IEscrow.State	The new state of the sale.

permitUpdateSale

function permitUpdateSale(uint256 _saleId, enum IEscrow.State _newState, struct Signature _signature) external

Allows a signer to permit the update of a sale's state.

Parameters

Name	Type	Description
_saleId	uint256	The id of the sale.
_newState	enum IEscrow.State	The new state of the sale.
_signature	struct Signature	The signer's signature, deadline and signer address.