Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
joaquim-verges committed Jun 8, 2022
1 parent d331efc commit aa6ea50
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 10 deletions.
3 changes: 1 addition & 2 deletions docs/Drop.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ function getClaimTimestamp(uint256 _conditionId, address _claimer) external view
### setClaimConditions

```solidity
function setClaimConditions(IClaimCondition.ClaimCondition[] _conditions, bool _resetClaimEligibility, bytes) external nonpayable
function setClaimConditions(IClaimCondition.ClaimCondition[] _conditions, bool _resetClaimEligibility) external nonpayable
```


Expand All @@ -128,7 +128,6 @@ function setClaimConditions(IClaimCondition.ClaimCondition[] _conditions, bool _
|---|---|---|
| _conditions | IClaimCondition.ClaimCondition[] | undefined
| _resetClaimEligibility | bool | undefined
| _2 | bytes | undefined

### verifyClaim

Expand Down
3 changes: 1 addition & 2 deletions docs/IDrop.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Lets an account claim a given quantity of NFTs.
### setClaimConditions

```solidity
function setClaimConditions(IClaimCondition.ClaimCondition[] phases, bool resetClaimEligibility, bytes data) external nonpayable
function setClaimConditions(IClaimCondition.ClaimCondition[] phases, bool resetClaimEligibility) external nonpayable
```

Lets a contract admin (account with `DEFAULT_ADMIN_ROLE`) set claim conditions.
Expand All @@ -47,7 +47,6 @@ Lets a contract admin (account with `DEFAULT_ADMIN_ROLE`) set claim conditions.
|---|---|---|
| phases | IClaimCondition.ClaimCondition[] | Claim conditions in ascending order by `startTimestamp`.
| resetClaimEligibility | bool | Whether to reset `limitLastClaimTimestamp` and `limitMerkleProofClaim` values when setting new claim conditions.
| data | bytes | Arbitrary bytes data that can be leveraged in the implementation of this interface.



Expand Down
4 changes: 2 additions & 2 deletions docs/ILazyMint.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
### lazyMint

```solidity
function lazyMint(uint256 amount, string baseURIForTokens, bytes encryptedBaseURI) external nonpayable returns (uint256 batchId)
function lazyMint(uint256 amount, string baseURIForTokens, bytes extraData) external nonpayable returns (uint256 batchId)
```


Expand All @@ -26,7 +26,7 @@ function lazyMint(uint256 amount, string baseURIForTokens, bytes encryptedBaseUR
|---|---|---|
| amount | uint256 | undefined
| baseURIForTokens | string | undefined
| encryptedBaseURI | bytes | undefined
| extraData | bytes | undefined

#### Returns

Expand Down
4 changes: 2 additions & 2 deletions docs/LazyMint.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ function getBatchIdAtIndex(uint256 _index) external view returns (uint256)
### lazyMint

```solidity
function lazyMint(uint256 amount, string baseURIForTokens, bytes encryptedBaseURI) external nonpayable returns (uint256 batchId)
function lazyMint(uint256 amount, string baseURIForTokens, bytes extraData) external nonpayable returns (uint256 batchId)
```


Expand All @@ -65,7 +65,7 @@ function lazyMint(uint256 amount, string baseURIForTokens, bytes encryptedBaseUR
|---|---|---|
| amount | uint256 | undefined
| baseURIForTokens | string | undefined
| encryptedBaseURI | bytes | undefined
| extraData | bytes | undefined

#### Returns

Expand Down
3 changes: 1 addition & 2 deletions docs/SignatureDrop.md
Original file line number Diff line number Diff line change
Expand Up @@ -925,7 +925,7 @@ function setApprovalForAll(address operator, bool approved) external nonpayable
### setClaimConditions

```solidity
function setClaimConditions(IClaimCondition.ClaimCondition[] _conditions, bool _resetClaimEligibility, bytes) external nonpayable
function setClaimConditions(IClaimCondition.ClaimCondition[] _conditions, bool _resetClaimEligibility) external nonpayable
```


Expand All @@ -938,7 +938,6 @@ function setClaimConditions(IClaimCondition.ClaimCondition[] _conditions, bool _
|---|---|---|
| _conditions | IClaimCondition.ClaimCondition[] | undefined
| _resetClaimEligibility | bool | undefined
| _2 | bytes | undefined

### setContractURI

Expand Down
12 changes: 12 additions & 0 deletions docs/TWBitMaps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# TWBitMaps







*Library for managing uint256 to bool mapping in a compact and efficient way, providing the keys are sequential. Largelly inspired by Uniswap's https://github.com/Uniswap/merkle-distributor/blob/master/contracts/MerkleDistributor.sol[merkle-distributor].*



0 comments on commit aa6ea50

Please sign in to comment.