Update README.md

add: (feat) erc20 total supply

.deepsource.toml

@@ -0,0 +1,8 @@
+version = 1
+
+[[analyzers]]
+name = "go"
+enabled = true
+
+  [analyzers.meta]
+  import_root = "github.com/grassrootseconomics/cic-go"

README.md

@@ -1,3 +1,5 @@
+> DEPRECATED: Use https://github.com/grassrootseconomics/cic-go-sdk
+
 [![Go Reference](https://pkg.go.dev/badge/github.com/grassrootseconomics/cic_go.svg)](https://pkg.go.dev/github.com/grassrootseconomics/cic_go)
 [![Go](https://github.com/grassrootseconomics/cic_go/actions/workflows/go.yml/badge.svg)](https://github.com/grassrootseconomics/cic_go/actions/workflows/go.yml)
 [![Coverage Status](https://coveralls.io/repos/github/grassrootseconomics/cic_go/badge.svg?branch=sohail/cic_net_updates)](https://coveralls.io/github/grassrootseconomics/cic_go?branch=sohail/cic_net_updates)
@@ -22,4 +24,4 @@ import (
     cic_meta "github.com/grassrootseconomics/cic-go/meta"
     cic_net  "github.com/grassrootseconomics/cic-go/net"
 ) 
-```
+```

batch_balance/batch_balance.go

@@ -10,9 +10,9 @@ type BatchBalance struct {
 	batchContract common.Address
 }
 
-func NewBatchBalance(rpcProvider provider.Provider, batchContract common.Address) (*BatchBalance, error) {
+func NewBatchBalance(rpcProvider *provider.Provider, batchContract common.Address) (*BatchBalance, error) {
 	return &BatchBalance{
-		provider:      &rpcProvider,
+		provider:      rpcProvider,
 		batchContract: batchContract,
 	}, nil
 }

batch_balance/batch_balance_test.go

@@ -27,7 +27,7 @@ func TestBatchBalance_Connect(t *testing.T) {
 		t.Errorf("Creating an rpc instance failed = %v", err)
 	}
 
-	batchBalance, _ := NewBatchBalance(*newProvider, w3.A(conf.batchContract))
+	batchBalance, _ := NewBatchBalance(newProvider, w3.A(conf.batchContract))
 
 	t.Run(name, func(t *testing.T) {
 		if err := batchBalance.provider.EthClient.Close(); (err != nil) != wantErr {

batch_balance/token_balances_test.go

@@ -40,7 +40,7 @@ func TestBatchBalance_TokensBalance(t *testing.T) {
 	if err != nil {
 		t.Errorf("Creating an rpc instance failed = %v", err)
 	}
-	batchBalance, err := NewBatchBalance(*newProvider, w3.A(conf.batchContract))
+	batchBalance, err := NewBatchBalance(newProvider, w3.A(conf.batchContract))
 
 	if err != nil {
 		t.Fatalf("NewBatchBalance error = %v", err)

net/cic_net.go

@@ -10,9 +10,9 @@ type CicNet struct {
 	tokenIndex common.Address
 }
 
-func NewCicNet(rpcProvider provider.Provider, tokenIndex common.Address) (*CicNet, error) {
+func NewCicNet(rpcProvider *provider.Provider, tokenIndex common.Address) (*CicNet, error) {
 	return &CicNet{
-		provider:   &rpcProvider,
+		provider:   rpcProvider,
 		tokenIndex: tokenIndex,
 	}, nil
 }

net/cic_net_test.go

@@ -29,7 +29,7 @@ func TestCicNet_Connect(t *testing.T) {
 		t.Errorf("Creating an rpc instance failed = %v", err)
 	}
 
-	cicnet, _ := NewCicNet(*newProvider, w3.A(conf.tokenIndex))
+	cicnet, _ := NewCicNet(newProvider, w3.A(conf.tokenIndex))
 
 	t.Run(name, func(t *testing.T) {
 		if err := cicnet.provider.EthClient.Close(); (err != nil) != wantErr {

net/erc20_demurrage_token_test.go

@@ -50,7 +50,7 @@ func TestCicNet_DemurrageToken_DemurrageTokeInfo(t *testing.T) {
 	if err != nil {
 		t.Errorf("Creating an rpc instance failed = %v", err)
 	}
-	cicnet, err := NewCicNet(*newProvider, w3.A(conf.tokenIndex))
+	cicnet, err := NewCicNet(newProvider, w3.A(conf.tokenIndex))
 
 	if err != nil {
 		t.Fatalf("NewCicNet error = %v", err)
@@ -119,7 +119,7 @@ func TestCicNet_DemurrageToken_BaseBalanceOf(t *testing.T) {
 	if err != nil {
 		t.Errorf("Creating an rpc instance failed = %v", err)
 	}
-	cicnet, err := NewCicNet(*newProvider, w3.A(conf.tokenIndex))
+	cicnet, err := NewCicNet(newProvider, w3.A(conf.tokenIndex))
 
 	for _, testcase := range tests {
 		tt := testcase
@@ -161,7 +161,7 @@ func TestCicNet_DemurrageToken_ChangePeriod(t *testing.T) {
 	if err != nil {
 		t.Errorf("Creating an rpc instance failed = %v", err)
 	}
-	cicnet, err := NewCicNet(*newProvider, w3.A(conf.tokenIndex))
+	cicnet, err := NewCicNet(newProvider, w3.A(conf.tokenIndex))
 
 	nonce, err := cicnet.LastNonce(context.Background(), fromAddress)
 	if err != nil {
@@ -226,7 +226,7 @@ func TestCicNet_DemurrageToken_ApplyDemurrageLimited(t *testing.T) {
 	if err != nil {
 		t.Errorf("Creating an rpc instance failed = %v", err)
 	}
-	cicnet, err := NewCicNet(*newProvider, w3.A(conf.tokenIndex))
+	cicnet, err := NewCicNet(newProvider, w3.A(conf.tokenIndex))
 
 	nonce, err := cicnet.LastNonce(context.Background(), fromAddress)
 	if err != nil {

net/erc20_token.go

@@ -10,9 +10,10 @@ import (
 )
 
 type ERC20Token struct {
-	Name     string
+	Name        string
-	Symbol   string
+	Symbol      string
-	Decimals big.Int
+	Decimals    big.Int
+	TotalSupply big.Int
 }
 
 func (c *CicNet) ERC20TokenInfo(ctx context.Context, tokenAddress common.Address) (ERC20Token, error) {
@@ -20,6 +21,7 @@ func (c *CicNet) ERC20TokenInfo(ctx context.Context, tokenAddress common.Address
 		tokenName     string
 		tokenSymbol   string
 		tokenDecimals big.Int
+		totalSupply   big.Int
 	)
 
 	err := c.provider.EthClient.CallCtx(
@@ -27,15 +29,17 @@ func (c *CicNet) ERC20TokenInfo(ctx context.Context, tokenAddress common.Address
 		eth.CallFunc(w3.MustNewFunc("name()", "string"), tokenAddress).Returns(&tokenName),
 		eth.CallFunc(w3.MustNewFunc("symbol()", "string"), tokenAddress).Returns(&tokenSymbol),
 		eth.CallFunc(w3.MustNewFunc("decimals()", "uint256"), tokenAddress).Returns(&tokenDecimals),
+		eth.CallFunc(w3.MustNewFunc("totalSupply()", "uint256"), tokenAddress).Returns(&totalSupply),
 	)
 	if err != nil {
 		return ERC20Token{}, err
 	}
 
 	return ERC20Token{
-		Name:     tokenName,
+		Name:        tokenName,
-		Symbol:   tokenSymbol,
+		Symbol:      tokenSymbol,
-		Decimals: tokenDecimals,
+		Decimals:    tokenDecimals,
+		TotalSupply: totalSupply,
 	}, nil
 }
 func (c *CicNet) BalanceOf(ctx context.Context, tokenAddress common.Address, accountAddress common.Address) (big.Int, error) {

net/erc20_token_test.go

@@ -43,7 +43,7 @@ func TestCicNet_ERC20Token_ERC20TokenInfo(t *testing.T) {
 	if err != nil {
 		t.Errorf("Creating an rpc instance failed = %v", err)
 	}
-	cicnet, err := NewCicNet(*newProvider, w3.A(conf.tokenIndex))
+	cicnet, err := NewCicNet(newProvider, w3.A(conf.tokenIndex))
 
 	if err != nil {
 		t.Fatalf("NewCicNet error = %v", err)
@@ -102,7 +102,7 @@ func TestCicNet_ERC20Token_BalanceOf(t *testing.T) {
 	if err != nil {
 		t.Errorf("Creating an rpc instance failed = %v", err)
 	}
-	cicnet, err := NewCicNet(*newProvider, w3.A(conf.tokenIndex))
+	cicnet, err := NewCicNet(newProvider, w3.A(conf.tokenIndex))
 
 	for _, testcase := range tests {
 		tt := testcase

net/token_index_test.go

@@ -17,7 +17,7 @@ func TestCicNet_TokenIndex_EntryCount(t *testing.T) {
 	if err != nil {
 		t.Errorf("Creating an rpc instance failed = %v", err)
 	}
-	cicnet, err := NewCicNet(*newProvider, w3.A(conf.tokenIndex))
+	cicnet, err := NewCicNet(newProvider, w3.A(conf.tokenIndex))
 
 	if err != nil {
 		t.Fatalf("NewCicNet error = %v", err)
@@ -69,7 +69,7 @@ func TestCicNet_TokenIndex_AddressAtIndex(t *testing.T) {
 	if err != nil {
 		t.Errorf("Creating an rpc instance failed = %v", err)
 	}
-	cicnet, err := NewCicNet(*newProvider, w3.A(conf.tokenIndex))
+	cicnet, err := NewCicNet(newProvider, w3.A(conf.tokenIndex))
 
 	if err != nil {
 		t.Fatalf("NewCicNet error = %v", err)