hueso/p2pix-smart-contracts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

test: 🚧 Added fixtures for new test schema

Browse Source
This commit is contained in:
PedroCailleret
2022-12-03 01:17:48 -03:00
parent 4403541660
commit c69d82ccee
49 changed files with 931 additions and 1126 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/DataTypes.md
View File

@@ -1,12 +1 @@
# DataTypes

217
docs/EventAndErrors.md
View File

@@ -1,14 +1,5 @@
# EventAndErrors
## Events
### AllowedERC20Updated
@@ -17,16 +8,12 @@
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
@@ -36,16 +23,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
@@ -53,16 +38,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
@@ -70,17 +51,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
@@ -88,16 +65,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
@@ -105,18 +78,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
@@ -124,15 +93,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
@@ -140,16 +105,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
@@ -157,16 +118,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 |
### ReputationUpdated
@@ -174,15 +131,11 @@ event LockReturned(address indexed buyer, bytes32 lockId)
event ReputationUpdated(address reputation)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| reputation | address | undefined |
| Name | Type | Description |
| ---------- | ------- | ----------- |
| reputation | address | undefined |
### ValidSignersUpdated
@@ -190,17 +143,11 @@ event ReputationUpdated(address reputation)
event ValidSignersUpdated(address[] signers)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| signers | address[] | undefined |
| Name | Type | Description |
| ------- | --------- | ----------- |
| signers | address[] | undefined |
## Errors
@@ -210,10 +157,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
@@ -221,10 +165,7 @@ error AddressDenied()
error AlreadyReleased()
```
*Lock already released or returned.0x63b4904e*
_Lock already released or returned.0x63b4904e_
### AmountNotAllowed
@@ -232,10 +173,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
@@ -243,10 +181,7 @@ error AmountNotAllowed()
error DepositAlreadyExists()
```
*Deposit already exist and it is still valid.0xc44bd765*
_Deposit already exist and it is still valid.0xc44bd765_
### InvalidDeposit
@@ -254,10 +189,7 @@ error DepositAlreadyExists()
error InvalidDeposit()
```
*Deposit not valid anymore.0xb2e532de*
_Deposit not valid anymore.0xb2e532de_
### InvalidSigner
@@ -265,10 +197,7 @@ error InvalidDeposit()
error InvalidSigner()
```
*Signer is not a valid signer.0x815e1d64*
_Signer is not a valid signer.0x815e1d64_
### LengthMismatch
@@ -276,10 +205,7 @@ error InvalidSigner()
error LengthMismatch()
```
*Arrays' length don't match.0xff633a38*
_Arrays' length don't match.0xff633a38_
### LoopOverflow
@@ -287,10 +213,7 @@ error LengthMismatch()
error LoopOverflow()
```
*Loop bounds have overflowed.0xdfb035c9*
_Loop bounds have overflowed.0xdfb035c9_
### NoTokens
@@ -298,10 +221,7 @@ error LoopOverflow()
error NoTokens()
```
*No tokens array provided as argument.0xdf957883*
_No tokens array provided as argument.0xdf957883_
### NotEnoughTokens
@@ -309,10 +229,7 @@ error NoTokens()
error NotEnoughTokens()
```
*Not enough token remaining on deposit.0x22bbb43c*
_Not enough token remaining on deposit.0x22bbb43c_
### NotExpired
@@ -320,10 +237,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
@@ -331,10 +245,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_
### TokenDenied
@@ -342,10 +253,7 @@ error OnlySeller()
error TokenDenied()
```
*Token address not allowed to be deposited.0x1578328e*
_Token address not allowed to be deposited.0x1578328e_
### TxAlreadyUsed
@@ -353,9 +261,4 @@ error TokenDenied()
error TxAlreadyUsed()
```
*Transaction already used to unlock payment.0xf490a6ea*
_Transaction already used to unlock payment.0xf490a6ea_

560
docs/P2PIX.md
View File

@@ -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_

84
docs/Reputation.md
View File

