Glossary

4.1 Glossary

This glossary defines the formal terminology used throughout the Modulexo documentation.

All terms correspond to contract state or deterministic logic.


Accounting Unit

A ledger entry created when ERC-20 tokens are surrendered via:

sponsor(beneficiary, token, tokenAmountUnits)

Accounting units:

• Exist only in SponsorshipLedger • Represent recyclable capacity • Are consumed during recycle() • Are not transferable • Are not tokens


accNativePerWeight

A cumulative distribution variable stored in RecyclingEngine.

Represents:

Accumulated native value per unit of weight.

Used in claim calculation:

(weight × accNativePerWeight / ACC_SCALE) − rewardDebt

Monotonic increasing.


BlackHole

The address returned by:

ERC-20 tokens sent here are considered permanently removed from circulation.

Ledger forwards tokens to this address upon sponsorship.


Claim

Execution of:

Transfers claimable native value to caller.

Emits:


Claimable

The native amount currently available to claim.

Returned by:

Derived from ledger math.


Governance

Contract-based authority structure:

Weighted Governor → Timelock → Fund

Determines treasury actions and controlled parameter updates.


Ledger

Refers to SponsorshipLedger contract.

Maintains:

Tracks unit allocation and consumption.

Does not hold ERC-20 reserves for speculation.


Native

The base gas token of a chain (e.g., ETH, MATIC, BNB).

Recycle execution requires native payment via msg.value.

Distribution is denominated in native.


Owner

Address returned by:

May control parameters if ownership not transferred to Timelock or renounced.


Recycle

Execution call:

Consumes accounting units and mints weight.


Recycle Rail

Portion of native value allocated for proportional distribution.

Increases:


Registry

Refers to RecycleAssetRegistry contract.

Defines:

• Enabled tokens • Unit ratios • Caps


rewardDebt

Internal variable tracking previously settled distribution for an address.

Prevents double claim.


Router

Contract referenced by:

Splits native value into defined rails.


Share

A ledger entry in Fund representing proportional treasury participation.

Queried via:

Used for governance weight.


Sponsorship

The act of surrendering ERC-20 tokens to create accounting units.

Executed via:


Timelock

Contract that executes governance-approved actions after delay.

Prevents immediate administrative execution.


totalWeight

Total accounting weight minted in RecyclingEngine.

Queried via:

Used to compute proportional distribution.


Weight

Non-transferable accounting metric minted during recycle().

Queried via:

Determines proportional share of recycle rail distribution.

Weight is not a token.

Last updated