# boid-com/boiddonation architecture

> Architecture diagram of the GitHub repository boid-com/boiddonation, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-22). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/boid-com/boiddonation
- Repository: https://github.com/boid-com/boiddonation

## Overview

boiddonation is an EOSIO donation contract: users transfer whitelisted tokens during a promotion window, the contract records contributions and account levels, computes rewards from each token’s regenerating power pool, and may grant Boid Power through an oracle action. Administrators configure the promotion and token pools; the repository also includes JavaScript utilities for submitting contract transactions and configuring permissions. The graph reflects the sampled contract and utilities; unsampled utility behavior and deployment details are not inferred.

Main entry points: [`src/boiddonation.cpp`](https://github.com/boid-com/boiddonation/blob/master/src/boiddonation.cpp) (Donation handler), [`eosjs.js`](https://github.com/boid-com/boiddonation/blob/master/eosjs.js) (EOS transaction client), [`util/resetAll.js`](https://github.com/boid-com/boiddonation/blob/master/util/resetAll.js) (Reset utility), [`util/doAction.js`](https://github.com/boid-com/boiddonation/blob/master/util/doAction.js) (Action utility)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_donation["Donation contract"]
  node_donation_handler["Donation handler<br/>[boiddonation.cpp]"]
  node_config[("Promotion config<br/>[boiddonation.hpp]")]
  node_token_pools[("Token pools<br/>[boiddonation.hpp]")]
  node_contributor_state[("Contributor records<br/>[boiddonation.hpp]")]
  node_power_logic["Power calculations<br/>[boiddonation.hpp]"]
  node_contract_actions["Admin actions<br/>[boiddonation.cpp]"]
end

subgraph group_admin["Administration utilities"]
  node_action_util["Action utility<br/>[doAction.js]"]
  node_reset_util["Reset utility<br/>[resetAll.js]"]
  node_config_values["Config values<br/>[config.js]"]
  node_token_values["Token definitions<br/>[tokens.js]"]
  node_permission_setup["Permission setup<br/>[setup.js]"]
  node_permission_rules["Permission rules<br/>[permissions.js]"]
  node_dummy_tokens["Dummy token setup<br/>[setupdummytkns.js]"]
  node_token_transfer_util["Dummy transfers<br/>[senddummytkns.js]"]
end

subgraph group_chain["Chain integrations"]
  node_power_oracle["Boid power oracle"]
  node_eosjs["EOS transaction client<br/>[eosjs.js]"]
  node_token_contract["Token contracts"]
end

node_donor(("Donor"))
node_admin(("Contract administrator"))

node_donor -->|"transfers token"| node_donation_handler
node_donation_handler -->|"reads settings"| node_config
node_donation_handler -->|"checks and updates"| node_token_pools
node_donation_handler -->|"records donation"| node_contributor_state
node_donation_handler -->|"calculates rewards"| node_power_logic
node_donation_handler -->|"sends power update"| node_power_oracle
node_admin -->|"runs actions"| node_action_util
node_action_util -->|"uses client"| node_eosjs
node_action_util -->|"submits settings"| node_config_values
node_action_util -->|"transacts actions"| node_contract_actions
node_reset_util -->|"uses client"| node_eosjs
node_reset_util -->|"submits settings"| node_config_values
node_reset_util -->|"loads token list"| node_token_values
node_reset_util -->|"transacts actions"| node_contract_actions
node_permission_setup -->|"uses client"| node_eosjs
node_permission_setup -->|"uses rules"| node_permission_rules
node_permission_setup -->|"updates permissions"| node_token_contract
node_dummy_tokens -->|"uses client"| node_eosjs
node_dummy_tokens -->|"loads token list"| node_token_values
node_dummy_tokens -->|"creates and issues"| node_token_contract
node_token_transfer_util -->|"uses client"| node_eosjs
node_token_transfer_util -->|"loads token list"| node_token_values
node_token_transfer_util -->|"sends transfers"| node_token_contract

click node_donation_handler "https://github.com/boid-com/boiddonation/blob/master/src/boiddonation.cpp"
click node_config "https://github.com/boid-com/boiddonation/blob/master/include/boiddonation.hpp"
click node_token_pools "https://github.com/boid-com/boiddonation/blob/master/include/boiddonation.hpp"
click node_contributor_state "https://github.com/boid-com/boiddonation/blob/master/include/boiddonation.hpp"
click node_power_logic "https://github.com/boid-com/boiddonation/blob/master/include/boiddonation.hpp"
click node_contract_actions "https://github.com/boid-com/boiddonation/blob/master/src/boiddonation.cpp"
click node_eosjs "https://github.com/boid-com/boiddonation/blob/master/eosjs.js"
click node_action_util "https://github.com/boid-com/boiddonation/blob/master/util/doAction.js"
click node_reset_util "https://github.com/boid-com/boiddonation/blob/master/util/resetAll.js"
click node_config_values "https://github.com/boid-com/boiddonation/blob/master/util/config.js"
click node_token_values "https://github.com/boid-com/boiddonation/blob/master/util/tokens.js"
click node_permission_setup "https://github.com/boid-com/boiddonation/blob/master/util/setup.js"
click node_permission_rules "https://github.com/boid-com/boiddonation/blob/master/util/permissions.js"
click node_dummy_tokens "https://github.com/boid-com/boiddonation/blob/master/util/setupdummytkns.js"
click node_token_transfer_util "https://github.com/boid-com/boiddonation/blob/master/util/senddummytkns.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_donation_handler,node_config,node_token_pools,node_contributor_state,node_power_logic,node_contract_actions toneBlue
class node_action_util,node_reset_util,node_config_values,node_token_values,node_permission_setup,node_permission_rules,node_dummy_tokens,node_token_transfer_util toneAmber
class node_power_oracle,node_eosjs,node_token_contract toneMint
class node_donor,node_admin toneIndigo
```

## Components

### Donation contract

- [Donation handler](https://github.com/boid-com/boiddonation/blob/master/src/boiddonation.cpp): `src/boiddonation.cpp`
- [Promotion config](https://github.com/boid-com/boiddonation/blob/master/include/boiddonation.hpp): `include/boiddonation.hpp`
- [Token pools](https://github.com/boid-com/boiddonation/blob/master/include/boiddonation.hpp): `include/boiddonation.hpp`
- [Contributor records](https://github.com/boid-com/boiddonation/blob/master/include/boiddonation.hpp): `include/boiddonation.hpp`
- [Power calculations](https://github.com/boid-com/boiddonation/blob/master/include/boiddonation.hpp): `include/boiddonation.hpp`
- [Admin actions](https://github.com/boid-com/boiddonation/blob/master/src/boiddonation.cpp): `src/boiddonation.cpp`

### Administration utilities

- [Action utility](https://github.com/boid-com/boiddonation/blob/master/util/doAction.js): `util/doAction.js`
- [Reset utility](https://github.com/boid-com/boiddonation/blob/master/util/resetAll.js): `util/resetAll.js`
- [Config values](https://github.com/boid-com/boiddonation/blob/master/util/config.js): `util/config.js`
- [Token definitions](https://github.com/boid-com/boiddonation/blob/master/util/tokens.js): `util/tokens.js`
- [Permission setup](https://github.com/boid-com/boiddonation/blob/master/util/setup.js): `util/setup.js`
- [Permission rules](https://github.com/boid-com/boiddonation/blob/master/util/permissions.js): `util/permissions.js`
- [Dummy token setup](https://github.com/boid-com/boiddonation/blob/master/util/setupdummytkns.js): `util/setupdummytkns.js`
- [Dummy transfers](https://github.com/boid-com/boiddonation/blob/master/util/senddummytkns.js): `util/senddummytkns.js`

### Chain integrations

- **Boid power oracle**
- [EOS transaction client](https://github.com/boid-com/boiddonation/blob/master/eosjs.js): `eosjs.js`
- **Token contracts**

### Other components

- **Donor**
- **Contract administrator**

## Connections

- Donor → Donation handler: transfers token (evidence: `src/boiddonation.cpp`)
- Donation handler → Promotion config: reads settings (evidence: `src/boiddonation.cpp`)
- Donation handler → Token pools: checks and updates (evidence: `src/boiddonation.cpp`)
- Donation handler → Contributor records: records donation (evidence: `src/boiddonation.cpp`)
- Donation handler → Power calculations: calculates rewards (evidence: `src/boiddonation.cpp`)
- Donation handler → Boid power oracle: sends power update (evidence: `src/boiddonation.cpp`)
- Contract administrator → Action utility: runs actions (evidence: `util/doAction.js`)
- Action utility → EOS transaction client: uses client (evidence: `util/doAction.js`)
- Action utility → Config values: submits settings (evidence: `util/doAction.js`)
- Action utility → Admin actions: transacts actions (evidence: `util/doAction.js`)
- Reset utility → EOS transaction client: uses client (evidence: `util/resetAll.js`)
- Reset utility → Config values: submits settings (evidence: `util/resetAll.js`)
- Reset utility → Token definitions: loads token list (evidence: `util/resetAll.js`)
- Reset utility → Admin actions: transacts actions (evidence: `util/resetAll.js`)
- Permission setup → EOS transaction client: uses client (evidence: `util/setup.js`)
- Permission setup → Permission rules: uses rules (evidence: `util/setup.js`)
- Permission setup → Token contracts: updates permissions (evidence: `util/setup.js`)
- Dummy token setup → EOS transaction client: uses client (evidence: `util/setupdummytkns.js`)
- Dummy token setup → Token definitions: loads token list (evidence: `util/setupdummytkns.js`)
- Dummy token setup → Token contracts: creates and issues (evidence: `util/setupdummytkns.js`)
- Dummy transfers → EOS transaction client: uses client (evidence: `util/senddummytkns.js`)
- Dummy transfers → Token definitions: loads token list (evidence: `util/senddummytkns.js`)
- Dummy transfers → Token contracts: sends transfers (evidence: `util/senddummytkns.js`)
