From a898c90098422c3a1be5d65793b5b7d92e69b4c3 Mon Sep 17 00:00:00 2001 From: lumtis Date: Wed, 5 Jun 2024 15:53:36 +0200 Subject: [PATCH] add package headers --- zetaclient/authz/authz_signer.go | 1 + zetaclient/chains/bitcoin/observer/observer.go | 1 + zetaclient/chains/bitcoin/signer/signer.go | 1 + zetaclient/chains/evm/observer/observer.go | 1 + zetaclient/chains/evm/signer/signer.go | 1 + zetaclient/chains/interfaces/interfaces.go | 1 + zetaclient/compliance/compliance.go | 1 + zetaclient/config/config.go | 1 + zetaclient/context/app_context.go | 1 + zetaclient/metrics/metrics.go | 1 + zetaclient/orchestrator/orchestrator.go | 1 + zetaclient/outboundprocessor/outbound_processor_manager.go | 1 + zetaclient/ratelimiter/rate_limiter.go | 1 + zetaclient/supplychecker/zeta_supply_checker.go | 2 ++ zetaclient/tss/tss_signer.go | 1 + zetaclient/zetacore/client.go | 1 + 16 files changed, 17 insertions(+) diff --git a/zetaclient/authz/authz_signer.go b/zetaclient/authz/authz_signer.go index 378573bd17..385b0f9e7b 100644 --- a/zetaclient/authz/authz_signer.go +++ b/zetaclient/authz/authz_signer.go @@ -1,3 +1,4 @@ +// Package authz provides a signer object for transactions using grants package authz import ( diff --git a/zetaclient/chains/bitcoin/observer/observer.go b/zetaclient/chains/bitcoin/observer/observer.go index 05f63bba87..410676ed90 100644 --- a/zetaclient/chains/bitcoin/observer/observer.go +++ b/zetaclient/chains/bitcoin/observer/observer.go @@ -1,3 +1,4 @@ +// Package observer implements the Bitcoin chain observer package observer import ( diff --git a/zetaclient/chains/bitcoin/signer/signer.go b/zetaclient/chains/bitcoin/signer/signer.go index 159c4f6577..81d7f7f286 100644 --- a/zetaclient/chains/bitcoin/signer/signer.go +++ b/zetaclient/chains/bitcoin/signer/signer.go @@ -1,3 +1,4 @@ +// Package signer implements the ChainSigner interface for BTC package signer import ( diff --git a/zetaclient/chains/evm/observer/observer.go b/zetaclient/chains/evm/observer/observer.go index c61b0f78b8..e58f3b4370 100644 --- a/zetaclient/chains/evm/observer/observer.go +++ b/zetaclient/chains/evm/observer/observer.go @@ -1,3 +1,4 @@ +// Package observer implements the EVM chain observer package observer import ( diff --git a/zetaclient/chains/evm/signer/signer.go b/zetaclient/chains/evm/signer/signer.go index 32b3152cd0..dc0f39d288 100644 --- a/zetaclient/chains/evm/signer/signer.go +++ b/zetaclient/chains/evm/signer/signer.go @@ -1,3 +1,4 @@ +// Package signer implements the ChainSigner interface for EVM chains package signer import ( diff --git a/zetaclient/chains/interfaces/interfaces.go b/zetaclient/chains/interfaces/interfaces.go index 1d901d4f53..533dcc6029 100644 --- a/zetaclient/chains/interfaces/interfaces.go +++ b/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 ( diff --git a/zetaclient/compliance/compliance.go b/zetaclient/compliance/compliance.go index e085b6954b..849d56742b 100644 --- a/zetaclient/compliance/compliance.go +++ b/zetaclient/compliance/compliance.go @@ -1,3 +1,4 @@ +// Package compliance provides functions to check for compliance of cross-chain transactions package compliance import ( diff --git a/zetaclient/config/config.go b/zetaclient/config/config.go index 916f9041c1..aa0c3c7c02 100644 --- a/zetaclient/config/config.go +++ b/zetaclient/config/config.go @@ -1,3 +1,4 @@ +// Package config provides functions to load and save ZetaClient config package config import ( diff --git a/zetaclient/context/app_context.go b/zetaclient/context/app_context.go index 01ed9c565a..ffdfa05604 100644 --- a/zetaclient/context/app_context.go +++ b/zetaclient/context/app_context.go @@ -1,3 +1,4 @@ +// Package context provides global app context for ZetaClient package context import ( diff --git a/zetaclient/metrics/metrics.go b/zetaclient/metrics/metrics.go index 4c7f5ff06b..1da10d10e8 100644 --- a/zetaclient/metrics/metrics.go +++ b/zetaclient/metrics/metrics.go @@ -1,3 +1,4 @@ +// Package metrics provides metrics functionalities for the zetaclient package metrics import ( diff --git a/zetaclient/orchestrator/orchestrator.go b/zetaclient/orchestrator/orchestrator.go index dbba673641..c4ad8a37b6 100644 --- a/zetaclient/orchestrator/orchestrator.go +++ b/zetaclient/orchestrator/orchestrator.go @@ -1,3 +1,4 @@ +// Package orchestrator provides the orchestrator for orchestrating cross-chain transactions package orchestrator import ( diff --git a/zetaclient/outboundprocessor/outbound_processor_manager.go b/zetaclient/outboundprocessor/outbound_processor_manager.go index 367c2698ea..0eabd6cf8e 100644 --- a/zetaclient/outboundprocessor/outbound_processor_manager.go +++ b/zetaclient/outboundprocessor/outbound_processor_manager.go @@ -1,3 +1,4 @@ +// Package outboundprocessor provides functionalities to track outbound processing package outboundprocessor import ( diff --git a/zetaclient/ratelimiter/rate_limiter.go b/zetaclient/ratelimiter/rate_limiter.go index 0ddb3b378b..e3c69898fa 100644 --- a/zetaclient/ratelimiter/rate_limiter.go +++ b/zetaclient/ratelimiter/rate_limiter.go @@ -1,3 +1,4 @@ +// Package ratelimiter provides functionalities for rate limiting the cross-chain transactions package ratelimiter import ( diff --git a/zetaclient/supplychecker/zeta_supply_checker.go b/zetaclient/supplychecker/zeta_supply_checker.go index 94b92849ed..b9c40df5b7 100644 --- a/zetaclient/supplychecker/zeta_supply_checker.go +++ b/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 ( diff --git a/zetaclient/tss/tss_signer.go b/zetaclient/tss/tss_signer.go index 661a3f6228..d917586833 100644 --- a/zetaclient/tss/tss_signer.go +++ b/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 ( diff --git a/zetaclient/zetacore/client.go b/zetaclient/zetacore/client.go index f43117cd78..f1b14d06ad 100644 --- a/zetaclient/zetacore/client.go +++ b/zetaclient/zetacore/client.go @@ -1,3 +1,4 @@ +// Package zetacore provides functionalities for interacting with ZetaChain package zetacore import (