Yield schedule
Configure scheduled yield, dividend, and interest entitlements for token holders. Holders claim completed-period yield from the configured payment source.
The yield schedule addon configures returns for token holders. Completed periods determine entitlements. Holders claim available yield from the configured payment source.
Common use cases
- Bond coupons - Scheduled interest entitlements that bondholders claim for completed periods
- Equity dividends - Company profit entitlements that shareholders claim from the payment source
- Fund distributions - Periodic investment gain entitlements that unit holders claim
- Deposit interest - Completed-period interest entitlements that deposit token holders claim
How it works
The yield schedule addon:
- Tracks holder balances at snapshot dates
- Calculates entitlements based on holdings and yield rates
- Uses the configured payment source to fund holder claims
- Records holder claims on-chain for audit trails
Key features
| Feature | Description |
|---|---|
| Snapshot-based calculation | Captures holder balances at specific dates to determine entitlements |
| Flexible schedules | Supports configured period schedules |
| Pro-rata calculation | Calculates each holder's claimable share based on their balance |
| Payment token flexibility | Fund yield claims in the same asset or a different payment token |
Funding yield claims
Yield funding depends on the schedule type. Legacy fixed-yield schedules use the schedule's denomination asset balance. Fixed-treasury yield schedules use the configured treasury address as the payment source.
For fixed-treasury yield schedules, configure the treasury address when applicable. The treasury address must hold the required denomination asset tokens before a payment date.
Users can top up the schedule balance or feature treasury by entering a denomination asset amount and confirming the transfer with wallet verification when the action is available. The app shows the current balance and the new balance before submission.
Bond maturity funding
For bonds, the asset details show the denomination funding status needed for maturity:
- Current denomination holdings
- Required denomination amount
- Covered percentage
- Shortfall to mature, when the required denomination amount exceeds the available balance
Use these values to top up the reserve before or at maturity so the bond has enough denomination asset tokens available for repayment.
Prerequisites
- Asset must be configured with yield schedule addon enabled
- Governance permission to configure a fixed-treasury yield treasury address when applicable
- Treasury or denomination asset source must hold enough payment tokens for scheduled payments or bond maturity
- Wallet verification for funding transfers and treasury updates
- Withdrawals require the yield schedule address to match the authorized token
Further reading
For technical details on yield schedule implementation, see the architecture documentation.
Withdraw expired
Learn how to recover your assets from an expired XvP settlement. When the cutoff date passes without execution, original senders can withdraw their locked assets.
Bond lifecycle prerequisites
Prepare bond funding, yield claims, maturity, and redemption in DALP by checking the required features, treasuries, allowances, and indexed status values before each phase.