SplitterTreasury_v1

Source: src/core/treasuries/SplitterTreasury_v1.sol. Interfaces: ISplitterTreasury_v1, ITreasury_v1.

Functions

fetchFunds

function fetchFunds(address token_, uint amount_) external;

Fetches token funds into the treasury. Parameters

Name	Type	Description
`token_`	`address`	The address of the token to fetch.
`amount_`	`uint`	The amount of tokens to fetch.

ITreasury_v1.sol#L49

setElevation

function setElevation(address treasury_, uint shares_) external;

Sets the referenceCurve raise treasury address and its share count atomically. Parameters

Name	Type	Description
`treasury_`	`address`	The new referenceCurve raise treasury address (non-zero).
`shares_`	`uint`	The new referenceCurve raise share count (non-zero).

ISplitterTreasury_v1.sol#L259

setElevationFeePercentage

function setElevationFeePercentage(uint feePercentage_) external;

Sets the elevation fee percentage Parameters

Name	Type	Description
`feePercentage_`	`uint`	The new fee percentage in basis points (100 = 1%, 10000 = 100%)

ISplitterTreasury_v1.sol#L240

setElevationFeeTreasury

function setElevationFeeTreasury(address elevationFeeTreasury_) external;

Sets the elevation fee treasury address Parameters

Name	Type	Description
`elevationFeeTreasury_`	`address`	The new elevation fee treasury address

ISplitterTreasury_v1.sol#L246

setRecipients

function setRecipients(address[] calldata recipients_, uint[] calldata shares_) external;

Sets the recipients and their shares, replacing any existing configuration Parameters

Name	Type	Description
`recipients_`	`address[]`	Array of recipient addresses
`shares_`	`uint[]`	Array of share amounts for each recipient

ISplitterTreasury_v1.sol#L227

View functions

getElevationFeePercentage

function getElevationFeePercentage() external view returns (uint feePercentage_);

Returns the current elevation fee percentage Returns

Name	Type	Description
`feePercentage_`	`uint`	The elevation fee percentage in basis points (100 = 1%, 10000 = 100%)

ISplitterTreasury_v1.sol#L188

getElevationFeeTreasury

function getElevationFeeTreasury() external view returns (address elevationFeeTreasury_);

Returns the address of the elevation fee treasury Returns

Name	Type	Description
`elevationFeeTreasury_`	`address`	The address receiving elevation fees

ISplitterTreasury_v1.sol#L195

getElevationShares

function getElevationShares() external view returns (uint elevationShares_);

Returns the share count allocated to the referenceCurve raise treasury in the distribution Returns

Name	Type	Description
`elevationShares_`	`uint`	The referenceCurve raise share count

ISplitterTreasury_v1.sol#L213

getElevationTreasury

function getElevationTreasury() external view returns (address elevationTreasury_);

Returns the address of the referenceCurve raise treasury Returns

Name	Type	Description
`elevationTreasury_`	`address`	The address of the referenceCurve raise treasury

ISplitterTreasury_v1.sol#L205

getFunds

function getFunds(address token_) external view returns (uint funds_);

Returns the total funds in the treasury. Parameters

Name	Type	Description
`token_`	`address`	The address of the token to get the funds of.

Returns

Name	Type	Description
`funds_`	`uint`	The funds in the treasury of that specific token.

ITreasury_v1.sol#L41

getRecipientsAndShares

function getRecipientsAndShares() external view returns (address[] memory recipients_, uint[] memory shares_);

Returns all recipients and their corresponding shares Returns

Name	Type	Description
`recipients_`	`address[]`	Array of recipient addresses
`shares_`	`uint[]`	Array of share amounts corresponding to each recipient

ISplitterTreasury_v1.sol#L173

getTotalShares

function getTotalShares() external view returns (uint totalShares_);

Returns the total number of shares across all recipients Returns

Name	Type	Description
`totalShares_`	`uint`	The sum of all recipient shares

ISplitterTreasury_v1.sol#L180

Events

ElevationAllowanceNotCleared

event ElevationAllowanceNotCleared(
    address indexed token_,
    address indexed destination_,
    uint allowance_
);

Emitted when the best-effort allowance clear after an elevation callback failed, so destination_ keeps an allowance on this splitter. Parameters

Name	Type	Description
`token_`	`address indexed`	The token.
`destination_`	`address indexed`	The elevation destination (spender).
`allowance_`	`uint`	The allowance that is still outstanding.

ISplitterTreasury_v1.sol#L160

ElevationFeePaid

event ElevationFeePaid(address indexed token_, uint amount_);

Emitted when elevation fee is paid to the elevation fee treasury Parameters

Name	Type	Description
`token_`	`address indexed`	The address of the token paid
`amount_`	`uint`	The amount paid as elevation fee

ISplitterTreasury_v1.sol#L107

ElevationFeePercentageUpdated

event ElevationFeePercentageUpdated(uint oldFee_, uint newFee_);

Emitted when the elevation fee percentage is updated Parameters

Name	Type	Description
`oldFee_`	`uint`	The previous fee percentage in basis points
`newFee_`	`uint`	The new fee percentage in basis points

ISplitterTreasury_v1.sol#L112

ElevationFeeTreasuryUpdated

event ElevationFeeTreasuryUpdated(address oldTreasury_, address newTreasury_);

Emitted when the elevation fee treasury address is updated Parameters

Name	Type	Description
`oldTreasury_`	`address`	The previous treasury address
`newTreasury_`	`address`	The new treasury address

