test: 🚧 Added fixtures for new test schema
This commit is contained in:
560
docs/P2PIX.md
560
docs/P2PIX.md
@@ -1,16 +1,8 @@
|
||||
# P2PIX
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Methods
|
||||
|
||||
### _castAddrToKey
|
||||
### \_castAddrToKey
|
||||
|
||||
```solidity
|
||||
function _castAddrToKey(address _addr) external pure returns (uint256 _key)
|
||||
@@ -18,19 +10,19 @@ function _castAddrToKey(address _addr) external pure returns (uint256 _key)
|
||||
|
||||
Public method that handles `address` to `uint256` safe type casting.
|
||||
|
||||
*Function sighash: 0x4b2ae980.*
|
||||
_Function sighash: 0x4b2ae980._
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| _addr | address | undefined |
|
||||
| Name | Type | Description |
|
||||
| ------ | ------- | ----------- |
|
||||
| \_addr | address | undefined |
|
||||
|
||||
#### Returns
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| _key | uint256 | undefined |
|
||||
| Name | Type | Description |
|
||||
| ----- | ------- | ----------- |
|
||||
| \_key | uint256 | undefined |
|
||||
|
||||
### allowedERC20s
|
||||
|
||||
@@ -38,21 +30,19 @@ Public method that handles `address` to `uint256` safe type casting.
|
||||
function allowedERC20s(contract ERC20) external view returns (bool)
|
||||
```
|
||||
|
||||
|
||||
|
||||
*Tokens allowed to serve as the underlying amount of a deposit.*
|
||||
_Tokens allowed to serve as the underlying amount of a deposit._
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| _0 | contract ERC20 | undefined |
|
||||
| Name | Type | Description |
|
||||
| ---- | -------------- | ----------- |
|
||||
| \_0 | contract ERC20 | undefined |
|
||||
|
||||
#### Returns
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| _0 | bool | undefined |
|
||||
| ---- | ---- | ----------- |
|
||||
| \_0 | bool | undefined |
|
||||
|
||||
### cancelDeposit
|
||||
|
||||
@@ -62,13 +52,13 @@ function cancelDeposit(uint256 depositID) external nonpayable
|
||||
|
||||
Enables seller to invalidate future locks made to his/her token offering order.
|
||||
|
||||
*This function does not affect any ongoing active locks.Function sighash: 0x72fada5c.*
|
||||
_This function does not affect any ongoing active locks.Function sighash: 0x72fada5c._
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| depositID | uint256 | undefined |
|
||||
| Name | Type | Description |
|
||||
| --------- | ------- | ----------- |
|
||||
| depositID | uint256 | undefined |
|
||||
|
||||
### defaultLockBlocks
|
||||
|
||||
@@ -76,16 +66,13 @@ Enables seller to invalidate future locks made to his/her token offering order.
|
||||
function defaultLockBlocks() external view returns (uint256)
|
||||
```
|
||||
|
||||
|
||||
|
||||
*Default blocks that lock will hold tokens.*
|
||||
|
||||
_Default blocks that lock will hold tokens._
|
||||
|
||||
#### Returns
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| _0 | uint256 | undefined |
|
||||
| Name | Type | Description |
|
||||
| ---- | ------- | ----------- |
|
||||
| \_0 | uint256 | undefined |
|
||||
|
||||
### deposit
|
||||
|
||||
@@ -95,21 +82,21 @@ function deposit(address _token, uint256 _amount, string _pixTarget, bytes32 all
|
||||
|
||||
Creates a deposit order based on a seller's offer of an amount of ERC20 tokens.
|
||||
|
||||
*Seller needs to send his tokens to the P2PIX smart contract.Function sighash: 0xbfe07da6.*
|
||||
_Seller needs to send his tokens to the P2PIX smart contract.Function sighash: 0xbfe07da6._
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| _token | address | undefined |
|
||||
| _amount | uint256 | undefined |
|
||||
| _pixTarget | string | Pix key destination provided by the offer's seller. |
|
||||
| allowlistRoot | bytes32 | Optional allow list merkleRoot update `bytes32` value. |
|
||||
| Name | Type | Description |
|
||||
| ------------- | ------- | ------------------------------------------------------- |
|
||||
| \_token | address | undefined |
|
||||
| \_amount | uint256 | undefined |
|
||||
| \_pixTarget | string | Pix key destination provided by the offer's seller. |
|
||||
| allowlistRoot | bytes32 | Optional allow list merkleRoot update `bytes32` value. |
|
||||
|
||||
#### Returns
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| Name | Type | Description |
|
||||
| --------- | ------- | -------------------------------------------------------------- |
|
||||
| depositID | uint256 | The `uint256` return value provided as the deposit identifier. |
|
||||
|
||||
### depositCount
|
||||
@@ -118,16 +105,11 @@ Creates a deposit order based on a seller's offer of an amount of ERC20 toke
|
||||
function depositCount() external view returns (uint256 _val)
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### Returns
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| _val | uint256 | undefined |
|
||||
| Name | Type | Description |
|
||||
| ----- | ------- | ----------- |
|
||||
| \_val | uint256 | undefined |
|
||||
|
||||
### lock
|
||||
|
||||
@@ -137,24 +119,24 @@ function lock(uint256 _depositID, address _buyerAddress, address _relayerTarget,
|
||||
|
||||
Public method designed to lock an remaining amount of the deposit order of a seller.
|
||||
|
||||
*This method can be performed either by: - An user allowed via the seller's allowlist; - An user with enough userRecord to lock the wished amount; There can only exist a lock per each `_amount` partitioned from the total `remaining` value.Locks can only be performed in valid orders.Function sighash: 0x03aaf306.*
|
||||
_This method can be performed either by: - An user allowed via the seller's allowlist; - An user with enough userRecord to lock the wished amount; There can only exist a lock per each `_amount` partitioned from the total `remaining` value.Locks can only be performed in valid orders.Function sighash: 0x03aaf306._
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| _depositID | uint256 | undefined |
|
||||
| _buyerAddress | address | The address of the buyer of a `_depositID`. |
|
||||
| _relayerTarget | address | Target address entitled to the `relayerPremim`. |
|
||||
| _relayerPremium | uint256 | The refund/premium owed to a relayer. |
|
||||
| _amount | uint256 | The deposit's remaining amount wished to be locked. |
|
||||
| merkleProof | bytes32[] | This value should be: - Provided as a pass if the `msg.sender` is in the seller's allowlist; - Left empty otherwise; |
|
||||
| expiredLocks | bytes32[] | An array of `bytes32` identifiers to be provided so to unexpire locks using this transaction gas push. |
|
||||
| Name | Type | Description |
|
||||
| ---------------- | --------- | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| \_depositID | uint256 | undefined |
|
||||
| \_buyerAddress | address | The address of the buyer of a `_depositID`. |
|
||||
| \_relayerTarget | address | Target address entitled to the `relayerPremim`. |
|
||||
| \_relayerPremium | uint256 | The refund/premium owed to a relayer. |
|
||||
| \_amount | uint256 | The deposit's remaining amount wished to be locked. |
|
||||
| merkleProof | bytes32[] | This value should be: - Provided as a pass if the `msg.sender` is in the seller's allowlist; - Left empty otherwise; |
|
||||
| expiredLocks | bytes32[] | An array of `bytes32` identifiers to be provided so to unexpire locks using this transaction gas push. |
|
||||
|
||||
#### Returns
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| Name | Type | Description |
|
||||
| ------ | ------- | ---------------------------------------------------- |
|
||||
| lockID | bytes32 | The `bytes32` value returned as the lock identifier. |
|
||||
|
||||
### mapDeposits
|
||||
@@ -163,25 +145,23 @@ Public method designed to lock an remaining amount of the deposit order of a sel
|
||||
function mapDeposits(uint256) external view returns (uint256 remaining, string pixTarget, address seller, address token, bool valid)
|
||||
```
|
||||
|
||||
|
||||
|
||||
*Seller list of deposits*
|
||||
_Seller list of deposits_
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| _0 | uint256 | undefined |
|
||||
| Name | Type | Description |
|
||||
| ---- | ------- | ----------- |
|
||||
| \_0 | uint256 | undefined |
|
||||
|
||||
#### Returns
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| remaining | uint256 | undefined |
|
||||
| pixTarget | string | undefined |
|
||||
| seller | address | undefined |
|
||||
| token | address | undefined |
|
||||
| valid | bool | undefined |
|
||||
| Name | Type | Description |
|
||||
| --------- | ------- | ----------- |
|
||||
| remaining | uint256 | undefined |
|
||||
| pixTarget | string | undefined |
|
||||
| seller | address | undefined |
|
||||
| token | address | undefined |
|
||||
| valid | bool | undefined |
|
||||
|
||||
### mapLocks
|
||||
|
||||
@@ -189,27 +169,25 @@ function mapDeposits(uint256) external view returns (uint256 remaining, string p
|
||||
function mapLocks(bytes32) external view returns (uint256 depositID, uint256 relayerPremium, uint256 amount, uint256 expirationBlock, address buyerAddress, address relayerTarget, address relayerAddress)
|
||||
```
|
||||
|
||||
|
||||
|
||||
*List of Locks.*
|
||||
_List of Locks._
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| _0 | bytes32 | undefined |
|
||||
| Name | Type | Description |
|
||||
| ---- | ------- | ----------- |
|
||||
| \_0 | bytes32 | undefined |
|
||||
|
||||
#### Returns
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| depositID | uint256 | undefined |
|
||||
| relayerPremium | uint256 | undefined |
|
||||
| amount | uint256 | undefined |
|
||||
| expirationBlock | uint256 | undefined |
|
||||
| buyerAddress | address | undefined |
|
||||
| relayerTarget | address | undefined |
|
||||
| relayerAddress | address | undefined |
|
||||
| Name | Type | Description |
|
||||
| --------------- | ------- | ----------- |
|
||||
| depositID | uint256 | undefined |
|
||||
| relayerPremium | uint256 | undefined |
|
||||
| amount | uint256 | undefined |
|
||||
| expirationBlock | uint256 | undefined |
|
||||
| buyerAddress | address | undefined |
|
||||
| relayerTarget | address | undefined |
|
||||
| relayerAddress | address | undefined |
|
||||
|
||||
### owner
|
||||
|
||||
@@ -217,16 +195,11 @@ function mapLocks(bytes32) external view returns (uint256 depositID, uint256 rel
|
||||
function owner() external view returns (address)
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### Returns
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| _0 | address | undefined |
|
||||
| Name | Type | Description |
|
||||
| ---- | ------- | ----------- |
|
||||
| \_0 | address | undefined |
|
||||
|
||||
### release
|
||||
|
||||
@@ -236,18 +209,18 @@ function release(bytes32 lockID, address _relayerTarget, uint256 pixTimestamp, b
|
||||
|
||||
Lock release method that liquidate lock orders and distributes relayer fees.
|
||||
|
||||
*This method can be called by any public actor as long the signature provided is valid.`relayerPremium` gets splitted equaly if `relayerTarget` addresses differ.If the `msg.sender` of this method and `l.relayerAddress` are the same, `msg.sender` accrues both l.amount and l.relayerPremium as userRecord credit. In case of they differing: - `lock` caller gets accrued with `l.amount` as userRecord credit; - `release` caller gets accrued with `l.relayerPremium` as userRecord credit; Function sighash: 0x4e1389ed.*
|
||||
_This method can be called by any public actor as long the signature provided is valid.`relayerPremium` gets splitted equaly if `relayerTarget` addresses differ.If the `msg.sender` of this method and `l.relayerAddress` are the same, `msg.sender` accrues both l.amount and l.relayerPremium as userRecord credit. In case of they differing: - `lock` caller gets accrued with `l.amount` as userRecord credit; - `release` caller gets accrued with `l.relayerPremium` as userRecord credit; Function sighash: 0x4e1389ed._
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| lockID | bytes32 | undefined |
|
||||
| _relayerTarget | address | Target address entitled to the `relayerPremim`. |
|
||||
| pixTimestamp | uint256 | undefined |
|
||||
| r | bytes32 | undefined |
|
||||
| s | bytes32 | undefined |
|
||||
| v | uint8 | undefined |
|
||||
| Name | Type | Description |
|
||||
| --------------- | ------- | ----------------------------------------------- |
|
||||
| lockID | bytes32 | undefined |
|
||||
| \_relayerTarget | address | Target address entitled to the `relayerPremim`. |
|
||||
| pixTimestamp | uint256 | undefined |
|
||||
| r | bytes32 | undefined |
|
||||
| s | bytes32 | undefined |
|
||||
| v | uint8 | undefined |
|
||||
|
||||
### reputation
|
||||
|
||||
@@ -257,14 +230,11 @@ function reputation() external view returns (contract IReputation)
|
||||
|
||||
███ Storage ████████████████████████████████████████████████████████████
|
||||
|
||||
|
||||
|
||||
|
||||
#### Returns
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| _0 | contract IReputation | undefined |
|
||||
| Name | Type | Description |
|
||||
| ---- | -------------------- | ----------- |
|
||||
| \_0 | contract IReputation | undefined |
|
||||
|
||||
### sellerAllowList
|
||||
|
||||
@@ -272,21 +242,19 @@ function reputation() external view returns (contract IReputation)
|
||||
function sellerAllowList(uint256) external view returns (bytes32)
|
||||
```
|
||||
|
||||
|
||||
|
||||
*Seller casted to key => Seller's allowlist merkleroot.*
|
||||
_Seller casted to key => Seller's allowlist merkleroot._
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| _0 | uint256 | undefined |
|
||||
| Name | Type | Description |
|
||||
| ---- | ------- | ----------- |
|
||||
| \_0 | uint256 | undefined |
|
||||
|
||||
#### Returns
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| _0 | bytes32 | undefined |
|
||||
| Name | Type | Description |
|
||||
| ---- | ------- | ----------- |
|
||||
| \_0 | bytes32 | undefined |
|
||||
|
||||
### setDefaultLockBlocks
|
||||
|
||||
@@ -294,15 +262,11 @@ function sellerAllowList(uint256) external view returns (bytes32)
|
||||
function setDefaultLockBlocks(uint256 _blocks) external nonpayable
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| _blocks | uint256 | undefined |
|
||||
| Name | Type | Description |
|
||||
| -------- | ------- | ----------- |
|
||||
| \_blocks | uint256 | undefined |
|
||||
|
||||
### setOwner
|
||||
|
||||
@@ -310,15 +274,11 @@ function setDefaultLockBlocks(uint256 _blocks) external nonpayable
|
||||
function setOwner(address newOwner) external nonpayable
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| newOwner | address | undefined |
|
||||
| Name | Type | Description |
|
||||
| -------- | ------- | ----------- |
|
||||
| newOwner | address | undefined |
|
||||
|
||||
### setReputation
|
||||
|
||||
@@ -326,15 +286,11 @@ function setOwner(address newOwner) external nonpayable
|
||||
function setReputation(contract IReputation _reputation) external nonpayable
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| _reputation | contract IReputation | undefined |
|
||||
| Name | Type | Description |
|
||||
| ------------ | -------------------- | ----------- |
|
||||
| \_reputation | contract IReputation | undefined |
|
||||
|
||||
### setRoot
|
||||
|
||||
@@ -342,16 +298,12 @@ function setReputation(contract IReputation _reputation) external nonpayable
|
||||
function setRoot(address addr, bytes32 merkleroot) external nonpayable
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| addr | address | undefined |
|
||||
| merkleroot | bytes32 | undefined |
|
||||
| Name | Type | Description |
|
||||
| ---------- | ------- | ----------- |
|
||||
| addr | address | undefined |
|
||||
| merkleroot | bytes32 | undefined |
|
||||
|
||||
### setValidSigners
|
||||
|
||||
@@ -359,15 +311,11 @@ function setRoot(address addr, bytes32 merkleroot) external nonpayable
|
||||
function setValidSigners(address[] _validSigners) external nonpayable
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| _validSigners | address[] | undefined |
|
||||
| Name | Type | Description |
|
||||
| -------------- | --------- | ----------- |
|
||||
| \_validSigners | address[] | undefined |
|
||||
|
||||
### tokenSettings
|
||||
|
||||
@@ -375,16 +323,12 @@ function setValidSigners(address[] _validSigners) external nonpayable
|
||||
function tokenSettings(address[] _tokens, bool[] _states) external nonpayable
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| _tokens | address[] | undefined |
|
||||
| _states | bool[] | undefined |
|
||||
| Name | Type | Description |
|
||||
| -------- | --------- | ----------- |
|
||||
| \_tokens | address[] | undefined |
|
||||
| \_states | bool[] | undefined |
|
||||
|
||||
### unlockExpired
|
||||
|
||||
@@ -394,13 +338,13 @@ function unlockExpired(bytes32[] lockIDs) external nonpayable
|
||||
|
||||
Unlocks expired locks.
|
||||
|
||||
*Triggered in the callgraph by both `lock` and `withdraw` functions.This method can also have any public actor as its `tx.origin`.For each successfull unexpired lock recovered, `userRecord[_castAddrToKey(l.relayerAddress)]` is decreased by half of its value.Function sighash: 0x8e2749d6.*
|
||||
_Triggered in the callgraph by both `lock` and `withdraw` functions.This method can also have any public actor as its `tx.origin`.For each successfull unexpired lock recovered, `userRecord[_castAddrToKey(l.relayerAddress)]` is decreased by half of its value.Function sighash: 0x8e2749d6._
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| lockIDs | bytes32[] | undefined |
|
||||
| Name | Type | Description |
|
||||
| ------- | --------- | ----------- |
|
||||
| lockIDs | bytes32[] | undefined |
|
||||
|
||||
### userRecord
|
||||
|
||||
@@ -408,21 +352,19 @@ Unlocks expired locks.
|
||||
function userRecord(uint256) external view returns (uint256)
|
||||
```
|
||||
|
||||
|
||||
|
||||
*Stores an relayer's last computed credit.*
|
||||
_Stores an relayer's last computed credit._
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| _0 | uint256 | undefined |
|
||||
| Name | Type | Description |
|
||||
| ---- | ------- | ----------- |
|
||||
| \_0 | uint256 | undefined |
|
||||
|
||||
#### Returns
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| _0 | uint256 | undefined |
|
||||
| Name | Type | Description |
|
||||
| ---- | ------- | ----------- |
|
||||
| \_0 | uint256 | undefined |
|
||||
|
||||
### validBacenSigners
|
||||
|
||||
@@ -430,21 +372,19 @@ function userRecord(uint256) external view returns (uint256)
|
||||
function validBacenSigners(uint256) external view returns (bool)
|
||||
```
|
||||
|
||||
|
||||
|
||||
*List of valid Bacen signature addresses*
|
||||
_List of valid Bacen signature addresses_
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| _0 | uint256 | undefined |
|
||||
| Name | Type | Description |
|
||||
| ---- | ------- | ----------- |
|
||||
| \_0 | uint256 | undefined |
|
||||
|
||||
#### Returns
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| _0 | bool | undefined |
|
||||
| ---- | ---- | ----------- |
|
||||
| \_0 | bool | undefined |
|
||||
|
||||
### withdraw
|
||||
|
||||
@@ -454,14 +394,14 @@ function withdraw(uint256 depositID, bytes32[] expiredLocks) external nonpayable
|
||||
|
||||
Seller's expired deposit fund sweeper.
|
||||
|
||||
*A seller may use this method to recover tokens from expired deposits.Function sighash: 0x36317972.*
|
||||
_A seller may use this method to recover tokens from expired deposits.Function sighash: 0x36317972._
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| depositID | uint256 | undefined |
|
||||
| expiredLocks | bytes32[] | undefined |
|
||||
| Name | Type | Description |
|
||||
| ------------ | --------- | ----------- |
|
||||
| depositID | uint256 | undefined |
|
||||
| expiredLocks | bytes32[] | undefined |
|
||||
|
||||
### withdrawBalance
|
||||
|
||||
@@ -469,12 +409,7 @@ Seller's expired deposit fund sweeper.
|
||||
function withdrawBalance() external nonpayable
|
||||
```
|
||||
|
||||
|
||||
|
||||
*Contract's underlying balance withdraw method.Function sighash: 0x5fd8c710.*
|
||||
|
||||
|
||||
|
||||
_Contract's underlying balance withdraw method.Function sighash: 0x5fd8c710._
|
||||
|
||||
## Events
|
||||
|
||||
@@ -484,16 +419,12 @@ function withdrawBalance() external nonpayable
|
||||
event AllowedERC20Updated(address indexed token, bool indexed state)
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| token `indexed` | address | undefined |
|
||||
| state `indexed` | bool | undefined |
|
||||
| Name | Type | Description |
|
||||
| --------------- | ------- | ----------- |
|
||||
| token `indexed` | address | undefined |
|
||||
| state `indexed` | bool | undefined |
|
||||
|
||||
### DepositAdded
|
||||
|
||||
@@ -503,16 +434,14 @@ event DepositAdded(address indexed seller, uint256 depositID, address token, uin
|
||||
|
||||
███ Events ████████████████████████████████████████████████████████████
|
||||
|
||||
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| seller `indexed` | address | undefined |
|
||||
| depositID | uint256 | undefined |
|
||||
| token | address | undefined |
|
||||
| amount | uint256 | undefined |
|
||||
| Name | Type | Description |
|
||||
| ---------------- | ------- | ----------- |
|
||||
| seller `indexed` | address | undefined |
|
||||
| depositID | uint256 | undefined |
|
||||
| token | address | undefined |
|
||||
| amount | uint256 | undefined |
|
||||
|
||||
### DepositClosed
|
||||
|
||||
@@ -520,16 +449,12 @@ event DepositAdded(address indexed seller, uint256 depositID, address token, uin
|
||||
event DepositClosed(address indexed seller, uint256 depositID)
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| seller `indexed` | address | undefined |
|
||||
| depositID | uint256 | undefined |
|
||||
| Name | Type | Description |
|
||||
| ---------------- | ------- | ----------- |
|
||||
| seller `indexed` | address | undefined |
|
||||
| depositID | uint256 | undefined |
|
||||
|
||||
### DepositWithdrawn
|
||||
|
||||
@@ -537,17 +462,13 @@ event DepositClosed(address indexed seller, uint256 depositID)
|
||||
event DepositWithdrawn(address indexed seller, uint256 depositID, uint256 amount)
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| seller `indexed` | address | undefined |
|
||||
| depositID | uint256 | undefined |
|
||||
| amount | uint256 | undefined |
|
||||
| Name | Type | Description |
|
||||
| ---------------- | ------- | ----------- |
|
||||
| seller `indexed` | address | undefined |
|
||||
| depositID | uint256 | undefined |
|
||||
| amount | uint256 | undefined |
|
||||
|
||||
### FundsWithdrawn
|
||||
|
||||
@@ -555,16 +476,12 @@ event DepositWithdrawn(address indexed seller, uint256 depositID, uint256 amount
|
||||
event FundsWithdrawn(address owner, uint256 amount)
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| owner | address | undefined |
|
||||
| amount | uint256 | undefined |
|
||||
| Name | Type | Description |
|
||||
| ------ | ------- | ----------- |
|
||||
| owner | address | undefined |
|
||||
| amount | uint256 | undefined |
|
||||
|
||||
### LockAdded
|
||||
|
||||
@@ -572,18 +489,14 @@ event FundsWithdrawn(address owner, uint256 amount)
|
||||
event LockAdded(address indexed buyer, bytes32 indexed lockID, uint256 depositID, uint256 amount)
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| buyer `indexed` | address | undefined |
|
||||
| lockID `indexed` | bytes32 | undefined |
|
||||
| depositID | uint256 | undefined |
|
||||
| amount | uint256 | undefined |
|
||||
| Name | Type | Description |
|
||||
| ---------------- | ------- | ----------- |
|
||||
| buyer `indexed` | address | undefined |
|
||||
| lockID `indexed` | bytes32 | undefined |
|
||||
| depositID | uint256 | undefined |
|
||||
| amount | uint256 | undefined |
|
||||
|
||||
### LockBlocksUpdated
|
||||
|
||||
@@ -591,15 +504,11 @@ event LockAdded(address indexed buyer, bytes32 indexed lockID, uint256 depositID
|
||||
event LockBlocksUpdated(uint256 blocks)
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| blocks | uint256 | undefined |
|
||||
| Name | Type | Description |
|
||||
| ------ | ------- | ----------- |
|
||||
| blocks | uint256 | undefined |
|
||||
|
||||
### LockReleased
|
||||
|
||||
@@ -607,16 +516,12 @@ event LockBlocksUpdated(uint256 blocks)
|
||||
event LockReleased(address indexed buyer, bytes32 lockId)
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| buyer `indexed` | address | undefined |
|
||||
| lockId | bytes32 | undefined |
|
||||
| Name | Type | Description |
|
||||
| --------------- | ------- | ----------- |
|
||||
| buyer `indexed` | address | undefined |
|
||||
| lockId | bytes32 | undefined |
|
||||
|
||||
### LockReturned
|
||||
|
||||
@@ -624,16 +529,12 @@ event LockReleased(address indexed buyer, bytes32 lockId)
|
||||
event LockReturned(address indexed buyer, bytes32 lockId)
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| buyer `indexed` | address | undefined |
|
||||
| lockId | bytes32 | undefined |
|
||||
| Name | Type | Description |
|
||||
| --------------- | ------- | ----------- |
|
||||
| buyer `indexed` | address | undefined |
|
||||
| lockId | bytes32 | undefined |
|
||||
|
||||
### OwnerUpdated
|
||||
|
||||
@@ -641,16 +542,12 @@ event LockReturned(address indexed buyer, bytes32 lockId)
|
||||
event OwnerUpdated(address indexed user, address indexed newOwner)
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| user `indexed` | address | undefined |
|
||||
| newOwner `indexed` | address | undefined |
|
||||
| Name | Type | Description |
|
||||
| ------------------ | ------- | ----------- |
|
||||
| user `indexed` | address | undefined |
|
||||
| newOwner `indexed` | address | undefined |
|
||||
|
||||
### ReputationUpdated
|
||||
|
||||
@@ -658,15 +555,11 @@ event OwnerUpdated(address indexed user, address indexed newOwner)
|
||||
event ReputationUpdated(address reputation)
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| reputation | address | undefined |
|
||||
| Name | Type | Description |
|
||||
| ---------- | ------- | ----------- |
|
||||
| reputation | address | undefined |
|
||||
|
||||
### ValidSignersUpdated
|
||||
|
||||
@@ -674,17 +567,11 @@ event ReputationUpdated(address reputation)
|
||||
event ValidSignersUpdated(address[] signers)
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
|---|---|---|
|
||||
| signers | address[] | undefined |
|
||||
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------- | --------- | ----------- |
|
||||
| signers | address[] | undefined |
|
||||
|
||||
## Errors
|
||||
|
||||
@@ -694,10 +581,7 @@ event ValidSignersUpdated(address[] signers)
|
||||
error AddressDenied()
|
||||
```
|
||||
|
||||
|
||||
|
||||
*Address doesn't exist in a MerkleTree.Address not allowed as relayer.0x3b8474be*
|
||||
|
||||
_Address doesn't exist in a MerkleTree.Address not allowed as relayer.0x3b8474be_
|
||||
|
||||
### AlreadyReleased
|
||||
|
||||
@@ -705,10 +589,7 @@ error AddressDenied()
|
||||
error AlreadyReleased()
|
||||
```
|
||||
|
||||
|
||||
|
||||
*Lock already released or returned.0x63b4904e*
|
||||
|
||||
_Lock already released or returned.0x63b4904e_
|
||||
|
||||
### AmountNotAllowed
|
||||
|
||||
@@ -716,10 +597,7 @@ error AlreadyReleased()
|
||||
error AmountNotAllowed()
|
||||
```
|
||||
|
||||
|
||||
|
||||
*Wished amount to be locked exceeds the limit allowed.0x1c18f846*
|
||||
|
||||
_Wished amount to be locked exceeds the limit allowed.0x1c18f846_
|
||||
|
||||
### DepositAlreadyExists
|
||||
|
||||
@@ -727,10 +605,7 @@ error AmountNotAllowed()
|
||||
error DepositAlreadyExists()
|
||||
```
|
||||
|
||||
|
||||
|
||||
*Deposit already exist and it is still valid.0xc44bd765*
|
||||
|
||||
_Deposit already exist and it is still valid.0xc44bd765_
|
||||
|
||||
### InvalidDeposit
|
||||
|
||||
@@ -738,10 +613,7 @@ error DepositAlreadyExists()
|
||||
error InvalidDeposit()
|
||||
```
|
||||
|
||||
|
||||
|
||||
*Deposit not valid anymore.0xb2e532de*
|
||||
|
||||
_Deposit not valid anymore.0xb2e532de_
|
||||
|
||||
### InvalidSigner
|
||||
|
||||
@@ -749,10 +621,7 @@ error InvalidDeposit()
|
||||
error InvalidSigner()
|
||||
```
|
||||
|
||||
|
||||
|
||||
*Signer is not a valid signer.0x815e1d64*
|
||||
|
||||
_Signer is not a valid signer.0x815e1d64_
|
||||
|
||||
### LengthMismatch
|
||||
|
||||
@@ -760,10 +629,7 @@ error InvalidSigner()
|
||||
error LengthMismatch()
|
||||
```
|
||||
|
||||
|
||||
|
||||
*Arrays' length don't match.0xff633a38*
|
||||
|
||||
_Arrays' length don't match.0xff633a38_
|
||||
|
||||
### LoopOverflow
|
||||
|
||||
@@ -771,10 +637,7 @@ error LengthMismatch()
|
||||
error LoopOverflow()
|
||||
```
|
||||
|
||||
|
||||
|
||||
*Loop bounds have overflowed.0xdfb035c9*
|
||||
|
||||
_Loop bounds have overflowed.0xdfb035c9_
|
||||
|
||||
### NoTokens
|
||||
|
||||
@@ -782,10 +645,7 @@ error LoopOverflow()
|
||||
error NoTokens()
|
||||
```
|
||||
|
||||
|
||||
|
||||
*No tokens array provided as argument.0xdf957883*
|
||||
|
||||
_No tokens array provided as argument.0xdf957883_
|
||||
|
||||
### NotEnoughTokens
|
||||
|
||||
@@ -793,10 +653,7 @@ error NoTokens()
|
||||
error NotEnoughTokens()
|
||||
```
|
||||
|
||||
|
||||
|
||||
*Not enough token remaining on deposit.0x22bbb43c*
|
||||
|
||||
_Not enough token remaining on deposit.0x22bbb43c_
|
||||
|
||||
### NotExpired
|
||||
|
||||
@@ -804,10 +661,7 @@ error NotEnoughTokens()
|
||||
error NotExpired()
|
||||
```
|
||||
|
||||
|
||||
|
||||
*Lock not expired or already released.Another lock with same ID is not expired yet.0xd0404f85*
|
||||
|
||||
_Lock not expired or already released.Another lock with same ID is not expired yet.0xd0404f85_
|
||||
|
||||
### OnlySeller
|
||||
|
||||
@@ -815,10 +669,7 @@ error NotExpired()
|
||||
error OnlySeller()
|
||||
```
|
||||
|
||||
|
||||
|
||||
*Only seller could call this function.`msg.sender` and the seller differ.0x85d1f726*
|
||||
|
||||
_Only seller could call this function.`msg.sender` and the seller differ.0x85d1f726_
|
||||
|
||||
### Reentrancy
|
||||
|
||||
@@ -826,21 +677,13 @@ error OnlySeller()
|
||||
error Reentrancy()
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### TokenDenied
|
||||
|
||||
```solidity
|
||||
error TokenDenied()
|
||||
```
|
||||
|
||||
|
||||
|
||||
*Token address not allowed to be deposited.0x1578328e*
|
||||
|
||||
_Token address not allowed to be deposited.0x1578328e_
|
||||
|
||||
### TxAlreadyUsed
|
||||
|
||||
@@ -848,9 +691,4 @@ error TokenDenied()
|
||||
error TxAlreadyUsed()
|
||||
```
|
||||
|
||||
|
||||
|
||||
*Transaction already used to unlock payment.0xf490a6ea*
|
||||
|
||||
|
||||
|
||||
_Transaction already used to unlock payment.0xf490a6ea_
|
||||
|
||||
Reference in New Issue
Block a user