refactor: rename protobuf binRecords

api/clients/v2/accountant.go

@@ -26,15 +26,15 @@ type Accountant struct {
 
 	// local accounting
 	// contains 3 bins; circular wrapping of indices
-	binRecords        []BinRecord
+	periodRecords     []PeriodRecord
 	usageLock         sync.Mutex
 	cumulativePayment *big.Int
 
 	// number of bins in the circular accounting, restricted by minNumBins which is 3
 	numBins uint32
 }
 
-type BinRecord struct {
+type PeriodRecord struct {
 	Index uint32
 	Usage uint64
 }
@@ -43,9 +43,9 @@ func NewAccountant(accountID string, reservation *core.ReservedPayment, onDemand
 	//TODO: client storage; currently every instance starts fresh but on-chain or a small store makes more sense
 	// Also client is currently responsible for supplying network params, we need to add RPC in order to be automatic
 	// There's a subsequent PR that handles populating the accountant with on-chain state from the disperser
-	binRecords := make([]BinRecord, numBins)
-	for i := range binRecords {
-		binRecords[i] = BinRecord{Index: uint32(i), Usage: 0}
+	periodRecords := make([]PeriodRecord, numBins)
+	for i := range periodRecords {
+		periodRecords[i] = PeriodRecord{Index: uint32(i), Usage: 0}
 	}
 	a := Accountant{
 		accountID:         accountID,
@@ -54,7 +54,7 @@ func NewAccountant(accountID string, reservation *core.ReservedPayment, onDemand
 		reservationWindow: reservationWindow,
 		pricePerSymbol:    pricePerSymbol,
 		minNumSymbols:     minNumSymbols,
-		binRecords:        binRecords,
+		periodRecords:     periodRecords,
 		cumulativePayment: big.NewInt(0),
 		numBins:           max(numBins, uint32(meterer.MinNumBins)),
 	}
@@ -74,22 +74,22 @@ func (a *Accountant) BlobPaymentInfo(ctx context.Context, numSymbols uint32, quo
 
 	a.usageLock.Lock()
 	defer a.usageLock.Unlock()
-	relativeBinRecord := a.GetRelativeBinRecord(currentReservationPeriod)
-	relativeBinRecord.Usage += symbolUsage
+	relativePeriodRecord := a.GetRelativePeriodRecord(currentReservationPeriod)
+	relativePeriodRecord.Usage += symbolUsage
 
 	// first attempt to use the active reservation
 	binLimit := a.reservation.SymbolsPerSecond * uint64(a.reservationWindow)
-	if relativeBinRecord.Usage <= binLimit {
+	if relativePeriodRecord.Usage <= binLimit {
 		if err := QuorumCheck(quorumNumbers, a.reservation.QuorumNumbers); err != nil {
 			return 0, big.NewInt(0), err
 		}
 		return currentReservationPeriod, big.NewInt(0), nil
 	}
 
-	overflowBinRecord := a.GetRelativeBinRecord(currentReservationPeriod + 2)
+	overflowPeriodRecord := a.GetRelativePeriodRecord(currentReservationPeriod + 2)
 	// Allow one overflow when the overflow bin is empty, the current usage and new length are both less than the limit
-	if overflowBinRecord.Usage == 0 && relativeBinRecord.Usage-symbolUsage < binLimit && symbolUsage <= binLimit {
-		overflowBinRecord.Usage += relativeBinRecord.Usage - binLimit
+	if overflowPeriodRecord.Usage == 0 && relativePeriodRecord.Usage-symbolUsage < binLimit && symbolUsage <= binLimit {
+		overflowPeriodRecord.Usage += relativePeriodRecord.Usage - binLimit
 		if err := QuorumCheck(quorumNumbers, a.reservation.QuorumNumbers); err != nil {
 			return 0, big.NewInt(0), err
 		}
@@ -98,7 +98,7 @@ func (a *Accountant) BlobPaymentInfo(ctx context.Context, numSymbols uint32, quo
 
 	// reservation not available, rollback reservation records, attempt on-demand
 	//todo: rollback on-demand if disperser respond with some type of rejection?
-	relativeBinRecord.Usage -= symbolUsage
+	relativePeriodRecord.Usage -= symbolUsage
 	incrementRequired := big.NewInt(int64(a.PaymentCharged(numSymbols)))
 	a.cumulativePayment.Add(a.cumulativePayment, incrementRequired)
 	if a.cumulativePayment.Cmp(a.onDemand.CumulativePayment) <= 0 {
@@ -143,16 +143,16 @@ func (a *Accountant) SymbolsCharged(numSymbols uint32) uint32 {
 	return uint32(core.RoundUpDivide(uint(numSymbols), uint(a.minNumSymbols))) * a.minNumSymbols
 }
 
-func (a *Accountant) GetRelativeBinRecord(index uint32) *BinRecord {
+func (a *Accountant) GetRelativePeriodRecord(index uint32) *PeriodRecord {
 	relativeIndex := index % a.numBins
-	if a.binRecords[relativeIndex].Index != uint32(index) {
-		a.binRecords[relativeIndex] = BinRecord{
+	if a.periodRecords[relativeIndex].Index != uint32(index) {
+		a.periodRecords[relativeIndex] = PeriodRecord{
 			Index: uint32(index),
 			Usage: 0,
 		}
 	}
 
-	return &a.binRecords[relativeIndex]
+	return &a.periodRecords[relativeIndex]
 }
 
 // SetPaymentState sets the accountant's state from the disperser's response
@@ -214,18 +214,18 @@ func (a *Accountant) SetPaymentState(paymentState *disperser_rpc.GetPaymentState
 		}
 	}
 
-	binRecords := make([]BinRecord, len(paymentState.GetBinRecords()))
-	for i, record := range paymentState.GetBinRecords() {
+	periodRecords := make([]PeriodRecord, len(paymentState.GetPeriodRecords()))
+	for i, record := range paymentState.GetPeriodRecords() {
 		if record == nil {
-			binRecords[i] = BinRecord{Index: 0, Usage: 0}
+			periodRecords[i] = PeriodRecord{Index: 0, Usage: 0}
 		} else {
-			binRecords[i] = BinRecord{
+			periodRecords[i] = PeriodRecord{
 				Index: record.Index,
 				Usage: record.Usage,
 			}
 		}
 	}
-	a.binRecords = binRecords
+	a.periodRecords = periodRecords
 	return nil
 }
 

api/clients/v2/accountant_test.go

@@ -43,7 +43,7 @@ func TestNewAccountant(t *testing.T) {
 	assert.Equal(t, reservationWindow, accountant.reservationWindow)
 	assert.Equal(t, pricePerSymbol, accountant.pricePerSymbol)
 	assert.Equal(t, minNumSymbols, accountant.minNumSymbols)
-	assert.Equal(t, []BinRecord{{Index: 0, Usage: 0}, {Index: 1, Usage: 0}, {Index: 2, Usage: 0}}, accountant.binRecords)
+	assert.Equal(t, []PeriodRecord{{Index: 0, Usage: 0}, {Index: 1, Usage: 0}, {Index: 2, Usage: 0}}, accountant.periodRecords)
 	assert.Equal(t, big.NewInt(0), accountant.cumulativePayment)
 }
 
@@ -76,7 +76,7 @@ func TestAccountBlob_Reservation(t *testing.T) {
 	assert.NoError(t, err)
 	assert.Equal(t, meterer.GetReservationPeriod(uint64(time.Now().Unix()), reservationWindow), header.ReservationPeriod)
 	assert.Equal(t, big.NewInt(0), header.CumulativePayment)
-	assert.Equal(t, isRotation([]uint64{500, 0, 0}, mapRecordUsage(accountant.binRecords)), true)
+	assert.Equal(t, isRotation([]uint64{500, 0, 0}, mapRecordUsage(accountant.periodRecords)), true)
 
 	symbolLength = uint32(700)
 
@@ -85,7 +85,7 @@ func TestAccountBlob_Reservation(t *testing.T) {
 	assert.NoError(t, err)
 	assert.NotEqual(t, 0, header.ReservationPeriod)
 	assert.Equal(t, big.NewInt(0), header.CumulativePayment)
-	assert.Equal(t, isRotation([]uint64{1200, 0, 200}, mapRecordUsage(accountant.binRecords)), true)
+	assert.Equal(t, isRotation([]uint64{1200, 0, 200}, mapRecordUsage(accountant.periodRecords)), true)
 
 	// Second call should use on-demand payment
 	header, err = accountant.AccountBlob(ctx, 300, quorums, salt)
@@ -125,7 +125,7 @@ func TestAccountBlob_OnDemand(t *testing.T) {
 	expectedPayment := big.NewInt(int64(numSymbols * pricePerSymbol))
 	assert.Equal(t, uint32(0), header.ReservationPeriod)
 	assert.Equal(t, expectedPayment, header.CumulativePayment)
-	assert.Equal(t, isRotation([]uint64{0, 0, 0}, mapRecordUsage(accountant.binRecords)), true)
+	assert.Equal(t, isRotation([]uint64{0, 0, 0}, mapRecordUsage(accountant.periodRecords)), true)
 	assert.Equal(t, expectedPayment, accountant.cumulativePayment)
 }
 
@@ -225,20 +225,20 @@ func TestAccountBlob_BinRotation(t *testing.T) {
 	// First call
 	_, err = accountant.AccountBlob(ctx, 800, quorums, salt)
 	assert.NoError(t, err)
-	assert.Equal(t, isRotation([]uint64{800, 0, 0}, mapRecordUsage(accountant.binRecords)), true)
+	assert.Equal(t, isRotation([]uint64{800, 0, 0}, mapRecordUsage(accountant.periodRecords)), true)
 
 	// next reservation duration
 	time.Sleep(1000 * time.Millisecond)
 
 	// Second call
 	_, err = accountant.AccountBlob(ctx, 300, quorums, salt)
 	assert.NoError(t, err)
-	assert.Equal(t, isRotation([]uint64{800, 300, 0}, mapRecordUsage(accountant.binRecords)), true)
+	assert.Equal(t, isRotation([]uint64{800, 300, 0}, mapRecordUsage(accountant.periodRecords)), true)
 
 	// Third call
 	_, err = accountant.AccountBlob(ctx, 500, quorums, salt)
 	assert.NoError(t, err)
-	assert.Equal(t, isRotation([]uint64{800, 800, 0}, mapRecordUsage(accountant.binRecords)), true)
+	assert.Equal(t, isRotation([]uint64{800, 800, 0}, mapRecordUsage(accountant.periodRecords)), true)
 }
 
 func TestConcurrentBinRotationAndAccountBlob(t *testing.T) {
@@ -279,7 +279,7 @@ func TestConcurrentBinRotationAndAccountBlob(t *testing.T) {
 	wg.Wait()
 
 	// Check final state
-	usages := mapRecordUsage(accountant.binRecords)
+	usages := mapRecordUsage(accountant.periodRecords)
 	assert.Equal(t, uint64(1000), usages[0]+usages[1]+usages[2])
 }
 
@@ -313,22 +313,22 @@ func TestAccountBlob_ReservationWithOneOverflow(t *testing.T) {
 	assert.Equal(t, salt, header.Salt)
 	assert.Equal(t, meterer.GetReservationPeriod(uint64(now), reservationWindow), header.ReservationPeriod)
 	assert.Equal(t, big.NewInt(0), header.CumulativePayment)
-	assert.Equal(t, isRotation([]uint64{800, 0, 0}, mapRecordUsage(accountant.binRecords)), true)
+	assert.Equal(t, isRotation([]uint64{800, 0, 0}, mapRecordUsage(accountant.periodRecords)), true)
 
 	// Second call: Allow one overflow
 	header, err = accountant.AccountBlob(ctx, 500, quorums, salt+1)
 	assert.NoError(t, err)
 	assert.Equal(t, salt+1, header.Salt)
 	assert.Equal(t, big.NewInt(0), header.CumulativePayment)
-	assert.Equal(t, isRotation([]uint64{1300, 0, 300}, mapRecordUsage(accountant.binRecords)), true)
+	assert.Equal(t, isRotation([]uint64{1300, 0, 300}, mapRecordUsage(accountant.periodRecords)), true)
 
 	// Third call: Should use on-demand payment
 	header, err = accountant.AccountBlob(ctx, 200, quorums, salt+2)
 	assert.NoError(t, err)
 	assert.Equal(t, salt+2, header.Salt)
 	assert.Equal(t, uint32(0), header.ReservationPeriod)
 	assert.Equal(t, big.NewInt(200), header.CumulativePayment)
-	assert.Equal(t, isRotation([]uint64{1300, 0, 300}, mapRecordUsage(accountant.binRecords)), true)
+	assert.Equal(t, isRotation([]uint64{1300, 0, 300}, mapRecordUsage(accountant.periodRecords)), true)
 }
 
 func TestAccountBlob_ReservationOverflowReset(t *testing.T) {
@@ -357,12 +357,12 @@ func TestAccountBlob_ReservationOverflowReset(t *testing.T) {
 	// full reservation
 	_, err = accountant.AccountBlob(ctx, 1000, quorums, salt)
 	assert.NoError(t, err)
-	assert.Equal(t, isRotation([]uint64{1000, 0, 0}, mapRecordUsage(accountant.binRecords)), true)
+	assert.Equal(t, isRotation([]uint64{1000, 0, 0}, mapRecordUsage(accountant.periodRecords)), true)
 
 	// no overflow
 	header, err := accountant.AccountBlob(ctx, 500, quorums, salt)
 	assert.NoError(t, err)
-	assert.Equal(t, isRotation([]uint64{1000, 0, 0}, mapRecordUsage(accountant.binRecords)), true)
+	assert.Equal(t, isRotation([]uint64{1000, 0, 0}, mapRecordUsage(accountant.periodRecords)), true)
 	assert.Equal(t, big.NewInt(500), header.CumulativePayment)
 
 	// Wait for next reservation duration
@@ -371,7 +371,7 @@ func TestAccountBlob_ReservationOverflowReset(t *testing.T) {
 	// Third call: Should use new bin and allow overflow again
 	_, err = accountant.AccountBlob(ctx, 500, quorums, salt)
 	assert.NoError(t, err)
-	assert.Equal(t, isRotation([]uint64{1000, 500, 0}, mapRecordUsage(accountant.binRecords)), true)
+	assert.Equal(t, isRotation([]uint64{1000, 500, 0}, mapRecordUsage(accountant.periodRecords)), true)
 }
 
 func TestQuorumCheck(t *testing.T) {
@@ -431,7 +431,7 @@ func TestQuorumCheck(t *testing.T) {
 	}
 }
 
-func mapRecordUsage(records []BinRecord) []uint64 {
+func mapRecordUsage(records []PeriodRecord) []uint64 {
 	return []uint64{records[0].Usage, records[1].Usage, records[2].Usage}
 }
 

api/docs/disperser_v2.html

@@ -183,7 +183,7 @@ <h2>Table of Contents</h2>
                 </li>
 
                 <li>
-                  <a href="#disperser.v2.BinRecord"><span class="badge">M</span>BinRecord</a>
+                  <a href="#disperser.v2.PeriodRecord"><span class="badge">M</span>PeriodRecord</a>
                 </li>
 
                 <li>
@@ -321,8 +321,8 @@ <h3 id="disperser.v2.Attestation">Attestation</h3>
 
 
 
-        <h3 id="disperser.v2.BinRecord">BinRecord</h3>
-        <p>BinRecord is the usage record of an account in a bin. The API should return the active bin </p><p>record and the subsequent two records that contains potential overflows.</p>
+        <h3 id="disperser.v2.PeriodRecord">PeriodRecord</h3>
+        <p>PeriodRecord is the usage record of an account in a bin. The API should return the active bin </p><p>record and the subsequent two records that contains potential overflows.</p>
 
 
           <table class="field-table">
@@ -586,7 +586,7 @@ <h3 id="disperser.v2.GetPaymentStateReply">GetPaymentStateReply</h3>
 
                 <tr>
                   <td>bin_records</td>
-                  <td><a href="#disperser.v2.BinRecord">BinRecord</a></td>
+                  <td><a href="#disperser.v2.PeriodRecord">PeriodRecord</a></td>
                   <td>repeated</td>
                   <td><p>off-chain account reservation usage records </p></td>
                 </tr>

api/docs/disperser_v2.md

@@ -5,7 +5,7 @@
 
 - [disperser/v2/disperser_v2.proto](#disperser_v2_disperser_v2-proto)
     - [Attestation](#disperser-v2-Attestation)
-    - [BinRecord](#disperser-v2-BinRecord)
+    - [PeriodRecord](#disperser-v2-PeriodRecord)
     - [BlobCommitmentReply](#disperser-v2-BlobCommitmentReply)
     - [BlobCommitmentRequest](#disperser-v2-BlobCommitmentRequest)
     - [BlobStatusReply](#disperser-v2-BlobStatusReply)
@@ -54,10 +54,10 @@
 
 
 
-<a name="disperser-v2-BinRecord"></a>
+<a name="disperser-v2-PeriodRecord"></a>
 
-### BinRecord
-BinRecord is the usage record of an account in a bin. The API should return the active bin 
+### PeriodRecord
+PeriodRecord is the usage record of an account in a bin. The API should return the active bin 
 record and the subsequent two records that contains potential overflows.
 
 
@@ -192,7 +192,7 @@ GetPaymentStateReply contains the payment state of an account.
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | payment_global_params | [PaymentGlobalParams](#disperser-v2-PaymentGlobalParams) |  | global payment vault parameters |
-| bin_records | [BinRecord](#disperser-v2-BinRecord) | repeated | off-chain account reservation usage records |
+| bin_records | [PeriodRecord](#disperser-v2-PeriodRecord) | repeated | off-chain account reservation usage records |
 | reservation | [Reservation](#disperser-v2-Reservation) |  | on-chain account reservation setting |
 | cumulative_payment | [bytes](#bytes) |  | off-chain on-demand payment usage |
 | onchain_cumulative_payment | [bytes](#bytes) |  | on-chain on-demand payment deposited |

api/docs/eigenda-protos.html

@@ -351,7 +351,7 @@ <h2>Table of Contents</h2>
                 </li>
 
                 <li>
-                  <a href="#disperser.v2.BinRecord"><span class="badge">M</span>BinRecord</a>
+                  <a href="#disperser.v2.PeriodRecord"><span class="badge">M</span>PeriodRecord</a>
                 </li>
 
                 <li>
@@ -2015,8 +2015,8 @@ <h3 id="disperser.v2.Attestation">Attestation</h3>
 
 
 
-        <h3 id="disperser.v2.BinRecord">BinRecord</h3>
-        <p>BinRecord is the usage record of an account in a bin. The API should return the active bin </p><p>record and the subsequent two records that contains potential overflows.</p>
+        <h3 id="disperser.v2.PeriodRecord">PeriodRecord</h3>
+        <p>PeriodRecord is the usage record of an account in a bin. The API should return the active bin </p><p>record and the subsequent two records that contains potential overflows.</p>
 
 
           <table class="field-table">
@@ -2280,7 +2280,7 @@ <h3 id="disperser.v2.GetPaymentStateReply">GetPaymentStateReply</h3>
 
                 <tr>
                   <td>bin_records</td>
-                  <td><a href="#disperser.v2.BinRecord">BinRecord</a></td>
+                  <td><a href="#disperser.v2.PeriodRecord">PeriodRecord</a></td>
                   <td>repeated</td>
                   <td><p>off-chain account reservation usage records </p></td>
                 </tr>

api/docs/eigenda-protos.md

@@ -47,7 +47,7 @@
 
 - [disperser/v2/disperser_v2.proto](#disperser_v2_disperser_v2-proto)
     - [Attestation](#disperser-v2-Attestation)
-    - [BinRecord](#disperser-v2-BinRecord)
+    - [PeriodRecord](#disperser-v2-PeriodRecord)
     - [BlobCommitmentReply](#disperser-v2-BlobCommitmentReply)
     - [BlobCommitmentRequest](#disperser-v2-BlobCommitmentRequest)
     - [BlobStatusReply](#disperser-v2-BlobStatusReply)
@@ -762,10 +762,10 @@ If DisperseBlob returns the following error codes: INVALID_ARGUMENT (400): reque
 
 
 
-<a name="disperser-v2-BinRecord"></a>
+<a name="disperser-v2-PeriodRecord"></a>
 
-### BinRecord
-BinRecord is the usage record of an account in a bin. The API should return the active bin 
+### PeriodRecord
+PeriodRecord is the usage record of an account in a bin. The API should return the active bin 
 record and the subsequent two records that contains potential overflows.
 
 
@@ -900,7 +900,7 @@ GetPaymentStateReply contains the payment state of an account.
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | payment_global_params | [PaymentGlobalParams](#disperser-v2-PaymentGlobalParams) |  | global payment vault parameters |
-| bin_records | [BinRecord](#disperser-v2-BinRecord) | repeated | off-chain account reservation usage records |
+| bin_records | [PeriodRecord](#disperser-v2-PeriodRecord) | repeated | off-chain account reservation usage records |
 | reservation | [Reservation](#disperser-v2-Reservation) |  | on-chain account reservation setting |
 | cumulative_payment | [bytes](#bytes) |  | off-chain on-demand payment usage |
 | onchain_cumulative_payment | [bytes](#bytes) |  | on-chain on-demand payment deposited |