add package headers

zetaclient/authz/authz_signer.go

@@ -1,3 +1,4 @@
+// Package authz provides a signer object for transactions using grants
 package authz
 
 import (

zetaclient/chains/bitcoin/observer/observer.go

@@ -1,3 +1,4 @@
+// Package observer implements the Bitcoin chain observer
 package observer
 
 import (

zetaclient/chains/bitcoin/signer/signer.go

@@ -1,3 +1,4 @@
+// Package signer implements the ChainSigner interface for BTC
 package signer
 
 import (

zetaclient/chains/evm/observer/observer.go

@@ -1,3 +1,4 @@
+// Package observer implements the EVM chain observer
 package observer
 
 import (

zetaclient/chains/evm/signer/signer.go

@@ -1,3 +1,4 @@
+// Package signer implements the ChainSigner interface for EVM chains
 package signer
 
 import (

zetaclient/chains/interfaces/interfaces.go

@@ -1,3 +1,4 @@
+// Package interfaces provides interfaces for clients and signers for the chain to interact with
 package interfaces
 
 import (

zetaclient/compliance/compliance.go

@@ -1,3 +1,4 @@
+// Package compliance provides functions to check for compliance of cross-chain transactions
 package compliance
 
 import (

zetaclient/config/config.go

@@ -1,3 +1,4 @@
+// Package config provides functions to load and save ZetaClient config
 package config
 
 import (

zetaclient/context/app_context.go

@@ -1,3 +1,4 @@
+// Package context provides global app context for ZetaClient
 package context
 
 import (

zetaclient/metrics/metrics.go

@@ -1,3 +1,4 @@
+// Package metrics provides metrics functionalities for the zetaclient
 package metrics
 
 import (

zetaclient/orchestrator/orchestrator.go

@@ -1,3 +1,4 @@
+// Package orchestrator provides the orchestrator for orchestrating cross-chain transactions
 package orchestrator
 
 import (

zetaclient/outboundprocessor/outbound_processor_manager.go

@@ -1,3 +1,4 @@
+// Package outboundprocessor provides functionalities to track outbound processing
 package outboundprocessor
 
 import (

zetaclient/ratelimiter/rate_limiter.go

@@ -1,3 +1,4 @@
+// Package ratelimiter provides functionalities for rate limiting the cross-chain transactions
 package ratelimiter
 
 import (

zetaclient/supplychecker/zeta_supply_checker.go

@@ -1,3 +1,5 @@
+// Package supplychecker provides functionalities to check the total supply of Zeta tokens
+// Currently not used in the codebase
 package supplychecker
 
 import (

zetaclient/tss/tss_signer.go

@@ -1,3 +1,4 @@
+// Package tss provides the TSS signer functionalities for the zetaclient to sign transactions on external chains
 package tss
 
 import (

zetaclient/zetacore/client.go

@@ -1,3 +1,4 @@
+// Package zetacore provides functionalities for interacting with ZetaChain
 package zetacore
 
 import (