feat: extend informations returned by GET /stamps

openapi/SwarmCommon.yaml

@@ -319,6 +319,14 @@ components:
           $ref: "#/components/schemas/BatchID"
         utilization:
           type: integer
+        label:
+          type: string
+        depth:
+          type: integer
+        amount:
+          $ref: "#/components/schemas/BigInt"
+        createdAt:
+          type: integer
 
     Settlement:
       type: object

pkg/api/api_test.go

@@ -11,6 +11,7 @@ import (
 	"errors"
 	"io"
 	"io/ioutil"
+	"math/big"
 	"net/http"
 	"net/http/httptest"
 	"net/url"
@@ -267,7 +268,7 @@ func TestPostageHeaderError(t *testing.T) {
 		mockStorer     = mock.NewStorer()
 		mockStatestore = statestore.NewStateStore()
 		logger         = logging.New(ioutil.Discard, 5)
-		mp             = mockpost.New(mockpost.WithIssuer(postage.NewStampIssuer("", "", batchOk, 11, 10)))
+		mp             = mockpost.New(mockpost.WithIssuer(postage.NewStampIssuer("", "", batchOk, big.NewInt(3), 11, 10)))
 		client, _, _   = newTestServer(t, testServerOptions{
 			Storer: mockStorer,
 			Tags:   tags.NewTags(mockStatestore, logger),

pkg/api/feed_test.go

@@ -12,6 +12,7 @@ import (
 	"errors"
 	"fmt"
 	"io/ioutil"
+	"math/big"
 	"net/http"
 	"testing"
 
@@ -154,7 +155,7 @@ func TestFeed_Post(t *testing.T) {
 		logger         = logging.New(ioutil.Discard, 0)
 		tag            = tags.NewTags(mockStatestore, logger)
 		topic          = "aabbcc"
-		mp             = mockpost.New(mockpost.WithIssuer(postage.NewStampIssuer("", "", batchOk, 11, 10)))
+		mp             = mockpost.New(mockpost.WithIssuer(postage.NewStampIssuer("", "", batchOk, big.NewInt(3), 11, 10)))
 		mockStorer     = mock.NewStorer()
 		client, _, _   = newTestServer(t, testServerOptions{
 			Storer: mockStorer,

pkg/api/postage.go

@@ -12,6 +12,7 @@ import (
 	"net/http"
 	"strconv"
 
+	"github.com/ethersphere/bee/pkg/bigint"
 	"github.com/ethersphere/bee/pkg/jsonhttp"
 	"github.com/ethersphere/bee/pkg/postage/postagecontract"
 	"github.com/ethersphere/bee/pkg/sctx"
@@ -97,20 +98,29 @@ func (s *server) postageCreateHandler(w http.ResponseWriter, r *http.Request) {
 }
 
 type postageStampResponse struct {
-	BatchID     batchID `json:"batchID"`
-	Utilization uint32  `json:"utilization"`
+	BatchID     batchID        `json:"batchID"`
+	Utilization uint32         `json:"utilization"`
+	Label       string         `json:"label"`
+	Depth       uint8          `json:"depth"`
+	Amount      *bigint.BigInt `json:"amount"`
+	CreatedAt   int64          `json:"createdAt"`
 }
 
 type postageStampsResponse struct {
 	Stamps []postageStampResponse `json:"stamps"`
 }
 
 func (s *server) postageGetStampsHandler(w http.ResponseWriter, r *http.Request) {
-	issuers := s.post.StampIssuers()
 	resp := postageStampsResponse{}
-	for _, v := range issuers {
-		issuer := postageStampResponse{BatchID: v.ID(), Utilization: v.Utilization()}
-		resp.Stamps = append(resp.Stamps, issuer)
+	for _, v := range s.post.StampIssuers() {
+		resp.Stamps = append(resp.Stamps, postageStampResponse{
+			BatchID:     v.ID(),
+			Utilization: v.Utilization(),
+			Label:       v.Label(),
+			Depth:       v.Depth(),
+			Amount:      bigint.Wrap(v.Amount()),
+			CreatedAt:   v.CreatedAt(),
+		})
 	}
 	jsonhttp.OK(w, resp)
 }
@@ -140,6 +150,10 @@ func (s *server) postageGetStampHandler(w http.ResponseWriter, r *http.Request)
 	resp := postageStampResponse{
 		BatchID:     id,
 		Utilization: issuer.Utilization(),
+		Label:       issuer.Label(),
+		Depth:       issuer.Depth(),
+		Amount:      bigint.Wrap(issuer.Amount()),
+		CreatedAt:   issuer.CreatedAt(),
 	}
 	jsonhttp.OK(w, &resp)
 }

pkg/api/postage_test.go

@@ -14,6 +14,7 @@ import (
 	"testing"
 
 	"github.com/ethersphere/bee/pkg/api"
+	"github.com/ethersphere/bee/pkg/bigint"
 	"github.com/ethersphere/bee/pkg/jsonhttp"
 	"github.com/ethersphere/bee/pkg/jsonhttp/jsonhttptest"
 	"github.com/ethersphere/bee/pkg/postage"
@@ -192,30 +193,40 @@ func TestPostageCreateStamp(t *testing.T) {
 }
 
 func TestPostageGetStamps(t *testing.T) {
-	mp := mockpost.New(mockpost.WithIssuer(postage.NewStampIssuer("", "", batchOk, 11, 10)))
+	si := postage.NewStampIssuer("", "", batchOk, big.NewInt(3), 11, 10)
+	mp := mockpost.New(mockpost.WithIssuer(si))
 	client, _, _ := newTestServer(t, testServerOptions{Post: mp})
 
 	jsonhttptest.Request(t, client, http.MethodGet, "/stamps", http.StatusOK,
 		jsonhttptest.WithExpectedJSONResponse(&api.PostageStampsResponse{
 			Stamps: []api.PostageStampResponse{
 				{
 					BatchID:     batchOk,
-					Utilization: 0,
+					Utilization: si.Utilization(),
+					Label:       si.Label(),
+					Depth:       si.Depth(),
+					Amount:      bigint.Wrap(si.Amount()),
+					CreatedAt:   si.CreatedAt(),
 				},
 			},
 		}),
 	)
 }
 
 func TestPostageGetStamp(t *testing.T) {
-	mp := mockpost.New(mockpost.WithIssuer(postage.NewStampIssuer("", "", batchOk, 11, 10)))
+	si := postage.NewStampIssuer("", "", batchOk, big.NewInt(3), 11, 10)
+	mp := mockpost.New(mockpost.WithIssuer(si))
 	client, _, _ := newTestServer(t, testServerOptions{Post: mp})
 
 	t.Run("ok", func(t *testing.T) {
 		jsonhttptest.Request(t, client, http.MethodGet, "/stamps/"+batchOkStr, http.StatusOK,
 			jsonhttptest.WithExpectedJSONResponse(&api.PostageStampResponse{
 				BatchID:     batchOk,
-				Utilization: 0,
+				Utilization: si.Utilization(),
+				Label:       si.Label(),
+				Depth:       si.Depth(),
+				Amount:      bigint.Wrap(si.Amount()),
+				CreatedAt:   si.CreatedAt(),
 			}),
 		)
 	})

pkg/api/pss_test.go

@@ -11,6 +11,7 @@ import (
 	"encoding/hex"
 	"fmt"
 	"io/ioutil"
+	"math/big"
 	"net/http"
 	"net/url"
 	"sync"
@@ -185,7 +186,7 @@ func TestPssSend(t *testing.T) {
 			mtx.Unlock()
 			return err
 		}
-		mp           = mockpost.New(mockpost.WithIssuer(postage.NewStampIssuer("", "", batchOk, 11, 10)))
+		mp           = mockpost.New(mockpost.WithIssuer(postage.NewStampIssuer("", "", batchOk, big.NewInt(3), 11, 10)))
 		p            = newMockPss(sendFn)
 		client, _, _ = newTestServer(t, testServerOptions{
 			Pss:    p,

pkg/api/soc_test.go

@@ -9,6 +9,7 @@ import (
 	"encoding/hex"
 	"fmt"
 	"io/ioutil"
+	"math/big"
 	"net/http"
 	"testing"
 
@@ -32,7 +33,7 @@ func TestSOC(t *testing.T) {
 		mockStatestore = statestore.NewStateStore()
 		logger         = logging.New(ioutil.Discard, 0)
 		tag            = tags.NewTags(mockStatestore, logger)
-		mp             = mockpost.New(mockpost.WithIssuer(postage.NewStampIssuer("", "", batchOk, 11, 10)))
+		mp             = mockpost.New(mockpost.WithIssuer(postage.NewStampIssuer("", "", batchOk, big.NewInt(3), 11, 10)))
 		mockStorer     = mock.NewStorer()
 		client, _, _   = newTestServer(t, testServerOptions{
 			Storer: mockStorer,

pkg/postage/batch.go

@@ -23,7 +23,7 @@ type Batch struct {
 
 // MarshalBinary implements BinaryMarshaller. It will attempt to serialize the
 // postage batch to a byte slice.
-// serialised as ID(32)|big endian value(32)|start block(8)|owner addr(20)|bucketDepth(1)|depth(1)|immutable(1)
+// serialised as ID(32)|big endian value(32)|start block(8)|owner addr(20)|BucketDepth(1)|depth(1)|immutable(1)
 func (b *Batch) MarshalBinary() ([]byte, error) {
 	out := make([]byte, 95)
 	copy(out, b.ID)

pkg/postage/mock/service.go

@@ -6,6 +6,7 @@ package mock
 
 import (
 	"errors"
+	"math/big"
 
 	"github.com/ethersphere/bee/pkg/postage"
 )
@@ -54,7 +55,7 @@ func (m *mockPostage) StampIssuers() []*postage.StampIssuer {
 
 func (m *mockPostage) GetStampIssuer(id []byte) (*postage.StampIssuer, error) {
 	if m.acceptAll {
-		return postage.NewStampIssuer("test fallback", "test identity", id, 24, 6), nil
+		return postage.NewStampIssuer("test fallback", "test identity", id, big.NewInt(3), 24, 6), nil
 	}
 
 	if m.i != nil {

pkg/postage/postagecontract/contract.go

@@ -190,6 +190,7 @@ func (c *postageContract) CreateBatch(ctx context.Context, initialBalance *big.I
 				label,
 				c.owner.Hex(),
 				batchID,
+				initialBalance,
 				depth,
 				createdEvent.BucketDepth,
 			))

pkg/postage/service.go

@@ -84,7 +84,7 @@ func (ps *service) GetStampIssuer(batchID []byte) (*StampIssuer, error) {
 	ps.lock.Lock()
 	defer ps.lock.Unlock()
 	for _, st := range ps.issuers {
-		if bytes.Equal(batchID, st.batchID) {
+		if bytes.Equal(batchID, st.BatchID) {
 			return st, nil
 		}
 	}

pkg/postage/service_test.go

@@ -7,6 +7,7 @@ package postage_test
 import (
 	crand "crypto/rand"
 	"io"
+	"math/big"
 	"reflect"
 	"testing"
 
@@ -66,7 +67,7 @@ func TestGetStampIssuer(t *testing.T) {
 		if i == 0 {
 			continue
 		}
-		ps.Add(postage.NewStampIssuer(string(id), "", id, 16, 8))
+		ps.Add(postage.NewStampIssuer(string(id), "", id, big.NewInt(3), 16, 8))
 	}
 	t.Run("found", func(t *testing.T) {
 		for _, id := range ids[1:] {

pkg/postage/stamp_test.go

@@ -6,6 +6,7 @@ package postage_test
 
 import (
 	"bytes"
+	"math/big"
 	"testing"
 
 	"github.com/ethersphere/bee/pkg/crypto"
@@ -74,7 +75,7 @@ func TestValidStamp(t *testing.T) {
 	b := postagetesting.MustNewBatch(postagetesting.WithOwner(owner))
 	bs := mock.New(mock.WithBatch(b))
 	signer := crypto.NewDefaultSigner(privKey)
-	issuer := postage.NewStampIssuer("label", "keyID", b.ID, b.Depth, b.BucketDepth)
+	issuer := postage.NewStampIssuer("label", "keyID", b.ID, big.NewInt(3), b.Depth, b.BucketDepth)
 	stamper := postage.NewStamper(issuer, signer)
 
 	// this creates a chunk with a mocked stamp. ValidStamp will override this

pkg/postage/stamper.go

@@ -43,15 +43,15 @@ func (st *stamper) Stamp(addr swarm.Address) (*Stamp, error) {
 		return nil, err
 	}
 	ts := timestamp()
-	toSign, err := toSignDigest(addr.Bytes(), st.issuer.batchID, index, ts)
+	toSign, err := toSignDigest(addr.Bytes(), st.issuer.BatchID, index, ts)
 	if err != nil {
 		return nil, err
 	}
 	sig, err := st.signer.Sign(toSign)
 	if err != nil {
 		return nil, err
 	}
-	return NewStamp(st.issuer.batchID, index, ts, sig), nil
+	return NewStamp(st.issuer.BatchID, index, ts, sig), nil
 }
 
 func timestamp() []byte {

pkg/postage/stamper_test.go

@@ -8,6 +8,7 @@ import (
 	crand "crypto/rand"
 	"errors"
 	"io"
+	"math/big"
 	"testing"
 
 	"github.com/ethersphere/bee/pkg/crypto"
@@ -91,7 +92,7 @@ func TestStamperStamping(t *testing.T) {
 	// issuer has the corresponding collision bucket filled]
 	t.Run("bucket full", func(t *testing.T) {
 		st := newTestStampIssuer(t)
-		st = postage.NewStampIssuer("", "", st.ID(), 12, 8)
+		st = postage.NewStampIssuer("", "", st.ID(), big.NewInt(3), 12, 8)
 		stamper := postage.NewStamper(st, signer)
 		// issue 1 stamp
 		chunkAddr, _ := createStamp(t, stamper)