snapshot and docgen

.gas-snapshot

@@ -43,8 +43,8 @@ LockedNORITest:testNormalWithdrawal() (gas: 1102743)
 LockedNORITest:testReentryTokensReceived() (gas: 1102887)
 LockedNORITest:testReentryTokensToSend() (gas: 1104432)
 LockedNORITest:testTokensReceivedReverts() (gas: 69026)
-MarketInvariantTest:invariant_callSummary() (runs: 400, calls: 6000, reverts: 4243)
-MarketInvariantTest:invariant_sumOfPurchaseAmounts() (runs: 400, calls: 6000, reverts: 4262)
+MarketInvariantTest:invariant_callSummary() (runs: 400, calls: 6000, reverts: 4267)
+MarketInvariantTest:invariant_sumOfPurchaseAmounts() (runs: 400, calls: 6000, reverts: 4261)
 MarketSupplierSelectionNotUsingUpSuppliersLastRemoval:test() (gas: 923731)
 Market_ALLOWLIST_ROLE:test() (gas: 12799)
 Market_SANCTION_ALLOWLIST_ROLE:test() (gas: 12897)
@@ -124,7 +124,7 @@ Removal__createRemovalData:test_reverts_InvalidData() (gas: 25711)
 Removal__createRemovalDataBatch:test() (gas: 29572)
 Removal__createRemovalDataBatch:test_reverts_InvalidData2() (gas: 36714)
 Removal__isValidTransferAmount:testFuzz_ReturnFalse_NonMultiplesOf1e14(uint256) (runs: 256, μ: 13891, ~: 13847)
-Removal__isValidTransferAmount:testFuzz_ReturnTrue_MultiplesOf1e14(uint256) (runs: 256, μ: 14361, ~: 14497)
+Removal__isValidTransferAmount:testFuzz_ReturnTrue_MultiplesOf1e14(uint256) (runs: 256, μ: 14369, ~: 14497)
 Removal__isValidTransferAmount:testFuzz_ReturnTrue_SmallestGranularity() (gas: 6832)
 Removal__isValidTransferAmount:test_ReturnFalse_AmountIsTooGranular() (gas: 6898)
 Removal__isValidTransferAmount:test_ReturnFalse_AmountIsTooGranularAndToIsTheCertificate() (gas: 4745)

docs/Removal.md

@@ -169,6 +169,24 @@ Emitted on releasing a removal from a supplier, the market, or a certificate.
 | amount | uint256 | The amount that was released. |
 
 
+### Migrate
+
+```solidity
+event Migrate(address certificateRecipient, uint256 certificateAmount, uint256 certificateId, uint256[] removalIds, uint256[] removalAmounts)
+```
+
+Emitted when legacy removals are minted and then immediately used to migrate a legacy certificate.
+
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| certificateRecipient | address | The recipient of the certificate to mint via migration. |
+| certificateAmount | uint256 | The total amount of the certificate to mint via migration (denominated in NRTs). |
+| certificateId | uint256 | The ID of the certificate to mint via migration. |
+| removalIds | uint256[] | The removal IDs to use to mint the certificate via migration. |
+| removalAmounts | uint256[] | The amounts for each corresponding removal ID to use to mint the certificate via migration. |
+
+
 ### Retire
 
 ```solidity