feat(cosmosutil): add InteractingWallet and a scaffold of the ChainCl…

…ient (#18)  ## Summary by CodeRabbit - **New Features** - Introduced new utilities for bank transactions and balance queries within the Cosmos ecosystem. - Updated interfaces to support gRPC and Tendermint client retrieval and transaction configuration. - **Refactor** - Enhanced the wait utility to support context passing for improved operation control. - **Chores** - Updated linting workflow to include the "cosmosutil" module.
skip-mev · Dec 29, 2023 · 1482e4d · 1482e4d
2 parents c8037d6 + cf7e20e
commit 1482e4d
Show file tree

Hide file tree

Showing 8 changed files with 1,904 additions and 4 deletions.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -15,7 +15,7 @@ jobs:
   golangci:
     strategy:
       matrix:
-        module: ["chain", "node", "types", "util", "wallet"]
+        module: ["chain", "cosmosutil", "node", "types", "util", "wallet"]
     name: golangci-lint
     runs-on: ubuntu-latest
     steps:
@@ -30,4 +30,4 @@ jobs:
           version: latest
           only-new-issues: true
           args: --timeout=5m
-          working-directory: ${{ matrix.module }}
+          working-directory: ${{ matrix.module }}
diff --git a/cosmosutil/bank.go b/cosmosutil/bank.go
@@ -0,0 +1,179 @@
+package cosmosutil
+
+import (
+	"context"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/cosmos/cosmos-sdk/types/query"
+	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
+)
+
+// bank queries
+
+func (c *ChainClient) Balances(ctx context.Context, address string) (sdk.Coins, error) {
+	bankClient, err := c.getBankClient()
+
+	if err != nil {
+		return nil, err
+	}
+
+	var nextToken []byte
+	var balances sdk.Coins
+
+	for {
+		res, err := bankClient.AllBalances(ctx, &banktypes.QueryAllBalancesRequest{
+			Address: address,
+			Pagination: &query.PageRequest{
+				Key: nextToken,
+			},
+		})
+
+		if err != nil {
+			return nil, err
+		}
+
+		balances = append(balances, res.Balances...)
+
+		nextToken = res.Pagination.GetNextKey()
+
+		if nextToken == nil {
+			break
+		}
+	}
+
+	if err != nil {
+		return nil, err
+	}
+
+	return balances, nil
+}
+
+func (c *ChainClient) Balance(ctx context.Context, address, denom string) (sdk.Coin, error) {
+	bankClient, err := c.getBankClient()
+
+	if err != nil {
+		return sdk.Coin{}, err
+	}
+
+	res, err := bankClient.Balance(ctx, &banktypes.QueryBalanceRequest{
+		Address: address,
+		Denom:   denom,
+	})
+
+	if err != nil {
+		return sdk.Coin{}, err
+	}
+
+	if res.Balance == nil {
+		return sdk.Coin{}, nil
+	}
+
+	return *res.Balance, nil
+}
+
+func (c *ChainClient) DenomMetadata(ctx context.Context, denom string) (banktypes.Metadata, error) {
+	bankClient, err := c.getBankClient()
+
+	if err != nil {
+		return banktypes.Metadata{}, err
+	}
+
+	res, err := bankClient.DenomMetadata(ctx, &banktypes.QueryDenomMetadataRequest{
+		Denom: denom,
+	})
+
+	if err != nil {
+		return banktypes.Metadata{}, err
+	}
+
+	return res.Metadata, nil
+}
+
+func (c *ChainClient) DenomsMetadata(ctx context.Context) ([]banktypes.Metadata, error) {
+	bankClient, err := c.getBankClient()
+
+	if err != nil {
+		return nil, err
+	}
+
+	var nextToken []byte
+	var metadatas []banktypes.Metadata
+
+	for {
+		res, err := bankClient.DenomsMetadata(ctx, &banktypes.QueryDenomsMetadataRequest{})
+
+		if err != nil {
+			return nil, err
+		}
+
+		metadatas = append(metadatas, res.Metadatas...)
+
+		nextToken = res.Pagination.GetNextKey()
+
+		if nextToken == nil {
+			break
+		}
+	}
+
+	return metadatas, nil
+}
+
+func (c *ChainClient) TotalSupplyAll(ctx context.Context) (sdk.Coins, error) {
+	bankClient, err := c.getBankClient()
+
+	if err != nil {
+		return nil, err
+	}
+
+	var nextToken []byte
+	var supplies sdk.Coins
+
+	for {
+		res, err := bankClient.TotalSupply(ctx, &banktypes.QueryTotalSupplyRequest{})
+
+		if err != nil {
+			return nil, err
+		}
+
+		supplies = append(supplies, res.Supply...)
+
+		nextToken = res.Pagination.GetNextKey()
+
+		if nextToken == nil {
+			break
+		}
+	}
+
+	return supplies, nil
+}
+
+func (c *ChainClient) BankTotalSupplySingle(ctx context.Context, denom string) (sdk.Coin, error) {
+	bankClient, err := c.getBankClient()
+
+	if err != nil {
+		return sdk.Coin{}, err
+	}
+
+	res, err := bankClient.SupplyOf(ctx, &banktypes.QuerySupplyOfRequest{
+		Denom: denom,
+	})
+
+	if err != nil {
+		return sdk.Coin{}, err
+	}
+
+	return res.Amount, nil
+}
+
+// bank transactions
+
+func (c *ChainClient) BankSend(ctx context.Context, user InteractingWallet, toAddress string, amount sdk.Coins, blocking bool) (*sdk.TxResponse, error) {
+	msg := banktypes.NewMsgSend(sdk.AccAddress(user.wallet.FormattedAddress()), sdk.AccAddress(toAddress), amount)
+
+	txResp, err := user.CreateAndBroadcastTx(ctx, true, 0, sdk.Coins{}, msg)
+
+	if err != nil {
+		return nil, err
+	}
+
+	return txResp, nil
+}
diff --git a/cosmosutil/client.go b/cosmosutil/client.go
@@ -0,0 +1,36 @@
+package cosmosutil
+
+import (
+	authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
+	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
+	petritypes "github.com/skip-mev/petri/types"
+)
+
+type ChainClient struct {
+	Chain          petritypes.ChainI
+	EncodingConfig EncodingConfig
+}
+
+// todo: remove the nolints
+
+//nolint:unused
+func (c *ChainClient) getAuthClient() (authtypes.QueryClient, error) {
+	cc, err := c.Chain.GetGPRCClient()
+
+	if err != nil {
+		return nil, err
+	}
+
+	return authtypes.NewQueryClient(cc), nil
+}
+
+//nolint:unused
+func (c *ChainClient) getBankClient() (banktypes.QueryClient, error) {
+	cc, err := c.Chain.GetGPRCClient()
+
+	if err != nil {
+		return nil, err
+	}
+
+	return banktypes.NewQueryClient(cc), nil
+}
diff --git a/cosmosutil/go.mod b/cosmosutil/go.mod
@@ -0,0 +1,165 @@
+module github.com/skip-mev/petri/cosmosutil
+
+go 1.21.3
+
+replace (
+	github.com/skip-mev/petri/provider => ../provider
+	github.com/skip-mev/petri/types => ../types
+	github.com/skip-mev/petri/util => ../util
+)
+
+require (
+	github.com/cometbft/cometbft v0.38.2
+	github.com/cosmos/cosmos-sdk v0.50.2
+	github.com/skip-mev/petri/types v0.0.0-00010101000000-000000000000
+	github.com/stretchr/testify v1.8.4
+	google.golang.org/grpc v1.60.1
+)
+
+require (
+	cosmossdk.io/api v0.7.2 // indirect
+	cosmossdk.io/collections v0.4.0 // indirect
+	cosmossdk.io/core v0.11.0 // indirect
+	cosmossdk.io/depinject v1.0.0-alpha.4 // indirect
+	cosmossdk.io/errors v1.0.0 // indirect
+	cosmossdk.io/log v1.2.1 // indirect
+	cosmossdk.io/math v1.2.0 // indirect
+	cosmossdk.io/store v1.0.1 // indirect
+	cosmossdk.io/x/tx v0.12.0 // indirect
+	filippo.io/edwards25519 v1.0.0 // indirect
+	github.com/99designs/go-keychain v0.0.0-20191008050251-8e49817e8af4 // indirect
+	github.com/99designs/keyring v1.2.1 // indirect
+	github.com/DataDog/datadog-go v3.2.0+incompatible // indirect
+	github.com/DataDog/zstd v1.5.5 // indirect
+	github.com/beorn7/perks v1.0.1 // indirect
+	github.com/bgentry/speakeasy v0.1.1-0.20220910012023-760eaf8b6816 // indirect
+	github.com/btcsuite/btcd/btcec/v2 v2.3.2 // indirect
+	github.com/cenkalti/backoff/v4 v4.1.3 // indirect
+	github.com/cespare/xxhash v1.1.0 // indirect
+	github.com/cespare/xxhash/v2 v2.2.0 // indirect
+	github.com/cockroachdb/errors v1.11.1 // indirect
+	github.com/cockroachdb/logtags v0.0.0-20230118201751-21c54148d20b // indirect
+	github.com/cockroachdb/pebble v0.0.0-20231101195458-481da04154d6 // indirect
+	github.com/cockroachdb/redact v1.1.5 // indirect
+	github.com/cockroachdb/tokenbucket v0.0.0-20230807174530-cc333fc44b06 // indirect
+	github.com/cometbft/cometbft-db v0.9.1 // indirect
+	github.com/cosmos/btcutil v1.0.5 // indirect
+	github.com/cosmos/cosmos-db v1.0.0 // indirect
+	github.com/cosmos/cosmos-proto v1.0.0-beta.3 // indirect
+	github.com/cosmos/go-bip39 v1.0.0 // indirect
+	github.com/cosmos/gogogateway v1.2.0 // indirect
+	github.com/cosmos/gogoproto v1.4.11 // indirect
+	github.com/cosmos/iavl v1.0.0 // indirect
+	github.com/cosmos/ics23/go v0.10.0 // indirect
+	github.com/cosmos/ledger-cosmos-go v0.13.3 // indirect
+	github.com/danieljoos/wincred v1.1.2 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/decred/dcrd/dcrec/secp256k1/v4 v4.2.0 // indirect
+	github.com/desertbit/timer v0.0.0-20180107155436-c41aec40b27f // indirect
+	github.com/dgraph-io/badger/v2 v2.2007.4 // indirect
+	github.com/dgraph-io/ristretto v0.1.1 // indirect
+	github.com/dgryski/go-farm v0.0.0-20200201041132-a6ae2369ad13 // indirect
+	github.com/dustin/go-humanize v1.0.1 // indirect
+	github.com/dvsekhvalnov/jose2go v1.5.0 // indirect
+	github.com/emicklei/dot v1.6.0 // indirect
+	github.com/fatih/color v1.15.0 // indirect
+	github.com/felixge/httpsnoop v1.0.2 // indirect
+	github.com/fsnotify/fsnotify v1.6.0 // indirect
+	github.com/getsentry/sentry-go v0.25.0 // indirect
+	github.com/go-kit/kit v0.12.0 // indirect
+	github.com/go-kit/log v0.2.1 // indirect
+	github.com/go-logfmt/logfmt v0.6.0 // indirect
+	github.com/gobwas/httphead v0.1.0 // indirect
+	github.com/gobwas/pool v0.2.1 // indirect
+	github.com/godbus/dbus v0.0.0-20190726142602-4481cbc300e2 // indirect
+	github.com/gogo/googleapis v1.4.1 // indirect
+	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/golang/glog v1.2.0 // indirect
+	github.com/golang/mock v1.6.0 // indirect
+	github.com/golang/protobuf v1.5.3 // indirect
+	github.com/golang/snappy v0.0.4 // indirect
+	github.com/google/btree v1.1.2 // indirect
+	github.com/google/go-cmp v0.6.0 // indirect
+	github.com/google/orderedcode v0.0.1 // indirect
+	github.com/gorilla/handlers v1.5.1 // indirect
+	github.com/gorilla/mux v1.8.0 // indirect
+	github.com/gorilla/websocket v1.5.0 // indirect
+	github.com/grpc-ecosystem/go-grpc-middleware v1.4.0 // indirect
+	github.com/grpc-ecosystem/grpc-gateway v1.16.0 // indirect
+	github.com/gsterjov/go-libsecret v0.0.0-20161001094733-a6f4afe4910c // indirect
+	github.com/hashicorp/go-hclog v1.5.0 // indirect
+	github.com/hashicorp/go-immutable-radix v1.3.1 // indirect
+	github.com/hashicorp/go-metrics v0.5.1 // indirect
+	github.com/hashicorp/go-plugin v1.5.2 // indirect
+	github.com/hashicorp/golang-lru v1.0.2 // indirect
+	github.com/hashicorp/hcl v1.0.0 // indirect
+	github.com/hashicorp/yamux v0.1.1 // indirect
+	github.com/hdevalence/ed25519consensus v0.1.0 // indirect
+	github.com/huandu/skiplist v1.2.0 // indirect
+	github.com/iancoleman/strcase v0.3.0 // indirect
+	github.com/improbable-eng/grpc-web v0.15.0 // indirect
+	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/jmhodges/levigo v1.0.0 // indirect
+	github.com/klauspost/compress v1.17.4 // indirect
+	github.com/kr/pretty v0.3.1 // indirect
+	github.com/kr/text v0.2.0 // indirect
+	github.com/lib/pq v1.10.7 // indirect
+	github.com/libp2p/go-buffer-pool v0.1.0 // indirect
+	github.com/linxGnu/grocksdb v1.8.6 // indirect
+	github.com/magiconair/properties v1.8.7 // indirect
+	github.com/mattn/go-colorable v0.1.13 // indirect
+	github.com/mattn/go-isatty v0.0.20 // indirect
+	github.com/matttproud/golang_protobuf_extensions/v2 v2.0.0 // indirect
+	github.com/minio/highwayhash v1.0.2 // indirect
+	github.com/mitchellh/go-testing-interface v1.14.1 // indirect
+	github.com/mitchellh/mapstructure v1.5.0 // indirect
+	github.com/mtibben/percent v0.2.1 // indirect
+	github.com/oasisprotocol/curve25519-voi v0.0.0-20230904125328-1f23a7beb09a // indirect
+	github.com/oklog/run v1.1.0 // indirect
+	github.com/pelletier/go-toml/v2 v2.1.0 // indirect
+	github.com/petermattis/goid v0.0.0-20230904192822-1876fd5063bc // indirect
+	github.com/pkg/errors v0.9.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/prometheus/client_golang v1.17.0 // indirect
+	github.com/prometheus/client_model v0.5.0 // indirect
+	github.com/prometheus/common v0.45.0 // indirect
+	github.com/prometheus/procfs v0.12.0 // indirect
+	github.com/rcrowley/go-metrics v0.0.0-20201227073835-cf1acfcdf475 // indirect
+	github.com/rogpeppe/go-internal v1.11.0 // indirect
+	github.com/rs/cors v1.8.3 // indirect
+	github.com/rs/zerolog v1.31.0 // indirect
+	github.com/sasha-s/go-deadlock v0.3.1 // indirect
+	github.com/skip-mev/petri/provider v0.0.0-00010101000000-000000000000 // indirect
+	github.com/skip-mev/petri/util v0.0.0-00010101000000-000000000000 // indirect
+	github.com/spf13/afero v1.9.5 // indirect
+	github.com/spf13/cast v1.5.1 // indirect
+	github.com/spf13/cobra v1.7.0 // indirect
+	github.com/spf13/jwalterweatherman v1.1.0 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
+	github.com/spf13/viper v1.16.0 // indirect
+	github.com/subosito/gotenv v1.4.2 // indirect
+	github.com/syndtr/goleveldb v1.0.1-0.20220721030215-126854af5e6d // indirect
+	github.com/tendermint/go-amino v0.16.0 // indirect
+	github.com/tidwall/btree v1.7.0 // indirect
+	github.com/zondax/hid v0.9.2 // indirect
+	github.com/zondax/ledger-go v0.14.3 // indirect
+	go.etcd.io/bbolt v1.3.8 // indirect
+	golang.org/x/crypto v0.16.0 // indirect
+	golang.org/x/exp v0.0.0-20231006140011-7918f672742d // indirect
+	golang.org/x/net v0.19.0 // indirect
+	golang.org/x/sync v0.5.0 // indirect
+	golang.org/x/sys v0.15.0 // indirect
+	golang.org/x/term v0.15.0 // indirect
+	golang.org/x/text v0.14.0 // indirect
+	google.golang.org/genproto v0.0.0-20231016165738-49dd2c1f3d0b // indirect
+	google.golang.org/genproto/googleapis/api v0.0.0-20231012201019-e917dd12ba7a // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20231030173426-d783a09b4405 // indirect
+	google.golang.org/protobuf v1.31.0 // indirect
+	gopkg.in/ini.v1 v1.67.0 // indirect
+	gopkg.in/yaml.v2 v2.4.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+	gotest.tools/v3 v3.5.1 // indirect
+	nhooyr.io/websocket v1.8.6 // indirect
+	pgregory.net/rapid v1.1.0 // indirect
+	sigs.k8s.io/yaml v1.3.0 // indirect
+)