Comment on page
RevenuePathV2
contracts/core/ReveelMainV2.sol
Emits on receive; mimics ERC20 Transfer
- Parameters
- address from: Address that deposited the eth
- uint256 value: Amount of ETH deposited
Emits when ERC20 payment is withdrawn/claimed by a member
- Parameters
- address token: The token address for which withdrawal is made
- address account: The wallet address to which withdrawal is made
- uint256 payment: The amount of the given token the wallet has claimed
Emits when fee is distributed
- Parameters
- address token: The token address. Address 0 for native gas token like ETH
- uint256 amount: The amount of fee deducted
Emits when fee is released
- Parameters
- address token: The token address. Address 0 for native gas token like ETH
- uint256 amount: The amount of fee released
- Parameters
- uint8 version
- Parameters
- address previousOwner
- address newOwner
Emits when token payment is withdrawn/claimed by a member
- Parameters
- address account: The wallet for which ETH has been claimed for
- address token
- uint256 payment: The amount of ETH that has been paid out to the wallet
emits when one or more revenue tiers are added
- Parameters
- address[][] wallets: Array of arrays of wallet lists (each array is a tier)
- uint256[][] distributions: Array of arrays of distr %s (each array is a tier)
emits when one or more revenue tiers wallets/distributions are updated
- Parameters
- uint256[] tierNumbers: Array tier numbers being updated
- address[][] wallets: Array of arrays of wallet lists (each array is a tier)
- uint256[][] distributions: Array of arrays of distr %s (each array is a tier)
emits when one revenue tier's limit is updated
- Parameters
- uint256 tier: tier number being updated
- address[] tokenList: Array of tokens in that tier
- uint256[] newLimits: Array of limits for those tokens
Emits when tokens are distributed during withdraw or external distribution call
- Parameters
- address token: Address of token for distribution. Zero address for native token like ETH
- uint256 amount: The amount of token distributed in wei
- uint256 tier: The tier for which the distribution occured
- Return Values
- uint32 _0
- Return Values
- uint8 _0
Adding new revenue tiers
- Parameters
- address[][] _walletList: a nested list of new wallets
- uint256[][] _distribution: a nested list of corresponding distribution
Called for a given token to distribute, unallocated tokens to the respective tiers and wallet members
- Parameters
- address token: The address of the token
Get the current ongoing tier of revenue path For eth: token address(0) is reserved
- Parameters
- address token
- Return Values
- uint256 tierNumber
Get the current ongoing tier of revenue path
- Return Values
- bool required
Get the revenue path Immutability status
- Return Values
- bool _0
Returns the ReveelMainV2 contract address
- Return Values
- address _0
Get the token amount that has not been allocated for in the revenue path
- Parameters
- address token: The token address
- Return Values
- uint256 _0
Get the platform fee percentage
- Return Values
- uint256 _0
Get the token revenue proportion for a given account at a given tier
- Parameters
- uint256 tier: The tier to fetch revenue proportions for
- address account: The wallet address for which revenue proportion is requested
- Return Values
- uint256 proportion
Get the wallet list for a given revenue tier
- Parameters
- uint256 tierNumber: the index of the tier for which list needs to be provided.
- Return Values
- address[] _walletList
Get the amount of token distrbuted for a given tier
- Parameters
- address token: The token address for which distributed amount is fetched
- uint256 tier: The tier for which distributed amount is fetched
- Return Values
- uint256 amount
Total wallets available in a tier
- Parameters
- uint256 tier: The tier for which wallet counts will be fetched
- Return Values
- uint256 _0
Get the amount of token released for a given account
- Parameters
- address token: the token address for which token released is fetched
- address account: the wallet address for whih the token released is fetched
- Return Values
- uint256 amount
- Parameters
- address token
- uint256 tier
- Return Values
- uint256 _0
Get the amount of total eth withdrawn by the account
- Parameters
- address token
- address account
- Return Values
- uint256 _0
Get the amount of ETH accumulated for fee collection
- Parameters
- address token
- Return Values
- uint256 amount
Get the totalNumber of revenue tiers in the revenue path
- Return Values
- uint256 total
Returns total token accounted for a given token address
- Parameters
- address token: The token for which total accountd amount is fetched
- Return Values
- uint256 _0
Returns total token released
- Parameters
- address token: The token for which total released amount is fetched
- Return Values
- uint256 _0
:warning: **Warning** :warning: The Forwarder can have a full control over your Recipient. Only trust verified Forwarder.Method is not a required method to allow Recipients to trust multiple Forwarders. Not recommended yet.
- Return Values
- address forwarder: The address of the Forwarder contract that is being used.
Returns withdrawable or claimable token amount for a given wallet in the revenue path
- Parameters
- address token
- address wallet
- Return Values
- uint256 _0
Initializes revenue path
- Parameters
- address[][] _walletList: Nested array for wallet list across different tiers
- uint256[][] _distribution: Nested array for distribution percentage across different tiers
- address[] _tokenList: A list of tokens for which limits will be set
- uint256[][] _limitSequence: A nested array of limits for each token
- tuple pathInfo: A property object for the path details
- address _owner: Address of path owner
:warning: **Warning** :warning: The Forwarder can have a full control over your Recipient. Only trust verified Forwarder.
- Parameters
- address forwarder: The address of the Forwarder contract that is being used.
- Return Values
- bool _0: isTrustedForwarder `true` if the Forwarder is trusted to forward relayed transactions by this Recipient.
Returns the address of the current owner.
- Return Values
- address _0
Releases distribute token
- Parameters
- address token: The token address
- address account: The address of the receiver
Leaves the contract without owner. It will not be possible to call `onlyOwner` functions anymore. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby removing any functionality that is only available to the owner.
Update the trusted forwarder address
- Parameters
- address forwarder: The address of the new forwarder
Transfers ownership of the contract to a new account (`newOwner`). Can only be called by the current owner.
- Parameters
- address newOwner
Update tier limits for given tokens for an existing tier
- Parameters
- address[] tokenList: A list of tokens for which limits will be updated
- uint256[] newLimits: A list of corresponding limits for the tokens
- uint256 tier: The tier for which limits are being updated
Updating distribution for existing revenue tiers
- Parameters
- address[][] _walletList: A nested list of wallet address
- uint256[][] _distribution: A nested list of distribution percentage
- uint256[] _tierNumbers: A list of tier numbers to be updated
Last modified 1yr ago