Configure holder-claimed yield schedules with DALP

Configure fixed yield periods for token holders. The schedule records period timing, rates, denomination asset balances, and holder claims.

A yield schedule defines periodic return entitlements for a token. DALP records the schedule rate, interval, start and end times, denomination asset, claim totals, and each period's status so operators and holders can see what is scheduled, active, completed, claimed, and still unclaimed.

When to use a yield schedule

Use a yield schedule when holders receive periodic returns from a tokenised asset and the entitlement can be expressed as a fixed rate over configured periods.

Use case	What the schedule represents
Bond coupons	Interest periods that bondholders can claim after each period completes
Equity dividends	Dividend periods backed by the configured payment source
Fund distributions	Distribution periods for fund or unit holders
Deposit interest	Interest periods for deposit token holders

Before you configure yield

You need:

A token that supports the yield schedule addon.
Permission to submit the yield schedule transaction for the selected system.
The yield rate in basis points. For example, 500 means 5%.
A payment interval, such as MONTHLY, QUARTERLY, YEARLY, or a positive interval in seconds.
A start time and end time. The end time must be after the start time.
An ISO 3166-1 numeric country code for the schedule jurisdiction.
A denomination asset balance or configured treasury source that can fund the expected claims.

Configure the schedule

Create the schedule with the token address, rate, interval, start time, end time, and country code. DALP submits the create transaction through the transaction queue, waits for the schedule deployment to index, then reads the created schedule back from indexed data.

dalp fixed-yield-schedules create \
  --token 0x1111111111111111111111111111111111111111 \
  --yieldRate 500 \
  --paymentInterval QUARTERLY \
  --startTime 2030-01-01T00:00:00Z \
  --endTime 2031-01-01T00:00:00Z \
  --countryCode 840

The schedule read model includes:

Field	Meaning
`id`	Yield schedule contract address
`startDate` and `endDate`	Unix timestamps for the schedule boundary
`rate`	Yield rate in basis points
`interval`	Payment interval in seconds
`denominationAsset`	Payment asset address, decimals, and symbol
`totalClaimed`	Total amount holders have claimed
`totalUnclaimedYield`	Total generated yield that remains unclaimed
`totalYield`	Total generated yield across the schedule
`currentPeriod`	Active period, or `null` when no period is active
`nextPeriod`	Next scheduled period, or `null` when there is no next period
`periods`	All indexed periods with timing, totals, and completion status

Read period status

Each period has a composite ID, start and end timestamps, total claimed amount, total unclaimed yield, total generated yield, and a completion flag. The DALP app displays these periods with a status of scheduled, active, or completed, plus claimed versus total yield progress.

dalp fixed-yield-schedules read 0x2222222222222222222222222222222222222222

Use the period table to answer four operational questions:

Which period is active now?
Which period is next?
How much yield has been generated for a completed period?
How much of that yield holders have already claimed?

Fund holder claims

Yield claims need a payment source. 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 a fixed yield schedule, top up the schedule balance before holders need to claim completed-period yield. Use the parent token address for --tokenAddress; the system resolves the denomination asset for the schedule.

dalp fixed-yield-schedules top-up \
  --address 0x2222222222222222222222222222222222222222 \
  --tokenAddress 0x1111111111111111111111111111111111111111 \
  --amount 100000

The app shows the current balance and the new balance before submission. Funding and treasury updates require wallet verification when the action is available.

Claim or withdraw funds

Holders claim from the schedule after yield is available.

dalp fixed-yield-schedules claim 0x2222222222222222222222222222222222222222

Operators can withdraw denomination asset tokens from the schedule address when the schedule address matches the authorised token and the withdrawal action is available. Use the parent token address for --tokenAddress.

dalp fixed-yield-schedules withdraw \
  --address 0x2222222222222222222222222222222222222222 \
  --tokenAddress 0x1111111111111111111111111111111111111111 \
  --amount 10000 \
  --to 0x4444444444444444444444444444444444444444

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.

Operational notes

Schedule creation can succeed on-chain before the schedule is visible in reads. If the schedule deployment has not indexed yet, retry the read later.
Period timestamps are Unix timestamps in the indexed schedule data.
Amounts use the denomination asset's decimals and symbol.
A payment interval can be a named interval or a positive number of seconds, depending on the integration surface.
The docs page covers fixed yield schedule behaviour. If your asset uses a fixed treasury yield schedule, verify the configured treasury address and denomination asset balance for that asset.

Yield schedule