Skip to content

Commit 308c540

Browse files
committed
docs: add overview
1 parent 9cc6414 commit 308c540

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

contracts/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,18 @@ NFT Staking contracts
2323

2424
### pfc-vault
2525
Simple vault contract.
26+
27+
# how do/can they interact ?
28+
29+
![](../images/overview.png "overview")
30+
31+
native denoms comes into the system via 'fee-splitter' contract. the funds get split via the allocation table
32+
and either TRANSFERed to a wallet, or SEND to a smart contract, in this case, the 'vault' contract.
33+
34+
the vault accumulates the denoms, and allows people who hold the governance token (in astroport's case the LP token of the pair) to claim their portion when they choose.
35+
36+
the person needs to deposit their governance token in to start accumulating rewards.
37+
38+
the astroport-generator sits between the end-user and the vault itself, so the vault only sees a single address (the astroport smart contract) as the holder of it's LP tokens.
39+
it forwards the 'claim' function from astroport, and send rewards (in total for the smart contract).
40+
Astrport then determines how much of that sends to the individual. (how is out of scope)

images/overview.png

51.4 KB
Loading

0 commit comments

Comments
 (0)