Skip to content

Add glossary entries for insurance pool terms #408

Description

@Levi-Ojukwu

Description:

The docs/glossary.md file defines protocol and DeFi terminology used across the ILN documentation. Several insurance-related terms used in the codebase and documentation are not defined:

  • Insurance Pool — A smart contract that provides default-protection for liquidity providers. LPs optionally opt in by paying premiums; when an invoice they funded defaults, the pool compensates them.
  • Premium — A payment made by an LP to the insurance pool to obtain default protection coverage. Tracked as accounting balance (token transfers are a follow-up).
  • Coverage Cap — The maximum flat amount the insurance pool will pay out per claim, configured at pool initialization.
  • Claim — The process of requesting compensation from the insurance pool after an invoice defaults. Only the pool admin (the liquidity contract) can file claims.
  • Enrollment — The act of registering an LP in the insurance program, making them eligible for default protection.
  • Default Protection — Insurance coverage that compensates LPs for losses due to invoice defaults.

Why it matters: New contributors and integrators need consistent terminology to understand the protocol. Missing glossary entries create confusion and slow onboarding.

Acceptance Criteria:

  • Add entries for all insurance-related terms listed above
  • Follow the existing glossary format (term, definition, cross-references)
  • Include cross-references to relevant documentation pages

Relevant Files: docs/glossary.md, contracts/insurance_pool/


Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial Campaign | FWC26Campaign: Official Campaign | FWC26

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions