Extend fungible integration test with issuer balance APIs

Add IssuedBalanceView, RedeemedBalanceView, and OutstandingBalanceView
with corresponding view factories, support helpers (CheckIssuedBalance,
CheckRedeemedBalance, CheckOutstandingBalance), and two assertion blocks
in TestAll that exercise the new APIs after issue+redeem cycles.

Signed-off-by: Soumya Mohapatra <soumyaranjanmohapatra8@gmail.com>
Signed-off-by: Soumya Mohapatra <mohapatras@microsoft.com>

Author: Soumya Mohapatra

integration/token/fungible/sdk/issuer/sdk.go

@@ -39,6 +39,9 @@ func (p *SDK) Install() error {
 			registry.RegisterFactory("balance", &views.BalanceViewFactory{}),
 			registry.RegisterFactory("historyIssuedToken", &views.ListIssuedTokensViewFactory{}),
 			registry.RegisterFactory("issuedTokenQuery", &views.ListIssuedTokensViewFactory{}),
+			registry.RegisterFactory("issuedBalance", &views.IssuedBalanceViewFactory{}),
+			registry.RegisterFactory("redeemedBalance", &views.RedeemedBalanceViewFactory{}),
+			registry.RegisterFactory("outstandingBalance", &views.OutstandingBalanceViewFactory{}),
 			registry.RegisterFactory("GetEnrollmentID", &views.GetEnrollmentIDViewFactory{}),
 			registry.RegisterFactory("acceptedTransactionHistory", &views.ListAcceptedTransactionsViewFactory{}),
 			registry.RegisterFactory("transactionInfo", &views.TransactionInfoViewFactory{}),

integration/token/fungible/support.go

@@ -390,6 +390,36 @@ func ListUnspentTokens(network *integration.Infrastructure, id *token3.NodeRefer
 	return ListUnspentTokensForTMSID(network, id, wallet, typ, nil)
 }
 
+func CheckIssuedBalance(network *integration.Infrastructure, issuer *token3.NodeReference, wallet string, typ token.Type, expected uint64) {
+	res, err := network.Client(issuer.ReplicaName()).CallView("issuedBalance", common.JSONMarshall(&views.IssuerBalanceQuery{
+		Wallet:    wallet,
+		TokenType: typ,
+	}))
+	gomega.Expect(err).NotTo(gomega.HaveOccurred())
+	balance := res.(uint64)
+	gomega.Expect(balance).To(gomega.Equal(expected), "issued balance: got %d, expected %d", balance, expected)
+}
+
+func CheckRedeemedBalance(network *integration.Infrastructure, issuer *token3.NodeReference, wallet string, typ token.Type, expected uint64) {
+	res, err := network.Client(issuer.ReplicaName()).CallView("redeemedBalance", common.JSONMarshall(&views.IssuerBalanceQuery{
+		Wallet:    wallet,
+		TokenType: typ,
+	}))
+	gomega.Expect(err).NotTo(gomega.HaveOccurred())
+	balance := res.(uint64)
+	gomega.Expect(balance).To(gomega.Equal(expected), "redeemed balance: got %d, expected %d", balance, expected)
+}
+
+func CheckOutstandingBalance(network *integration.Infrastructure, issuer *token3.NodeReference, wallet string, typ token.Type, expected uint64) {
+	res, err := network.Client(issuer.ReplicaName()).CallView("outstandingBalance", common.JSONMarshall(&views.IssuerBalanceQuery{
+		Wallet:    wallet,
+		TokenType: typ,
+	}))
+	gomega.Expect(err).NotTo(gomega.HaveOccurred())
+	balance := res.(uint64)
+	gomega.Expect(balance).To(gomega.Equal(expected), "outstanding balance: got %d, expected %d", balance, expected)
+}
+
 func ListUnspentTokensForTMSID(network *integration.Infrastructure, id *token3.NodeReference, wallet string, typ token.Type, tmsId *token2.TMSID) *token.UnspentTokens {
 	res, err := network.Client(id.ReplicaName()).CallView("history", common.JSONMarshall(&views.ListUnspentTokens{
 		Wallet:    wallet,

integration/token/fungible/tests.go

@@ -441,6 +441,12 @@ func TestAll(network *integration.Infrastructure, auditorId string, onRestart On
 	CheckAuditedTransactions(network, auditor, AuditedTransactions[:10], &t0, &t12)
 	CheckSpending(network, bob, "", "USD", auditor, 11)
 
+	// Verify issuer balance APIs after issue + redeem cycle.
+	// Default issuer wallet issued 110 + 10 (withdraw) + 10 (post-redeem) = 130 USD; redeemed 11 USD.
+	CheckIssuedBalance(network, issuer, "", "USD", 130)
+	CheckRedeemedBalance(network, issuer, "", "USD", 11)
+	CheckOutstandingBalance(network, issuer, "", "USD", 119)
+
 	// test multi action transfer...
 	t13 := time.Now()
 	IssueCash(network, "", "LIRA", 3, alice, auditor, true, issuer)
@@ -502,6 +508,16 @@ func TestAll(network *integration.Infrastructure, auditorId string, onRestart On
 	gomega.Expect(h.Sum(64).ToBigInt().Cmp(big.NewInt(180))).To(gomega.BeEquivalentTo(0))
 	gomega.Expect(h.ByType("EUR").Count()).To(gomega.BeEquivalentTo(h.Count()))
 
+	// Verify issuer balances after all issue and redeem operations.
+	// Default issuer: 241 USD issued, 21 redeemed (11 + 10).
+	CheckIssuedBalance(network, issuer, "", "USD", 241)
+	CheckRedeemedBalance(network, issuer, "", "USD", 21)
+	CheckOutstandingBalance(network, issuer, "", "USD", 220)
+	// New issuer wallet: 180 EUR issued, 0 redeemed.
+	CheckIssuedBalance(network, issuer, "newIssuerWallet", "EUR", 180)
+	CheckRedeemedBalance(network, issuer, "newIssuerWallet", "EUR", 0)
+	CheckOutstandingBalance(network, issuer, "newIssuerWallet", "EUR", 180)
+
 	CheckBalanceAndHolding(network, issuer, "", "USD", 110, auditor)
 	CheckBalanceAndHolding(network, issuer, "", "EUR", 150, auditor)
 	CheckBalanceAndHolding(network, issuer, "issuer.owner", "EUR", 10, auditor)

integration/token/fungible/views/history.go

@@ -181,3 +181,85 @@ func (p *TransactionInfoViewFactory) NewView(in []byte) (view.View, error) {
 
 	return f, nil
 }
+
+// IssuerBalanceQuery contains the input parameters for issuer balance views.
+type IssuerBalanceQuery struct {
+	Wallet    string
+	TokenType token2.Type
+	TMSID     *token.TMSID
+}
+
+// IssuedBalanceView returns the total amount of non-redeemed tokens issued by the given wallet.
+type IssuedBalanceView struct {
+	*IssuerBalanceQuery
+}
+
+func (p *IssuedBalanceView) Call(context view.Context) (interface{}, error) {
+	wallet := ttx.GetIssuerWallet(context, p.Wallet, ServiceOpts(p.TMSID)...)
+	if wallet == nil {
+		return nil, errors.Errorf("wallet [%s] not found", p.Wallet)
+	}
+
+	return wallet.IssuedBalance(context.Context(), token.WithBalanceType(p.TokenType))
+}
+
+type IssuedBalanceViewFactory struct{}
+
+func (f *IssuedBalanceViewFactory) NewView(in []byte) (view.View, error) {
+	v := &IssuedBalanceView{IssuerBalanceQuery: &IssuerBalanceQuery{}}
+	if err := json.Unmarshal(in, v.IssuerBalanceQuery); err != nil {
+		return nil, errors.Wrapf(err, "failed unmarshalling input")
+	}
+
+	return v, nil
+}
+
+// RedeemedBalanceView returns the total amount of redeemed tokens originally issued by the given wallet.
+type RedeemedBalanceView struct {
+	*IssuerBalanceQuery
+}
+
+func (p *RedeemedBalanceView) Call(context view.Context) (interface{}, error) {
+	wallet := ttx.GetIssuerWallet(context, p.Wallet, ServiceOpts(p.TMSID)...)
+	if wallet == nil {
+		return nil, errors.Errorf("wallet [%s] not found", p.Wallet)
+	}
+
+	return wallet.RedeemedBalance(context.Context(), token.WithBalanceType(p.TokenType))
+}
+
+type RedeemedBalanceViewFactory struct{}
+
+func (f *RedeemedBalanceViewFactory) NewView(in []byte) (view.View, error) {
+	v := &RedeemedBalanceView{IssuerBalanceQuery: &IssuerBalanceQuery{}}
+	if err := json.Unmarshal(in, v.IssuerBalanceQuery); err != nil {
+		return nil, errors.Wrapf(err, "failed unmarshalling input")
+	}
+
+	return v, nil
+}
+
+// OutstandingBalanceView returns IssuedBalance − RedeemedBalance for the given wallet.
+type OutstandingBalanceView struct {
+	*IssuerBalanceQuery
+}
+
+func (p *OutstandingBalanceView) Call(context view.Context) (interface{}, error) {
+	wallet := ttx.GetIssuerWallet(context, p.Wallet, ServiceOpts(p.TMSID)...)
+	if wallet == nil {
+		return nil, errors.Errorf("wallet [%s] not found", p.Wallet)
+	}
+
+	return wallet.OutstandingBalance(context.Context(), token.WithBalanceType(p.TokenType))
+}
+
+type OutstandingBalanceViewFactory struct{}
+
+func (f *OutstandingBalanceViewFactory) NewView(in []byte) (view.View, error) {
+	v := &OutstandingBalanceView{IssuerBalanceQuery: &IssuerBalanceQuery{}}
+	if err := json.Unmarshal(in, v.IssuerBalanceQuery); err != nil {
+		return nil, errors.Wrapf(err, "failed unmarshalling input")
+	}
+
+	return v, nil
+}