Interface: IGetEscrowData
All data of an escrow incl. info about the arbitrator, settlement and a role of the connected user.
Hierarchy
-
Omit<IEscrowData,"tokenAddress">↳
IGetEscrowData
Properties
amount
• amount: bigint
Amount in token's (or ETH's) wei unit
Inherited from
Omit.amount
Defined in
arbitration
• arbitration: IArbitratorInfo
Information about arbitrator or arbitrator proposal
Defined in
buyer
• buyer: string
Buyer (payer) address
Inherited from
Omit.buyer
Defined in
challengePeriod
• challengePeriod: number
How much a challenge period will extend by if challenged
Inherited from
Omit.challengePeriod
Defined in
challengePeriodEnd
• challengePeriodEnd: Date
Current challenge period end (when it will be possible to claim the payment)
Inherited from
Omit.challengePeriodEnd
Defined in
challengePeriodStart
• challengePeriodStart: Date
Current challenge period start (either payment time or the latest challenge)
Inherited from
Omit.challengePeriodStart
Defined in
connectedUser
• Optional connectedUser: tConnectedUser
User's role in the escrow ('buyer' | 'seller' | 'arbitrator' | 'marketplace' | 'other')
Defined in
consensusBuyer
• consensusBuyer: number
Indicates status of the payment from buyer's and seller's side. Negative value means that party was challenged.
Examples for various states:
0, 1: Paid - If the payment is claimed after challenge period ends, consensus remains like this
1, 1: Released by buyer
1,-1: 1x Challenged by buyer - If the payment is claimed after CP ends, consensus remains like this
-1, 2: 1x Challenged by buyer and 1x by Seller
2,-2: 2x Challenged by buyer, 1x by seller
3, 2: Released, Refunded, or Settled. Deduct 1 from each consensus number to calculate number of challenges
Inherited from
Omit.consensusBuyer
Defined in
consensusSeller
• consensusSeller: number
See consensusBuyer for details
Inherited from
Omit.consensusSeller
Defined in
createdAt
• Optional createdAt: Date
When was the payment sent to the escrow
Inherited from
Omit.createdAt
Defined in
ensAddresses
• Optional ensAddresses: IEnsAddresses
ENS Addresses
Inherited from
Omit.ensAddresses
Defined in
escrowId
• escrowId: number
ID of the escrow that the transaction created or acted upon
Inherited from
Omit.escrowId
Defined in
latestSettlementOfferAddress
• Optional latestSettlementOfferAddress: string
Address that sent the latest settlement offer (if any)
Inherited from
Omit.latestSettlementOfferAddress
Defined in
latestSettlementOfferBuyer
• Optional latestSettlementOfferBuyer: number
What was the proposed seller's split in the latest settlement offer
Inherited from
Omit.latestSettlementOfferBuyer
Defined in
latestSettlementOfferSeller
• Optional latestSettlementOfferSeller: number
What was the proposed seller's split in the latest settlement offer
Inherited from
Omit.latestSettlementOfferSeller
Defined in
marketplace
• marketplace: string
Marketplace address
Inherited from
Omit.marketplace
Defined in
paymentReference
• paymentReference: string
Payment reference, e.g. order ID or information for an arbitrator
Inherited from
Omit.paymentReference
Defined in
seller
• seller: string
Seller (payee) address
Inherited from
Omit.seller
Defined in
settlement
• settlement: ISettlement
Information about the latest settlement offer (if any)
Defined in
splitBuyer
• splitBuyer: number
How much (%) of the payment is meant for the buyer (default 0)
Inherited from
Omit.splitBuyer
Defined in
splitMarketplace
• splitMarketplace: number
Marketplace fee (%)
Inherited from
Omit.splitMarketplace
Defined in
splitProtocol
• splitProtocol: number
Protocol fee (%)
Inherited from
Omit.splitProtocol
Defined in
splitSeller
• splitSeller: number
How much (%) of the payment is meant for the seller (default 100). Buyer and seller splits are "gross", i.e. before fee deduction. They are recalculated at the time of the claim based on fee and the latest status of the escrow
Inherited from
Omit.splitSeller
Defined in
status
• status: IEscrowStatus
Indicates status of the payment (claimed, latestChallengeBy, latestSettlementBy and its escrow state like 'Paid' | 'Unpaid' etc.)
Inherited from
Omit.status
Defined in
token
• token: IToken
Information about the token used in the payment
Overrides
Omit.token
Defined in
walletAddress
• Optional walletAddress: string
Address of the connected user