ISplitterTreasury_v1.sol#L117

ElevationPayment

event ElevationPayment(address indexed token_, uint amount_);

Emitted when a referenceCurve raise payment is forwarded via fetchFunds to the referenceCurve raise treasury Parameters

Name	Type	Description
`token_`	`address indexed`	The address of the token paid
`amount_`	`uint`	The amount paid to the referenceCurve raise treasury

ISplitterTreasury_v1.sol#L140

ElevationPaymentSkipped

event ElevationPaymentSkipped(address indexed token_, uint amount_);

Emitted when the elevation callback did not pull the full pending amount (callback reverted, destination has no code, approve failed, or an under-pull), so the rest of the distribution and the upstream op still succeed. Parameters

Name	Type	Description
`token_`	`address indexed`	The address of the token whose elevation leg was skipped
`amount_`	`uint`	The destination’s total pending (unpaid) amount after this attempt, which includes earlier unpaid slices

ISplitterTreasury_v1.sol#L152

ElevationUpdated

event ElevationUpdated(
    address oldTreasury_,
    address newTreasury_,
    uint oldShares_,
    uint newShares_
);

Emitted when the referenceCurve raise treasury or shares are updated Parameters

Name	Type	Description
`oldTreasury_`	`address`	The previous referenceCurve raise treasury address
`newTreasury_`	`address`	The new referenceCurve raise treasury address
`oldShares_`	`uint`	The previous referenceCurve raise share count
`newShares_`	`uint`	The new referenceCurve raise share count

ISplitterTreasury_v1.sol#L129

RecipientAdded

event RecipientAdded(address indexed account_, uint shares_);

Emitted when a recipient is added to the configuration Parameters

Name	Type	Description
`account_`	`address indexed`	The address of the recipient added
`shares_`	`uint`	The number of shares assigned to the recipient

ISplitterTreasury_v1.sol#L85

RecipientPayment

event RecipientPayment(address indexed token_, address indexed recipient_, uint amount_);

Emitted for each individual recipient payment Parameters

Name	Type	Description
`token_`	`address indexed`	The address of the token paid
`recipient_`	`address indexed`	The address of the recipient receiving payment
`amount_`	`uint`	The amount paid to the recipient

ISplitterTreasury_v1.sol#L97

RecipientsCleared

event RecipientsCleared();

Emitted when all recipients are cleared from the configuration ISplitterTreasury_v1.sol#L88

Treasury_FundsReceived

event Treasury_FundsReceived(address indexed token, address indexed sender, uint amount);

Emitted when token funds are received. Parameters

Name	Type	Description
`token`	`address indexed`	The address of the token received.
`sender`	`address indexed`	The address of the sender.
`amount`	`uint`	The amount of tokens received.

ITreasury_v1.sol#L31

Errors

ModuleSplitterTreasuryElevationFeeTreasuryIsZeroAddress

error Module__SplitterTreasury__ElevationFeeTreasuryIsZeroAddress();

Thrown when the elevation fee treasury address is the zero address ISplitterTreasury_v1.sol#L52

ModuleSplitterTreasuryElevationSharesAreZero

error Module__SplitterTreasury__ElevationSharesAreZero();

Thrown when referenceCurve raise shares are zero ISplitterTreasury_v1.sol#L74

ModuleSplitterTreasuryElevationTreasuryIsZeroAddress

error Module__SplitterTreasury__ElevationTreasuryIsZeroAddress();

Thrown when the referenceCurve raise treasury address is zero ISplitterTreasury_v1.sol#L66

ModuleSplitterTreasuryEmptyRecipients

error Module__SplitterTreasury__EmptyRecipients();

Thrown when recipients array is empty ISplitterTreasury_v1.sol#L58

ModuleSplitterTreasuryInvalidArrayLength

error Module__SplitterTreasury__InvalidArrayLength();

Thrown when recipients and shares arrays have different lengths ISplitterTreasury_v1.sol#L40

ModuleSplitterTreasuryInvalidElevationTreasury

error Module__SplitterTreasury__InvalidElevationTreasury(address treasury_);

Thrown when the elevation destination is the splitter itself or has no code. Parameters

Name	Type	Description
`treasury_`	`address`	The rejected destination.

ISplitterTreasury_v1.sol#L71

ModuleSplitterTreasuryInvalidFeePercentage

error Module__SplitterTreasury__InvalidFeePercentage();

Thrown when an invalid fee percentage is provided ISplitterTreasury_v1.sol#L55

ModuleSplitterTreasuryRecipientAlreadyExists

error Module__SplitterTreasury__RecipientAlreadyExists();

Thrown when attempting to add a recipient that already exists ISplitterTreasury_v1.sol#L49

ModuleSplitterTreasuryRecipientIsZeroAddress

error Module__SplitterTreasury__RecipientIsZeroAddress();

Thrown when a recipient address is the zero address ISplitterTreasury_v1.sol#L43

ModuleSplitterTreasurySharesAreZero

error Module__SplitterTreasury__SharesAreZero();

Thrown when shares for a recipient are zero ISplitterTreasury_v1.sol#L46

ModuleSplitterTreasuryTooManyRecipients

error Module__SplitterTreasury__TooManyRecipients(uint count_, uint maxCount_);

Thrown when a configuration exceeds the measured recipient cap Parameters

Name	Type	Description
`count_`	`uint`
`maxCount_`	`uint`

ISplitterTreasury_v1.sol#L61