The current implementation of Escrow
and IEscrow
are partially supporting the Solidity NatSpec Format.
These are the following natspec documentation that is missing
Escrow
should add natspec at contract
level to explain the contract scope
Escrow
should add natspec documentation for the constructor
Escrow
should add natspec documentation (@inheritdoc IEscrow
) for the following functions: getPrice
, getTokenContract
, getBuyer
, getSeller
, getArbiter
, getArbiterFee
and getState
IEscrow
should add natspec at interface
level to explain the interface scope
IEscrow
should add full-natspec support to the function confirmReceipt
IEscrow
should add full-natspec support to the function initiateDispute
IEscrow
should add full-natspec support to the function resolveDispute
IEscrow
should add full-natspec support to the function getPrice
IEscrow
should add full-natspec support to the function getTokenContract
IEscrow
should add full-natspec support to the function getBuyer
IEscrow
should add full-natspec support to the function getSeller
IEscrow
should add full-natspec support to the function getArbiter
IEscrow
should add full-natspec support to the function getArbiterFee
IEscrow
should add full-natspec support to the function getState
Better UX and DX
Manual
The client should consider adding the full natspec documentation support to the Escrow
and IEscrow
contracts.
The contest is live. Earn rewards by submitting a finding.
This is your time to appeal against judgements on your submissions.
Appeals are being carefully reviewed by our judges.