docs(zetaclient): add more function and package documentation

changelog.md

@@ -72,6 +72,10 @@
 * [2191](https://github.com/zeta-chain/node/pull/2191) - Fixed conditional logic for the docker build step for non release builds to not overwrite the github tag.
 * [2192](https://github.com/zeta-chain/node/pull/2192) - Added release status checker and updater pipeline that will update release statuses when they go live on network.
 
+### Documentation
+
+* [2321](https://github.com/zeta-chain/node/pull/2321) - improve documentation for ZetaClient functions and packages
+
 ## v17.0.0
 
 ### Fixes

zetaclient/authz/authz_signer.go

@@ -1,3 +1,4 @@
+// Package authz provides a signer object for transactions using grants
 package authz
 
 import (
@@ -7,18 +8,22 @@ import (
 	crosschaintypes "github.com/zeta-chain/zetacore/x/crosschain/types"
 )
 
+// Signer represents a signer for a grantee key
 type Signer struct {
 	KeyType        authz.KeyType
 	GranterAddress string
 	GranteeAddress sdk.AccAddress
 }
 
+// String returns a string representation of a Signer
 func (a Signer) String() string {
 	return a.KeyType.String() + " " + a.GranterAddress + " " + a.GranteeAddress.String()
 }
 
+// signers is a map of all the signers for the different tx types
 var signers map[string]Signer
 
+// init initializes the signers map with all the crosschain tx types using the ZetaClientGranteeKey
 func init() {
 	signersList := make(map[string]Signer)
 	for _, tx := range crosschaintypes.GetAllAuthzZetaclientTxTypes() {
@@ -27,6 +32,7 @@ func init() {
 	signers = signersList
 }
 
+// SetupAuthZSignerList sets the granter and grantee for all the signers
 func SetupAuthZSignerList(granter string, grantee sdk.AccAddress) {
 	for k, v := range signers {
 		v.GranterAddress = granter
@@ -35,6 +41,7 @@ func SetupAuthZSignerList(granter string, grantee sdk.AccAddress) {
 	}
 }
 
+// GetSigner returns the signer for a given msgURL
 func GetSigner(msgURL string) Signer {
 	return signers[msgURL]
 }

zetaclient/authz/authz_signer_test.go

@@ -1 +1,3 @@
 package authz_test
+
+// NOTE: test file currently created empty to add the package in the test coverage scope

zetaclient/chains/bitcoin/observer/inbound.go

@@ -25,7 +25,9 @@ import (
 	"github.com/zeta-chain/zetacore/zetaclient/zetacore"
 )
 
-// WatchInbound watches Bitcoin chain for incoming txs and post votes to zetacore
+// WatchInbound watches Bitcoin chain for inbounds
+// It starts a ticker and run ObserveInbound
+// TODO(revamp): move all ticker related methods in the same file
 func (ob *Observer) WatchInbound() {
 	ticker, err := types.NewDynamicTicker("Bitcoin_WatchInbound", ob.GetChainParams().InboundTicker)
 	if err != nil {
@@ -37,6 +39,7 @@ func (ob *Observer) WatchInbound() {
 	ob.logger.Inbound.Info().Msgf("WatchInbound started for chain %d", ob.chain.ChainId)
 	sampledLogger := ob.logger.Inbound.Sample(&zerolog.BasicSampler{N: 10})
 
+	// ticker loop
 	for {
 		select {
 		case <-ticker.C():
@@ -57,6 +60,8 @@ func (ob *Observer) WatchInbound() {
 	}
 }
 
+// ObserveInbound observes Bitcoin chain for inbounds and post votes to zetacore
+// TODO(revamp): simplify this function into smaller functions
 func (ob *Observer) ObserveInbound() error {
 	// get and update latest block height
 	cnt, err := ob.rpcClient.GetBlockCount()
@@ -171,6 +176,7 @@ func (ob *Observer) ObserveInbound() error {
 }
 
 // WatchInboundTracker watches zetacore for bitcoin inbound trackers
+// TODO(revamp): move all ticker related methods in the same file
 func (ob *Observer) WatchInboundTracker() {
 	ticker, err := types.NewDynamicTicker("Bitcoin_WatchInboundTracker", ob.GetChainParams().InboundTicker)
 	if err != nil {
@@ -200,6 +206,7 @@ func (ob *Observer) WatchInboundTracker() {
 }
 
 // ProcessInboundTrackers processes inbound trackers
+// TODO(revamp): move inbound tracker logic in a specific file
 func (ob *Observer) ProcessInboundTrackers() error {
 	trackers, err := ob.zetacoreClient.GetInboundTrackersForChain(ob.chain.ChainId)
 	if err != nil {
@@ -328,6 +335,7 @@ func FilterAndParseIncomingTx(
 	return inbounds, nil
 }
 
+// GetInboundVoteMessageFromBtcEvent converts a BTCInboundEvent to a MsgVoteInbound to enable voting on the inbound on zetacore
 func (ob *Observer) GetInboundVoteMessageFromBtcEvent(inbound *BTCInboundEvent) *crosschaintypes.MsgVoteInbound {
 	ob.logger.Inbound.Debug().Msgf("Processing inbound: %s", inbound.TxHash)
 	amount := big.NewFloat(inbound.Value)
@@ -360,6 +368,7 @@ func (ob *Observer) GetInboundVoteMessageFromBtcEvent(inbound *BTCInboundEvent)
 }
 
 // DoesInboundContainsRestrictedAddress returns true if the inbound contains restricted addresses
+// TODO(revamp): move all compliance related functions in a specific file
 func (ob *Observer) DoesInboundContainsRestrictedAddress(inTx *BTCInboundEvent) bool {
 	receiver := ""
 	parsedAddress, _, err := chains.ParseAddressAndData(hex.EncodeToString(inTx.MemoBytes))
@@ -376,6 +385,7 @@ func (ob *Observer) DoesInboundContainsRestrictedAddress(inTx *BTCInboundEvent)
 
 // GetBtcEvent either returns a valid BTCInboundEvent or nil
 // Note: the caller should retry the tx on error (e.g., GetSenderAddressByVin failed)
+// TODO(revamp): simplify this function
 func GetBtcEvent(
 	rpcClient interfaces.BTCRPCClient,
 	tx btcjson.TxRawResult,