Niwa Docs Open Niwa
Niwa Docs/Protocol/Orchard and Fruits

Orchard and Fruits

The Orchard is the planned contract that allocates fees to awake trees.

Preview: This page describes a design that is not deployed. Values and behavior can change before launch.

Fee flow#

Fee flow
Trade$NIWA poolTrading feerate to be announcedFee splitterfixed sharesOrchard80%Treasury and marketing20%Awake treesby weightOwnerharvest80%20%

Allocation#

The Orchard divides the fees of each accounting period between the trees that are eligible in that period.

treeShare = treeWeight / sumOfEligibleWeights
treeAllocation = periodFees * treeShare

The planned accounting period is one hour. A change in state or weight takes effect in the next period.

Example#

The Orchard receives 1,000 units in a period. Three trees are eligible.

TreeLevelWeightShareAllocation
A11.015.6%156.25
B31.929.7%296.88
C53.554.7%546.88

The total weight is 6.4. The units are illustrative and do not represent a currency or an expected amount.

Fruits#

Fruits display the share that a tree has accrued and that the owner has not harvested. Fruits are not a token. They cannot be transferred or traded.

ParameterValue
BackingFees held by the Orchard
Display unitTo be announced
Payout assetTo be announced
Who can harvestThe current owner of the tree

Harvest#

  1. Open the panel of a tree that you own.
  2. Review the accrued Fruits.
  3. Select Harvest and confirm the transaction.
  4. The Orchard transfers the payout asset to your wallet.
Note: The tree panel is not available in the public client. It becomes available with the contracts.
Caution: Allocations depend on trading fees. They can be zero. Niwa does not promise income, yield, or recovery of burned tokens.