Skip to content

Commit 8f6048c

Browse files
authored
Merge pull request #35 from SiegfriedBz/update-docs
chore(docs): update READMEs
2 parents d24758f + af23c53 commit 8f6048c

3 files changed

Lines changed: 5 additions & 4 deletions

File tree

apps/contracts/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Constructor parameters: `reputationBoost`, `aiAgent`, `treasury`, `pubMinFee`, `
6363

6464
| Function | Description |
6565
|----------|-------------|
66-
| `submitPublication(cid, paidSubmissionFee)` | Submit a publication with IPFS CID. Requires `msg.value == I_PUBLISHER_STAKE + paidSubmissionFee`. Emits `SubmitPublication`. |
66+
| `submitPublication(cid)` | Submit a publication with IPFS CID. Requires `msg.value >= I_PUBLISHER_STAKE + I_PUBLISHER_MIN_FEE`. The stake is fixed; the submission fee is derived as `msg.value - I_PUBLISHER_STAKE` and stored as `paidSubmissionFee` (funds VRF). Emits `SubmitPublication`. |
6767
| `payReviewerStake()` | Stake exactly `I_REVIEWER_STAKE` to join the reviewer pool. Registers the member if new. |
6868
| `claim(amount)` | Withdraw `amount` from `availableStake`. Non-reentrant. |
6969
| `receive()` | Accept ETH donations into `rewardPool`. |

docs/architecture.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ sequenceDiagram
3636
IPFS-->>S: rootCid (manifest)
3737
3838
Note over S,BC: Phase 2 -- On-Chain Submission
39-
S->>BC: submitPublication(cid, paidSubmissionFee) + stake
39+
S->>BC: submitPublication(cid) with msg.value (stake + fee)
40+
Note right of BC: stake=fixed I_PUBLISHER_STAKE; paidFee=msg.value-stake
4041
BC->>BC: emit SubmitPublication
4142
4243
Note over BC,DB: Phase 3 -- Event Projection

packages/agents/graphs/submission/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ LangGraph agent that autonomously pre-validates scientific submissions for origi
44

55
## Trigger Chain
66

7-
A user calls `submitPublication(cid, fee)` on the `BioVerifyV3` smart contract, which emits a `SubmitPublication` event. That event flows through the infrastructure pipeline into this agent:
7+
A user calls `submitPublication(cid)` on the `BioVerifyV3` smart contract (sending `msg.value = stake + fee`), which emits a `SubmitPublication` event. The stake is protocol-fixed; the fee is derived on-chain as `msg.value - stake`. That event flows through the infrastructure pipeline into this agent:
88

99
```mermaid
1010
sequenceDiagram
@@ -17,7 +17,7 @@ sequenceDiagram
1717
participant Inngest
1818
participant Agent as Submission Agent
1919
20-
User->>BioVerifyV3: submitPublication(cid, fee) + stake
20+
User->>BioVerifyV3: submitPublication(cid) with msg.value (stake + fee)
2121
BioVerifyV3-->>AlchemyNotify: emits SubmitPublication event
2222
AlchemyNotify->>NextAPI: POST /api/webhooks/alchemy/all-events
2323
NextAPI->>CQRS: decode log + processContractEvent()

0 commit comments

Comments
 (0)