v2
UnicFactory
Important functions
createUToken
Parameters:
name
- Token namesymbol
- Token tickerproxyTransactionFactory
- Address of contract that creates proxy transaction contractenableProxyTransactions
- Vault allows proxy transactions (or not)Usage:
Creates vault contract (
Converter
)
Converter
Important functions
setTriggers
Parameters:
nftIndex
- Array of NFT indices deposited within vaulttriggerPrices
- Array of auction trigger prices for each NFTUsage:
Allows for vault creator to update auction trigger prices
deposit
Parameters:
tokenIDs
- Array of token IDs being depositedamounts
- Array of number of NFTs per ID being deposited (relevant for ERC-1155)triggerPrices
- Array of trigger prices for each NFT being depositedcontractAddr
- Address of NFT smart contractUsage:
Deposit NFTs into vault
issue
Usage:
Lock NFTs in vault and issue the fractions
refund
Parameters:
to
- address to refund NFTs toUsage:
Allows vault creator to receive NFTs back before issuing fractions
claimNFT
Parameters:
nftIndex
- Index of NFT within vaultto
- Where to receive the NFTUsage:
Allows
AuctionHandler
to claim the NFT for auction winner
AuctionHandler
Important functions
newAuction
Parameters:
uToken
- Vault addressnftIndexForUToken
- Index of NFT within vault being auctionedUsage:
New auction is created by user bidding auction trigger price on NFT
bid
Parameters:
auctionId
- ID of auctionUsage:
Bidder can outbid the existing bid by bidding an amount above a certain margin of the existing one
unbid
Parameters:
auctionId
- ID of auctionUsage:
User can claim back their bid if they got outbid
claim
Parameters:
auctionId
- ID of auctionUsage:
Auction winner can claim the NFT that they bid on
burnAndRedeem
Parameters:
uToken
- Vault addressamount
- Number of fractions being burnedUsage:
Allows for users to burn their fractions in exchange for part of the ETH currently in the vault. Their cut of the ETH is determined by the amount of fractions being burned out of the current total supply of fractions.
ConverterGovernorAlpha
Manages the proxy transaction when enabled for the vault.
**Important functions**
**delegate**
Parameters:
`delegatee` - Address to receive the voting power
Usage:
Token holders can delegate voting power to themselves or other users.
**propose**
Parameters:
`targets` - Array of contract addresses
`values` - Array of ETH values
`signatures` - Array of function signatures to call (example: `['function1(address,uint256)', 'function2()']`)
`calldatas` - Array of encoded call data (example: `[utils.defaultAbiCoder.encode(['address', 'uint256'], [address3, 10]), utils.defaultAbiCoder.encode([], [])]`)
`description` - A meaningful description of what the transactions are intended to do
Usage:
Addresses that have more voting power than the proposal threshold (ConverterGovernorAlpha:proposalThreshold()) can submit
proposals for transactions. The proposal can consist of several single transactions. For each transaction a target
address, the amount of ETH to be sent, the method signature as well as the calldata must be passed. For the entire
proposal a description must be provided.
**castVote**
Parameters:
`proposalId` - ID of the proposal
`support` - True to vote in favor of the proposal, false otherwise
Usage:
Vote for a proposal.
**queue**
Parameters:
`proposalId` - ID of the proposal
Usage:
When the voting period is over (ConverterGovernorAlphaConfig:votingPeriod) and the positive votes exceed the threshold value
(ConverterGovernorAlpha:quorumVotes()), the proposal must be queued to be executed at a later time when the time lock expires.