RevenuePath
Last updated
Last updated
contracts/core/RevenuePath.sol
ERC20PaymentReleased (address,address,uint256)
Purpose: Emits when ERC20 payment is withdrawn/claimed by a member
Parameters:
type | name | description |
---|---|---|
ERC20RevnueUpdated (address[],uint256[])
Purpose: Emits when erc20 revenue distribution is updated
Parameters:
type | name | description |
---|---|---|
EthDistributed (uint256,uint256,address[])
Purpose: Emits when incoming ETH is distributed among members
Parameters
OwnershipTransferred (address,address)
Purpose: Transfers the revenue path ownership to another address
Parameters
PaymentReleased (address,uint256)
Purpose: Emits when ETH payment is withdrawn/claimed by a member
Parameters
RevenueTiersAdded (address[ ][ ],uint256[][],uint256)
Purpose: Emits when a new revenue tier has been added
Parameters
RevenueTiersUpdated (address[ ],uint256[ ],uint256,uint256)
Purpose: Emits when a revenue tier is updated
Parameters
addRevenueTier nonpayable (address[][],uint256[][],uint256[])
Purpose: Adds multiple revenue tiers. Only for mutable revenue path
Visibility: external
Parameters
getCurrentTier()
Purpose: Get the current ongoing tier of revenue path
Visibility: external view
Return Values
getERC20Released(address,address)
Purpose: Get the amount of ERC20 accumulated for a given account
Visibility: external view
Parameters
Return Values
getErc20WalletShare(address)
Purpose: Get the erc20 revenue share percentage for given account
Visibility: external view
Parameters
Return Values
getEthWithdrawn(address)
Purpose: Get the amount of total ETH withdrawn by the account
Visibility: external view
Parameters
Return Values
getFeeRequirementStatus()
Purpose: Returns whether revenue path is collecting fee or not
Visibility: external view
Return Values
getImmutabilityStatus()
Purpose: Get the revenue path Immutability status
Visibility: external view
Return Values
getPendingEthBalance(address)
Purpose: Get the pending ETH balance for given address.
Visibility: external view
Parameters
Return Values
getPlatformFee()
Purpose: Get the platform fee percentage.
Visibility: external view
Return Values
getPlatformWallet()
Purpose: Get the platform wallet address.
Visibility: external view
Return Values
getRevenuePathName()
Purpose: Get the revenue path name.
Visibility: external view
Return Values
getRevenueProportion(uint256,address)
Purpose: Get the ETH revenue proportion for a given account at a given tier
Visibility: external view
Parameters
Return Values
getRevenueTier(uint256)
Purpose:Get the limit amount & wallet list for a given revenue tier
Visibility: external view
Parameters
Return Values: Object with following parameters
getTierDistributedAmount(uint256)
Purpose: Get the amount of ETH distributed for a given tier
Visibility: external view
Parameters
Return Values
getTotalErc20Released(address)
Purpose: Get the total ERC-20 released from the revenue path for a given ERC-20 token.
Visibility: external view
Parameters
Return Values
getTotalEthReleased()
Purpose: Get the total amount of ETH withdrawn from revenue path
Return Values
getTotalRevenueTiers()
Purpose: Get the totalNumber of revenue tiers in the revenue path
Return Values
owner()
Purpose: Returns the address of the current path manager.
release(address)
Purpose: Releases distributed ETH for the provided address
Parameters
releaseERC20(address,address)
Purpose: Releases allocated ERC-20 for the provided address
Parameters
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.
Transfers ownership of the contract to a new account (`newOwner`). Can only be called by the current owner.
Parameters
address newOwner
Update ERC-20 revenue distribution. Only for mutable revenue path
Parameters
address[] _walletList: A list of member wallets
uint256[] _distribution: A list of distribution percentages
Update given revenue tier. Only for mutable revenue path
Parameters
address[] _walletList: A list of member wallets
uint256[] _distribution: A list of distribution percentages
uint256 newLimit: The new limit of the requested tier
uint256 tierNumber: The tier index for which update is being requested.
type | name | description |
---|---|---|
type | name | description |
---|---|---|
type | name | description |
---|---|---|
type | name | description |
---|---|---|
type | name | description |
---|---|---|
type | name | description |
---|---|---|
type | name | description |
---|---|---|
type | name | description |
---|---|---|
type | name | description |
---|---|---|
type | name | description |
---|---|---|
type | description |
---|---|
type | name | description |
---|---|---|
type | description |
---|---|
type | name | description |
---|---|---|
type | description |
---|---|
type | name | description |
---|---|---|
type | name | description |
---|---|---|
type | description |
---|---|
type | description |
---|---|
type | description |
---|---|
type | name | description |
---|---|---|
type | name | description |
---|---|---|
type | name | description |
---|---|---|
type | name | description |
---|---|---|
type | name | description |
---|---|---|
type | name | description |
---|---|---|
type | name | description |
---|---|---|
type | description |
---|---|
type | description |
---|---|
type | name | description |
---|---|---|
type | description |
---|---|
type | name | description |
---|---|---|
type | name | description |
---|---|---|