Technical User Flows
- Creating a Trading Pool
- createPoolETHFiltered
paramsnft- address of the NFT CollectionbondingCurve- address of the bonding curve you wantassetRecipient- address of asset recipient of the asset after a buy/sell. Only applicable forNFT/TRADEpoolsreceiver- Receiver of the LP token generated to represent ownership of the pool (generally should be yourself)poolType- TOKEN/NFT/TRADE where enums 0/1/2 represent these categorical variablesdelta- as specified by bonding curve, used by bonding curvefee- input the fee you the user want to charge buyers or sellers where 1e18 = 100%. (e.g.1e16= 1%), used by bonding curvespotPrice- a stateful variable for determining new bid/ask levels on every buy or sell transaction. Refer to bonding curve code to see how each one uses spot priceprops- arbitrary bytes variable for static variables, used by bonding curvestate- arbitrary bytes variable for stateful variable, used by bonding curveroyaltyNumerator- % of royalties to give to ERC2981 recipient or its fallback. 1e18 = 100%; 1e16 = 1%royaltyRecipientFallback- fallback if ERC2981 is not set. Necessary if you want to set a non-zero royalty numerator for a non-2981 contract.initialNFTIDs- initial NFT IDs ofnftthat you wish to put into the pool, you must be the owner of these NFT IDs. Note that initial NFT IDs must be sorted byfilter_codelibrary. (This is to ensure consistency with theinitialProof/initialProofFlags. If it is not sorted, it will throw a not accepted error. The sorted list of IDs is simply theleavesfield of any merkle proof you generate)- How to generate filter params from the library?
- call .root() for Merkle root
- call .encode() for encoded Token IDs
// tokenIDFilter is the main object of the library
// accept [1,2,3,4,5]
// Pool starts with [1, 2, 3]
let tokenIDFilter = new tokenIDs([1n,2n,3n,4n,5n]);
// Merkle multiproof is order sensitive. Always pass proof.leaves to tokenId fields
// required by the smart contract if a merkle proof is needed
const unsortedIDs = [1n, 2n, 3n]
const initialNFTIDs = tokenIDFilter.sort([1n, 2n, 3n]);
const root = tokenIDFilter.root()
const encodedTokenIDs = tokenIDFilter.encode()
const {proof: initialProof, proofFlags: initialProofFlags, leaves: initialNFTIDs } = tokenIDFilter.proofOf(initialNFTIDs)
filterParamsmerkleRoot- Root of the Merkle tree of the allowedSet of token IDs.- Filters should accept at least one token ID. A pool that accepts no tokens is a dead pool.
encodedTokenIDs- Encoding of the token IDs. An efficient hexadecimal packing of the token IDs, to minimize gas spent on emitting the event.initialProof- Together theinitialProofandinitialProofFlagsform the Merkle proof for the initial set of NFT tokens put into the pool. Flags are used to indicate which proof is used for which token ID.initialProofFlags- Together theinitialProofandinitialProofFlagsform the Merkle proof for the initial set of NFT tokens put into the pool. Flags are used to indicate which proof is used for which token ID.