Update Readme.

joystream-api/Readme.md

@@ -1,24 +1,34 @@
 # KPI 25.II-3 - Minting and Burning Part 1
+
+Warn report is `unknownSources.log` which contains all the `WARN` blocks, where we cannot calculate what affected the issuance (e.g. a bug with burned stake for Working Groups)
+
+Full report is `mintingAndBurning.log` which contains all the blocks, where minting and/or burning affected the total issuance
+
 ## Minting Sources:
 ### Event-based
-* `staking.Reward` - reward for staking to validators/nominators
-* `proposalsEngine.ProposalStatusUpdated` - spending proposal execution increase issuance
-* `balances.BalanceSet` - when sudo account sets new balance
+* `balances.BalanceSet` - when sudo account sets new balance, amount is taken from event data
+* `proposalsEngine.ProposalStatusUpdated` - when proposal has type **Spending** (`isSpending`) is approved and executed, amount is taken from proposal params
+* `staking.Reward` - when validators and nominators are getting staking reward, amount is taken from event data
 ### Non-event-based
-* `recurring rewards` - to understand when reward increase issuance we check `next_payment_at_block` at the previous block hash, assuming next block worker will be paid
+* `Working groups workers recurring rewards` - to understand when reward increase issuance we check `next_payment_at_block` at the previous block hash, assuming next block worker will be paid out
 ## Burning Sources
 ### Event-based
-* `balances.Transfer` - transfer to burn address
-* `members.MemberRegistered` - member registration fee
-* `proposalsEngine.cancelProposal` - cancellation fee
-* `utility.batch` - tip is burned
-* `staking.bond` - tip is burned
-* `session.setKeys` - tip is burned
-* `staking.nominate` - tip is burned
-* `members.buyMembership` - tip is burnedc
+* `proposalsEngine.ProposalStatusUpdated` - when proposal is rejected or expired, fee is burned (hardcoded value of 5000 JOY)
+### Extrinsic-based
+* `balances.transfer` - transfer to burn address leads to burning, amount taken from extrinsics tip
+* `members.buyMembership` - when new member is regitered, fee amount is taken from `members.paidMembershipTermsById`
+* `proposalsEngine.cancelProposal` - when proposal is cancelled, cancellation fee is burned (Hardcoded value of 10000 JOY)
+* `utility.batch` - amount taken from extrinsics tip
+* `staking.bond` - amount taken from extrinsics tip
+* `session.setKeys` - amount taken from extrinsics tip
+* `staking.nominate` - amount taken from extrinsics tip
+* `members.buyMembership` - amount taken from extrinsics tip
+* `operationsWorkingGroup.updateRewardAmount` - when storage worker reward amount is updated, amount is added to `amount_per_payout` property of specific worker rewardRelationship
+* `contentDirectoryWorkingGroup.updateRewardAmount` - when storage worker reward amount is updated, amount is added to `amount_per_payout` property of specific worker rewardRelationship
+* `storageWorkingGroup.updateRewardAmount` - when storage worker reward amount is updated, amount is added to `amount_per_payout` property of specific worker rewardRelationship
 
 ## Running script
-`yarn start <startBlock> <endBlock>` - Generates two files in `report` folder: s
+`yarn start <startBlock> <endBlock>` - Generates two files in `report` folder:
  - `mintingAndBurning.log`: every line is a block where totalIssuance has been changed, showing new issuance, previous issuance, tokens minted and burned. Every line is prefixed with `INFO` if minting and burning source is calculated, `WARN` if the source is unknown
 
  - `mintingAndBurning.json`: detailed report of what exactly changed the issuance in a specific block (e.g. Staking Reward, Cancelled Proposal, Spending Proposal, Set Sudo Balance, Recurring Rewards, Membership Creation, Transfer to Burn Address)