update(RingBuffers): add getBufferCardinality to DrawHistory/PrizeDis…

…tributionHistory
pooltogether · Oct 6, 2021 · 52e6c9a · 52e6c9a
1 parent 5967c1a
commit 52e6c9a
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 1 deletion.
diff --git a/contracts/DrawHistory.sol b/contracts/DrawHistory.sol
@@ -45,6 +45,11 @@ contract DrawHistory is IDrawHistory, Manageable {
 
     /* ============ External Functions ============ */
 
+    /// @inheritdoc IDrawHistory
+    function getBufferCardinality() external view override returns (uint32) {
+        return drawRingBuffer.cardinality;
+    }
+
     /// @inheritdoc IDrawHistory
     function getDraw(uint32 drawId) external view override returns (IDrawBeacon.Draw memory) {
         return _draws[_drawIdToDrawIndex(drawRingBuffer, drawId)];

diff --git a/contracts/PrizeDistributionHistory.sol b/contracts/PrizeDistributionHistory.sol
@@ -51,6 +51,11 @@ contract PrizeDistributionHistory is IPrizeDistributionHistory, Manageable {
 
     /* ============ External Functions ============ */
 
+    /// @inheritdoc IPrizeDistributionHistory
+    function getBufferCardinality() external view override returns (uint32) {
+        return bufferMetadata.cardinality;
+    }
+
     /// @inheritdoc IPrizeDistributionHistory
     function getPrizeDistribution(uint32 _drawId)
         external

diff --git a/contracts/interfaces/IDrawHistory.sol b/contracts/interfaces/IDrawHistory.sol
@@ -16,6 +16,12 @@ interface IDrawHistory {
      */
     event DrawSet(uint32 indexed drawId, IDrawBeacon.Draw draw);
 
+    /**
+     * @notice Read a ring buffer cardinality
+     * @return Ring buffer cardinality
+     */
+    function getBufferCardinality() external view returns (uint32);
+
     /**
      * @notice Read a Draw from the draws ring buffer.
      * @dev    Read a Draw using the Draw.drawId to calculate position in the draws ring buffer.

diff --git a/contracts/interfaces/IPrizeDistributionHistory.sol b/contracts/interfaces/IPrizeDistributionHistory.sol
@@ -38,6 +38,12 @@ interface IPrizeDistributionHistory {
         IPrizeDistributionHistory.PrizeDistribution prizeDistribution
     );
 
+    /**
+     * @notice Read a ring buffer cardinality
+     * @return Ring buffer cardinality
+     */
+    function getBufferCardinality() external view returns (uint32);
+
     /**
      * @notice Read newest PrizeDistribution from prize distributions ring buffer.
      * @dev    Uses nextDrawIndex to calculate the most recently added PrizeDistribution.

diff --git a/test/DrawHistory.test.ts b/test/DrawHistory.test.ts
@@ -39,6 +39,13 @@ describe('DrawHistory', () => {
         await drawHistory.setManager(wallet1.address);
     });
 
+    describe.only('getBufferCardinality()', () => {
+        it('should read buffer cardinality set in constructor', async () => {
+            expect(await drawHistory.getBufferCardinality())
+                .to.equal(3)
+        });
+    })
+
     describe('getNewestDraw()', () => {
         it('should error when no draw history', async () => {
             await expect(drawHistory.getNewestDraw()).to.be.revertedWith('DRB/future-draw');

diff --git a/test/PrizeDistributionHistory.test.ts b/test/PrizeDistributionHistory.test.ts
@@ -53,6 +53,13 @@ describe('PrizeDistributionHistory', () => {
         await prizeDistributionHistory.setManager(wallet1.address);
     });
 
+    describe('getBufferCardinality()', () => {
+        it('should read buffer cardinality set in constructor', async () => {
+            expect(await prizeDistributionHistory.getBufferCardinality())
+                .to.equal(3)
+        });
+    })
+
     describe('getNewestPrizeDistribution()', () => {
         it('should error when no draw history', async () => {
             await expect(prizeDistributionHistory.getNewestPrizeDistribution()).to.be.revertedWith(
@@ -130,7 +137,7 @@ describe('PrizeDistributionHistory', () => {
 
         // @TODO: Create PrizeDistributionHistory harness smart contract to expose
         describe('_estimateDrawId()', () => {
-            it('should return Draw ID 0 when no history', async () => {});
+            it('should return Draw ID 0 when no history', async () => { });
         });
     });