copy pasta dev docs

ten-protocol · Apr 24, 2024 · 95c91a1 · 95c91a1
1 parent 922e512
commit 95c91a1
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/go/host/storage/interfaces.go b/go/host/storage/interfaces.go
@@ -42,7 +42,7 @@ type BatchResolver interface {
 	FetchBatchHeaderByHeight(height *big.Int) (*common.BatchHeader, error)
 	// FetchTotalTxCount returns the number of transactions in the DB
 	FetchTotalTxCount() (*big.Int, error)
-	// FetchBatchTransactions TODO
+	// FetchBatchTransactions returns a list of public transaction data within a given batch hash
 	FetchBatchTransactions(batchHash gethcommon.Hash) (*common.TransactionListingResponse, error)
 }
 
@@ -57,8 +57,8 @@ type BlockResolver interface {
 	FetchRollupListing(pagination *common.QueryPagination) (*common.RollupListingResponse, error)
 	// FetchBlockListing returns a paginated list of blocks that include rollups
 	FetchBlockListing(pagination *common.QueryPagination) (*common.BlockListingResponse, error)
-	// FetchRollupByHash TODO
+	// FetchRollupByHash returns the public rollup data given its hash
 	FetchRollupByHash(rollupHash gethcommon.Hash) (*common.PublicRollup, error)
-	// FetchRollupBatches TODO
+	// FetchRollupBatches returns a list of public batch data within a given rollup hash
 	FetchRollupBatches(rollupHash gethcommon.Hash) (*common.BatchListingResponse, error)
 }
diff --git a/go/obsclient/obsclient.go b/go/obsclient/obsclient.go
@@ -189,7 +189,7 @@ func (oc *ObsClient) GetRollupListing(pagination *common.QueryPagination) (*comm
 	return &result, nil
 }
 
-// GetRollupByHash TODO
+// GetRollupByHash returns the public rollup data given its hash
 func (oc *ObsClient) GetRollupByHash(hash gethcommon.Hash) (*common.PublicRollup, error) {
 	var rollup *common.PublicRollup
 	err := oc.rpcClient.Call(&rollup, rpc.GetRollupByHash, hash)
@@ -199,7 +199,7 @@ func (oc *ObsClient) GetRollupByHash(hash gethcommon.Hash) (*common.PublicRollup
 	return rollup, err
 }
 
-// GetRollupBatches TODO
+// GetRollupBatches returns a list of public batch data within a given rollup hash
 func (oc *ObsClient) GetRollupBatches(hash gethcommon.Hash) (*common.BatchListingResponse, error) {
 	var batchListing *common.BatchListingResponse
 	err := oc.rpcClient.Call(&batchListing, rpc.GetRollupBatches, hash)
@@ -209,7 +209,7 @@ func (oc *ObsClient) GetRollupBatches(hash gethcommon.Hash) (*common.BatchListin
 	return batchListing, err
 }
 
-// GetBatchTransactions TODO
+// GetBatchTransactions returns a list of public transaction data within a given batch hash
 func (oc *ObsClient) GetBatchTransactions(hash gethcommon.Hash) (*common.TransactionListingResponse, error) {
 	var txListing *common.TransactionListingResponse
 	err := oc.rpcClient.Call(&txListing, rpc.GetBatchTransactions, hash)