pr comment: add docstrings under clientcontroller

babylonlabs-io · Sep 11, 2024 · 86901f8 · 86901f8
1 parent 99d4cc6
commit 86901f8
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/test/e2e/bcd_consumer_integration/clientcontroller/babylon/babylon.go b/test/e2e/bcd_consumer_integration/clientcontroller/babylon/babylon.go
@@ -1,3 +1,11 @@
+// Package clientcontroller/babylon wraps the Babylon RPC/gRPC client for easy interaction with a Babylon node.
+// It simplifies querying and submitting transactions.
+
+// Core Babylon RPC/gRPC client lives under https://github.com/babylonlabs-io/babylon/tree/main/client/client
+
+// Clientcontroller is adapted from:
+// https://github.com/babylonlabs-io/finality-provider/blob/base/consumer-chain-support/clientcontroller/babylon/babylon.go
+
 package babylon
 
 import (

diff --git a/test/e2e/bcd_consumer_integration/clientcontroller/cosmwasm/cosmwasm.go b/test/e2e/bcd_consumer_integration/clientcontroller/cosmwasm/cosmwasm.go
@@ -1,3 +1,11 @@
+// Package clientcontroller/cosmwasm wraps the CosmWasm RPC/gRPC client for easy interaction with a Wasm enabled node.
+// It simplifies querying and submitting transactions to Babylon SDK node (bcd)
+
+// Core CosmWasm RPC/gRPC client lives under https://github.com/babylonlabs-io/cosmwasm-client
+
+// Clientcontroller is adapted from:
+// https://github.com/babylonlabs-io/finality-provider/blob/base/consumer-chain-support/clientcontroller/cosmwasm/consumer.go
+
 package cosmwasm
 
 import (