@@ -1,13 +1,5 @@
# Reputation
## Methods
### limiter
@@ -16,21 +8,17 @@
function limiter(uint256 _userCredit) external pure returns (uint256 _spendLimit)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| _userCredit | uint256 | undefined |
| Name | Type | Description |
| ------------ | ------- | ----------- |
| \_userCredit | uint256 | undefined |
#### Returns
| Name | Type | Description |
|---|---|---|
| _spendLimit | uint256 | undefined |
| Name | Type | Description |
| ------------ | ------- | ----------- |
| \_spendLimit | uint256 | undefined |
### magicValue
@@ -38,16 +26,13 @@ function limiter(uint256 _userCredit) external pure returns (uint256 _spendLimit
function magicValue() external view returns (uint256)
```
*Denominator's constant operand for the `limiter` fx. *
_Denominator's constant operand for the `limiter` fx. _
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
| Name | Type | Description |
| ---- | ------- | ----------- |
| \_0 | uint256 | undefined |
### maxLimit
@@ -55,16 +40,13 @@ function magicValue() external view returns (uint256)
function maxLimit() external view returns (uint256)
```
*Asymptote numerator constant value for the `limiter` fx.*
_Asymptote numerator constant value for the `limiter` fx._
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
| Name | Type | Description |
| ---- | ------- | ----------- |
| \_0 | uint256 | undefined |
### owner
@@ -72,16 +54,11 @@ function maxLimit() external view returns (uint256)
function owner() external view returns (address)
```
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
| Name | Type | Description |
| ---- | ------- | ----------- |
| \_0 | address | undefined |
### setOwner
@@ -89,17 +66,11 @@ function owner() external view returns (address)
function setOwner(address newOwner) external nonpayable
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| newOwner | address | undefined |
| Name | Type | Description |
| -------- | ------- | ----------- |
| newOwner | address | undefined |
## Events
@@ -109,16 +80,9 @@ function setOwner(address newOwner) external nonpayable
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 |

44
docs/lib/auth/Owned.md
View File

@@ -1,13 +1,9 @@
# Owned
*Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/auth/Owned.sol)*
_Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/auth/Owned.sol)_
Simple single owner authorization mixin.
## Methods
### owner
@@ -16,16 +12,11 @@ Simple single owner authorization mixin.
function owner() external view returns (address)
```
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
| Name | Type | Description |
| ---- | ------- | ----------- |
| \_0 | address | undefined |
### setOwner
@@ -33,17 +24,11 @@ function owner() external view returns (address)
function setOwner(address newOwner) external nonpayable
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| newOwner | address | undefined |
| Name | Type | Description |
| -------- | ------- | ----------- |
| newOwner | address | undefined |
## Events
@@ -53,16 +38,9 @@ function setOwner(address newOwner) external nonpayable
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 |

28
docs/lib/interfaces/IReputation.md
View File

@@ -1,13 +1,5 @@
# IReputation
## Methods
### limiter
@@ -16,22 +8,14 @@
function limiter(uint256 _userCredit) external pure returns (uint256 _spendLimit)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| _userCredit | uint256 | undefined |
| Name | Type | Description |
| ------------ | ------- | ----------- |
| \_userCredit | uint256 | undefined |
#### Returns
| Name | Type | Description |
|---|---|---|
| _spendLimit | uint256 | undefined |
| Name | Type | Description |
| ------------ | ------- | ----------- |
| \_spendLimit | uint256 | undefined |

218
docs/lib/mock/MockToken.md
View File

@@ -1,13 +1,5 @@
# MockToken
## Methods
### DOMAIN_SEPARATOR
@@ -16,16 +8,11 @@
function DOMAIN_SEPARATOR() external view returns (bytes32)
```
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bytes32 | undefined |
| Name | Type | Description |
| ---- | ------- | ----------- |
| \_0 | bytes32 | undefined |
### allowance
@@ -33,22 +20,18 @@ function DOMAIN_SEPARATOR() external view returns (bytes32)
function allowance(address, address) external view returns (uint256)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
| _1 | address | undefined |
| Name | Type | Description |
| ---- | ------- | ----------- |
| \_0 | address | undefined |
| \_1 | address | undefined |
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
| Name | Type | Description |
| ---- | ------- | ----------- |
| \_0 | uint256 | undefined |
### approve
@@ -56,22 +39,18 @@ function allowance(address, address) external view returns (uint256)
function approve(address spender, uint256 amount) external nonpayable returns (bool)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| spender | address | undefined |
| amount | uint256 | undefined |
| Name | Type | Description |
| ------- | ------- | ----------- |
| spender | address | undefined |
| amount | uint256 | undefined |
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined |
| ---- | ---- | ----------- |
| \_0 | bool | undefined |
### balanceOf
@@ -79,21 +58,17 @@ function approve(address spender, uint256 amount) external nonpayable returns (b
function balanceOf(address) external view returns (uint256)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
| Name | Type | Description |
| ---- | ------- | ----------- |
| \_0 | address | undefined |
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
| Name | Type | Description |
| ---- | ------- | ----------- |
| \_0 | uint256 | undefined |
### decimals
@@ -101,16 +76,11 @@ function balanceOf(address) external view returns (uint256)
function decimals() external view returns (uint8)
```
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint8 | undefined |
| Name | Type | Description |
| ---- | ----- | ----------- |
| \_0 | uint8 | undefined |
### name
@@ -118,16 +88,11 @@ function decimals() external view returns (uint8)
function name() external view returns (string)
```
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | string | undefined |
| Name | Type | Description |
| ---- | ------ | ----------- |
| \_0 | string | undefined |
### nonces
@@ -135,21 +100,17 @@ function name() external view returns (string)
function nonces(address) external view returns (uint256)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
| Name | Type | Description |
| ---- | ------- | ----------- |
| \_0 | address | undefined |
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
| Name | Type | Description |
| ---- | ------- | ----------- |
| \_0 | uint256 | undefined |
### permit
@@ -157,21 +118,17 @@ function nonces(address) external view returns (uint256)
function permit(address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s) external nonpayable
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| owner | address | undefined |
| spender | address | undefined |
| value | uint256 | undefined |
| deadline | uint256 | undefined |
| v | uint8 | undefined |
| r | bytes32 | undefined |
| s | bytes32 | undefined |
| Name | Type | Description |
| -------- | ------- | ----------- |
| owner | address | undefined |
| spender | address | undefined |
| value | uint256 | undefined |
| deadline | uint256 | undefined |
| v | uint8 | undefined |
| r | bytes32 | undefined |
| s | bytes32 | undefined |
### symbol
@@ -179,16 +136,11 @@ function permit(address owner, address spender, uint256 value, uint256 deadline,
function symbol() external view returns (string)
```
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | string | undefined |
| Name | Type | Description |
| ---- | ------ | ----------- |
| \_0 | string | undefined |
### totalSupply
@@ -196,16 +148,11 @@ function symbol() external view returns (string)
function totalSupply() external view returns (uint256)
```
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
| Name | Type | Description |
| ---- | ------- | ----------- |
| \_0 | uint256 | undefined |
### transfer
@@ -213,22 +160,18 @@ function totalSupply() external view returns (uint256)
function transfer(address to, uint256 amount) external nonpayable returns (bool)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| to | address | undefined |
| amount | uint256 | undefined |
| Name | Type | Description |
| ------ | ------- | ----------- |
| to | address | undefined |
| amount | uint256 | undefined |
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined |
| ---- | ---- | ----------- |
| \_0 | bool | undefined |
### transferFrom
@@ -236,25 +179,19 @@ function transfer(address to, uint256 amount) external nonpayable returns (bool)
function transferFrom(address from, address to, uint256 amount) external nonpayable returns (bool)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| from | address | undefined |
| to | address | undefined |
| amount | uint256 | undefined |
| Name | Type | Description |
| ------ | ------- | ----------- |
| from | address | undefined |
| to | address | undefined |
| amount | uint256 | undefined |
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined |
| ---- | ---- | ----------- |
| \_0 | bool | undefined |
## Events
@@ -264,17 +201,13 @@ function transferFrom(address from, address to, uint256 amount) external nonpaya
event Approval(address indexed owner, address indexed spender, uint256 amount)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| owner `indexed` | address | undefined |
| spender `indexed` | address | undefined |
| amount | uint256 | undefined |
| Name | Type | Description |
| ----------------- | ------- | ----------- |
| owner `indexed` | address | undefined |
| spender `indexed` | address | undefined |
| amount | uint256 | undefined |
### Transfer
@@ -282,17 +215,10 @@ event Approval(address indexed owner, address indexed spender, uint256 amount)
event Transfer(address indexed from, address indexed to, uint256 amount)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| from `indexed` | address | undefined |
| to `indexed` | address | undefined |
| amount | uint256 | undefined |
| Name | Type | Description |
| -------------- | ------- | ----------- |
| from `indexed` | address | undefined |
| to `indexed` | address | undefined |
| amount | uint256 | undefined |

216
docs/lib/tokens/ERC20.md
View File

@@ -1,12 +1,10 @@
# ERC20
*Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/tokens/ERC20.sol)Modified from Uniswap (https://github.com/Uniswap/uniswap-v2-core/blob/master/contracts/UniswapV2ERC20.sol)*
_Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/tokens/ERC20.sol)Modified from Uniswap (https://github.com/Uniswap/uniswap-v2-core/blob/master/contracts/UniswapV2ERC20.sol)_
Modern and gas efficient ERC20 + EIP-2612 implementation.
*Do not manually set balances without updating totalSupply, as the sum of all user balances must not exceed it.*
_Do not manually set balances without updating totalSupply, as the sum of all user balances must not exceed it._
## Methods
@@ -16,16 +14,11 @@ Modern and gas efficient ERC20 + EIP-2612 implementation.
function DOMAIN_SEPARATOR() external view returns (bytes32)
```
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bytes32 | undefined |
| Name | Type | Description |
| ---- | ------- | ----------- |
| \_0 | bytes32 | undefined |
### allowance
@@ -33,22 +26,18 @@ function DOMAIN_SEPARATOR() external view returns (bytes32)
function allowance(address, address) external view returns (uint256)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
| _1 | address | undefined |
| Name | Type | Description |
| ---- | ------- | ----------- |
| \_0 | address | undefined |
| \_1 | address | undefined |
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
| Name | Type | Description |
| ---- | ------- | ----------- |
| \_0 | uint256 | undefined |
### approve
@@ -56,22 +45,18 @@ function allowance(address, address) external view returns (uint256)
function approve(address spender, uint256 amount) external nonpayable returns (bool)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| spender | address | undefined |
| amount | uint256 | undefined |
| Name | Type | Description |
| ------- | ------- | ----------- |
| spender | address | undefined |
| amount | uint256 | undefined |
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined |
| ---- | ---- | ----------- |
| \_0 | bool | undefined |
### balanceOf
@@ -79,21 +64,17 @@ function approve(address spender, uint256 amount) external nonpayable returns (b
function balanceOf(address) external view returns (uint256)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
| Name | Type | Description |
| ---- | ------- | ----------- |
| \_0 | address | undefined |
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
| Name | Type | Description |
| ---- | ------- | ----------- |
| \_0 | uint256 | undefined |
### decimals
@@ -101,16 +82,11 @@ function balanceOf(address) external view returns (uint256)
function decimals() external view returns (uint8)
```
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint8 | undefined |
| Name | Type | Description |
| ---- | ----- | ----------- |
| \_0 | uint8 | undefined |
### name
@@ -118,16 +94,11 @@ function decimals() external view returns (uint8)
function name() external view returns (string)
```
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | string | undefined |
| Name | Type | Description |
| ---- | ------ | ----------- |
| \_0 | string | undefined |
### nonces
@@ -135,21 +106,17 @@ function name() external view returns (string)
function nonces(address) external view returns (uint256)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
| Name | Type | Description |
| ---- | ------- | ----------- |
| \_0 | address | undefined |
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
| Name | Type | Description |
| ---- | ------- | ----------- |
| \_0 | uint256 | undefined |
### permit
@@ -157,21 +124,17 @@ function nonces(address) external view returns (uint256)
function permit(address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s) external nonpayable
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| owner | address | undefined |
| spender | address | undefined |
| value | uint256 | undefined |
| deadline | uint256 | undefined |
| v | uint8 | undefined |
| r | bytes32 | undefined |
| s | bytes32 | undefined |
| Name | Type | Description |
| -------- | ------- | ----------- |
| owner | address | undefined |
| spender | address | undefined |
| value | uint256 | undefined |
| deadline | uint256 | undefined |
| v | uint8 | undefined |
| r | bytes32 | undefined |
| s | bytes32 | undefined |
### symbol
@@ -179,16 +142,11 @@ function permit(address owner, address spender, uint256 value, uint256 deadline,
function symbol() external view returns (string)
```
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | string | undefined |
| Name | Type | Description |
| ---- | ------ | ----------- |
| \_0 | string | undefined |
### totalSupply
@@ -196,16 +154,11 @@ function symbol() external view returns (string)
function totalSupply() external view returns (uint256)
```
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
| Name | Type | Description |
| ---- | ------- | ----------- |
| \_0 | uint256 | undefined |
### transfer
@@ -213,22 +166,18 @@ function totalSupply() external view returns (uint256)
function transfer(address to, uint256 amount) external nonpayable returns (bool)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| to | address | undefined |
| amount | uint256 | undefined |
| Name | Type | Description |
| ------ | ------- | ----------- |
| to | address | undefined |
| amount | uint256 | undefined |
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined |
| ---- | ---- | ----------- |
| \_0 | bool | undefined |
### transferFrom
@@ -236,25 +185,19 @@ function transfer(address to, uint256 amount) external nonpayable returns (bool)
function transferFrom(address from, address to, uint256 amount) external nonpayable returns (bool)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| from | address | undefined |
| to | address | undefined |
| amount | uint256 | undefined |
| Name | Type | Description |
| ------ | ------- | ----------- |
| from | address | undefined |
| to | address | undefined |
| amount | uint256 | undefined |
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined |
| ---- | ---- | ----------- |
| \_0 | bool | undefined |
## Events
@@ -264,17 +207,13 @@ function transferFrom(address from, address to, uint256 amount) external nonpaya
event Approval(address indexed owner, address indexed spender, uint256 amount)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| owner `indexed` | address | undefined |
| spender `indexed` | address | undefined |
| amount | uint256 | undefined |
| Name | Type | Description |
| ----------------- | ------- | ----------- |
| owner `indexed` | address | undefined |
| spender `indexed` | address | undefined |
| amount | uint256 | undefined |
### Transfer
@@ -282,17 +221,10 @@ event Approval(address indexed owner, address indexed spender, uint256 amount)
event Transfer(address indexed from, address indexed to, uint256 amount)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| from `indexed` | address | undefined |
| to `indexed` | address | undefined |
| amount | uint256 | undefined |
| Name | Type | Description |
| -------------- | ------- | ----------- |
| from `indexed` | address | undefined |
| to `indexed` | address | undefined |
| amount | uint256 | undefined |

13
docs/lib/utils/Counters.md
View File

@@ -1,14 +1,12 @@
# Counters
*buf0t9Modified from OpenZeppelin Contracts (https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/utils/Counters.sol)*
_buf0t9Modified from OpenZeppelin Contracts (https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/utils/Counters.sol)_
> Counters
Provides counters that can only be incremented, decrementedor reset.
*Include with `using Counters for Counters.Counter;`*
_Include with `using Counters for Counters.Counter;`_
## Errors
@@ -18,9 +16,4 @@ Provides counters that can only be incremented, decrementedor reset.
error DecOverflow()
```
*0xce3a3d37*
_0xce3a3d37_

9
docs/lib/utils/FixedPointMathLib.md
View File

@@ -1,12 +1,5 @@
# FixedPointMathLib
*Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/utils/FixedPointMathLib.sol)*
_Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/utils/FixedPointMathLib.sol)_
Arithmetic library with operations for fixed-point numbers.

9
docs/lib/utils/MerkleProofLib.md
View File

@@ -1,12 +1,5 @@
# MerkleProofLib
*Solady (https://github.com/vectorized/solady/blob/main/src/utils/MerkleProofLib.sol)Modified from Solmate (https://github.com/transmissions11/solmate/blob/main/src/utils/MerkleProofLib.sol)Modified from OpenZeppelin (https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/utils/cryptography/MerkleProof.sol)*
_Solady (https://github.com/vectorized/solady/blob/main/src/utils/MerkleProofLib.sol)Modified from Solmate (https://github.com/transmissions11/solmate/blob/main/src/utils/MerkleProofLib.sol)Modified from OpenZeppelin (https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/utils/cryptography/MerkleProof.sol)_
Gas optimized verification of proof of inclusion for a leaf in a Merkle tree.

15
docs/lib/utils/ReentrancyGuard.md
View File

@@ -1,15 +1,9 @@
# ReentrancyGuard
*z0r0z.ethModified from Seaport (https://github.com/ProjectOpenSea/seaport/blob/main/contracts/lib/ReentrancyGuard.sol)Modified from Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/utils/ReentrancyGuard.sol)*
_z0r0z.ethModified from Seaport (https://github.com/ProjectOpenSea/seaport/blob/main/contracts/lib/ReentrancyGuard.sol)Modified from Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/utils/ReentrancyGuard.sol)_
Reentrancy protection for smart contracts.
## Errors
### Reentrancy
@@ -17,10 +11,3 @@ Reentrancy protection for smart contracts.
```solidity
error Reentrancy()
```

9
docs/lib/utils/SafeTransferLib.md
View File

@@ -1,12 +1,7 @@
# SafeTransferLib
*Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/utils/SafeTransferLib.sol)*
_Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/utils/SafeTransferLib.sol)_
Safe ETH and ERC20 transfer library that gracefully handles missing return values.
*Caution! This library won't check that a token has code, responsibility is delegated to the caller.*
_Caution! This library won't check that a token has code, responsibility is delegated to the caller._