Skip to content

docs: add missing project_registry and investment_vault events to EVENTS.md (Closes #330) #344

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
laurentketterle-hub wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add missing project_registry and investment_vault events to EVENTS.md (Closes #330) #344

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 102 additions & 0 deletions EVENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,18 @@ Each event lists the public [`INTERFACE.md`](INTERFACE.md) function(s) that emit
- **Description**: Emitted when a project's impact scores and corresponding interest rate are updated.
- **Emitted by**: [`update_impact_score`](INTERFACE.md#projectregistry) / [`update_impact_score_approved`](INTERFACE.md#projectregistry) (both scores), [`update_credit_quality_score`](INTERFACE.md#projectregistry) (credit quality only)

### `project_updated`
- **Topics**: `["project", "updated"]`
- **Data**: `(project_id: u32, credit_quality: u32, green_impact: u32)`
- **Description**: Emitted when the oracle updates a project's credit-quality / green-impact scores (#6).
- **Emitted by**: [`update_impact_score`](INTERFACE.md#projectregistry)

### `rate_updated`
- **Topics**: `["project", "rate_updated"]`
- **Data**: `(project_id: u32, rate_bps: u32)`
- **Description**: Emitted when a project's interest rate is recalculated (#129).
- **Emitted by**: [`recalculate_rate`](INTERFACE.md#projectregistry)

### `project_archived`
- **Topics**: `["project", "archived"]`
- **Data**: `(project_id: u32)`
Expand Down Expand Up @@ -48,8 +60,68 @@ Each event lists the public [`INTERFACE.md`](INTERFACE.md) function(s) that emit
- **Description**: Emitted when collateral is returned to the project owner.
- **Emitted by**: [`release_collateral`](INTERFACE.md#projectregistry)

### `collateral_liquidated`
- **Topics**: `["project", "collateral_liquidated"]`
- **Data**: `(project_id: u32, token: Address, recipient: Address, amount: i128)`
- **Description**: Emitted when collateral is liquidated by the admin (#128).
- **Emitted by**: [`liquidate_collateral`](INTERFACE.md#projectregistry)

### `whitelist_set`
- **Topics**: `["project", "whitelist_set"]`
- **Data**: `(account: Address, status: bool)`
- **Description**: Emitted when an account's whitelist status is changed.
- **Emitted by**: [`set_whitelist`](INTERFACE.md#projectregistry)

### `project_certified`
- **Topics**: `["project", "certified"]`
- **Data**: `(project_id: u32, status: CertificationStatus)`
- **Description**: Emitted when a project's certification status is updated (#130).
- **Emitted by**: [`certify_project`](INTERFACE.md#projectregistry)

### `proposal_created`
- **Topics**: `["governance", "proposal_created"]`
- **Data**: `(proposal_id: u32, proposer: Address, voting_ends_at: u64)`
- **Description**: Emitted when a governance proposal is created (#134).
- **Emitted by**: [`create_proposal`](INTERFACE.md#projectregistry)

### `vote_cast`
- **Topics**: `["governance", "vote_cast"]`
- **Data**: `(proposal_id: u32, voter: Address, support: bool, weight: i128)`
- **Description**: Emitted when a vote is cast on a proposal (#134).
- **Emitted by**: [`cast_vote`](INTERFACE.md#projectregistry)

### `proposal_executed`
- **Topics**: `["governance", "proposal_executed"]`
- **Data**: `(proposal_id: u32, passed: bool)`
- **Description**: Emitted when a proposal is finalised (#134).
- **Emitted by**: [`execute_proposal`](INTERFACE.md#projectregistry)

## Investment Vault Events

### `deposit`
- **Topics**: `["vault", "deposit"]`
- **Data**: `(from: Address, usdc_amount: i128, shares_minted: i128)`
- **Description**: Emitted when an investor deposits USDC and receives vault shares.
- **Emitted by**: [`deposit`](INTERFACE.md#investmentvault)

### `withdraw`
- **Topics**: `["vault", "withdraw"]`
- **Data**: `(from: Address, shares_burned: i128, usdc_returned: i128)`
- **Description**: Emitted when an investor burns shares and withdraws USDC.
- **Emitted by**: [`withdraw`](INTERFACE.md#investmentvault)

### `withdraw_queued`
- **Topics**: `["vault", "withdraw_queued"]`
- **Data**: `(from: Address, shares_burned: i128, usdc_owed: i128)`
- **Description**: Emitted when a withdrawal is queued because liquid USDC is insufficient (#3). Shares are burned immediately; USDC will be paid when claim() is called.
- **Emitted by**: [`queue_withdrawal`](INTERFACE.md#investmentvault)

### `withdraw_claimed`
- **Topics**: `["vault", "withdraw_claimed"]`
- **Data**: `(to: Address, usdc_paid: i128, claim_index: u64)`
- **Description**: Emitted when a queued redemption claim is settled by claim() (#3).
- **Emitted by**: [`claim`](INTERFACE.md#investmentvault)

### `project_funded`
- **Topics**: `["vault", "project_funded"]`
- **Data**: `(project_id: u32, amount: i128, recipient: Address)`
Expand All @@ -61,3 +133,33 @@ Each event lists the public [`INTERFACE.md`](INTERFACE.md) function(s) that emit
- **Data**: `(from: Address, amount: i128)`
- **Description**: Emitted when yield repayment USDC is received from a project and folded into the yield-per-share accumulator for later claims.
- **Emitted by**: [`receive_yield`](INTERFACE.md#investmentvault)

### `yield_claimed`
- **Topics**: `["vault", "yield_claimed"]`
- **Data**: `(to: Address, amount: i128)`
- **Description**: Emitted when a shareholder claims accumulated yield (#125).
- **Emitted by**: [`claim_yield`](INTERFACE.md#investmentvault)

### `insurance_claimed`
- **Topics**: `["vault", "insurance_claimed"]`
- **Data**: `(project_id: u32, recipient: Address, amount: i128)`
- **Description**: Emitted when an insurance payout is made for a defaulted project (#135).
- **Emitted by**: [`claim_insurance`](INTERFACE.md#investmentvault)

### `paused`
- **Topics**: `["vault", "paused"]`
- **Data**: `()` (no data)
- **Description**: Emitted when the vault is paused (emergency stop).
- **Emitted by**: [`pause`](INTERFACE.md#investmentvault)

### `unpaused`
- **Topics**: `["vault", "unpaused"]`
- **Data**: `()` (no data)
- **Description**: Emitted when the vault is unpaused.
- **Emitted by**: [`unpause`](INTERFACE.md#investmentvault)

### `emergency_admin_changed`
- **Topics**: `["vault", "emergency_admin_changed"]`
- **Data**: `(new_emergency_admin: Option<Address>)`
- **Description**: Emitted when the admin sets or clears the emergency-admin address (#43).
- **Emitted by**: [`set_emergency_admin`](INTERFACE.md#investmentvault)
Loading