package
0.0.0-20250225125202-ade2195ffe68
Repository: https://github.com/baking-bad/bcdhub.git
Documentation: pkg.go.dev

# Functions

CodeFromMichelson -.
ContextsMiddleware -.
ContractsCount godoc @Summary Get contracts count @Description Get contracts count @Tags statistics @ID get-contracts-count @Param network path string true "Network" @Accept json @Produce json @Success 200 {integer} integer @Failure 400 {object} Error @Failure 500 {object} Error @Router /v1/stats/{network}/contracts_count [get].
ContractsHelpers -.
ExecuteView godoc @Summary Execute view of contracts metadata @Description Execute view of contracts metadata @Tags contract @ID contract-execute-view @Param network path string true "Network" @Param address path string true "KT address" minlength(36) maxlength(36) @Param body body executeViewRequest true "Request body" @Accept json @Produce json @Success 200 {array} ast.MiguelNode @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /v1/contract/{network}/{address}/views/execute [post].
ForkContract -.
GetBigMap godoc @Summary Get big map info by pointer @Description Get big map info by pointer @Tags bigmap @ID get-bigmap @Param network path string true "Network" @Param ptr path integer true "Big map pointer" @Accept json @Produce json @Success 200 {object} GetBigMapResponse @Failure 400 {object} Error @Failure 500 {object} Error @Router /v1/bigmap/{network}/{ptr} [get].
GetBigMapByKeyHash godoc @Summary Get big map diffs by pointer and key hash @Description Get big map diffs by pointer and key hash @Tags bigmap @ID get-bigmap-keyhash @Param network path string true "Network" @Param ptr path integer true "Big map pointer" @Param key_hash path string true "Key hash in big map" minlength(54) maxlength(54) @Param offset query integer false "Offset" @Param size query integer false "Requested count" mininum(1) maximum(10) @Accept json @Produce json @Success 200 {object} BigMapDiffByKeyResponse @Success 204 {object} gin.H @Failure 400 {object} Error @Failure 500 {object} Error @Router /v1/bigmap/{network}/{ptr}/keys/{key_hash} [get].
GetBigMapDiffCount godoc @Summary Get big map diffs count info by pointer @Description Get big map diffs count info by pointer @Tags bigmap @ID get-bigmapdiff-count @Param network path string true "Network" @Param ptr path integer true "Big map pointer" @Accept json @Produce json @Success 200 {object} CountResponse @Failure 400 {object} Error @Failure 500 {object} Error @Router /v1/bigmap/{network}/{ptr}/count [get].
GetBigMapHistory godoc @Summary Get big map actions (alloc/copy/remove) @Description Get big map actions (alloc/copy/remove) @Tags bigmap @ID get-bigmap-history @Param network path string true "Network" @Param ptr path integer true "Big map pointer" @Accept json @Produce json @Success 200 {object} BigMapHistoryResponse @Success 204 {object} gin.H @Failure 400 {object} Error @Failure 500 {object} Error @Router /v1/bigmap/{network}/{ptr}/history [get].
GetBigMapKeys godoc @Summary Get big map keys by pointer @Description Get big map keys by pointer @Tags bigmap @ID get-bigmap-keys @Param network path string true "Network" @Param ptr path integer true "Big map pointer" @Param offset query integer false "Offset" @Param size query integer false "Requested count" mininum(1) maximum(10) @Param max_level query integer false "Max level filter" minimum(0) @Param min_level query integer false "Min level filter" minimum(0) @Accept json @Produce json @Success 200 {array} BigMapResponseItem @Failure 400 {object} Error @Failure 500 {object} Error @Router /v1/bigmap/{network}/{ptr}/keys [get].
GetByHashAndCounter - @Summary Get operations by hash and counter @Description Get operations by hash and counter @Tags operations @ID get-operations-by-hash-and-counter @Param network path string true "You can set network field for better performance" @Param hash path string true "Operation group hash" minlength(51) maxlength(51) @Param counter path integer true "Counter of main operation" @Accept json @Produce json @Success 200 {array} Operation @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /v1/opg/{network}/{hash}/{counter} [get].
GetConfig -.
GetContract godoc @Summary Get contract info @Description Get full contract info @Tags contract @ID get-contract @Param network path string true "Network" @Param address path string true "KT address" minlength(36) maxlength(36) @Accept json @Produce json @Success 200 {object} ContractWithStats @Success 204 {object} gin.H @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /v1/contract/{network}/{address} [get].
GetContractCode godoc @Summary Get contract code @Description Get contract code @Tags contract @ID get-contract-code @Param network path string true "Network" @Param address path string true "KT address" minlength(36) maxlength(36) @Param protocol query string false "Protocol" @Param level query integer false "Level" @Accept json @Produce json @Success 200 {string} string @Failure 400 {object} Error @Failure 500 {object} Error @Router /v1/contract/{network}/{address}/code [get].
GetContractGlobalConstants godoc @Summary Get global constants used by contract @Description Get global constants used by contract @Tags contract @ID get-contract-global-constants @Param network path string true "network" @Param address path string true "KT address" minlength(36) maxlength(36) @Param size query integer false "Constants count" mininum(1) maximum(10) @Param offset query integer false "Offset" mininum(1) @Accept json @Produce json @Success 200 {array} GlobalConstant @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /v1/contract/{network}/{address}/global_constants [get].
GetContractMigrations godoc @Summary Get contract migrations @Description Get contract migrations @Tags contract @ID get-contract-migrations @Param network path string true "Network" @Param address path string true "KT address" minlength(36) maxlength(36) @Accept json @Produce json @Success 200 {array} Migration @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /v1/contract/{network}/{address}/migrations [get].
GetContractStorage godoc @Summary Get contract storage @Description Get contract storage @Tags contract @ID get-contract-storage @Param network path string true "Network" @Param address path string true "KT address" minlength(36) maxlength(36) @Param level query integer false "Level" @Accept json @Produce json @Success 200 {array} ast.MiguelNode @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /v1/contract/{network}/{address}/storage [get].
GetContractStorageRaw godoc @Summary Get contract raw storage @Description Get contract raw storage @Tags contract @ID get-contract-storage-raw @Param network path string true "Network" @Param address path string true "KT address" minlength(36) maxlength(36) @Param level query integer false "Level" @Accept json @Produce json @Success 200 {string} string @Success 204 {string} string @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /v1/contract/{network}/{address}/storage/raw [get].
GetContractStorageRich godoc @Summary Get contract rich storage @Description Get contract rich storage @Tags contract @ID get-contract-storage-rich @Param network path string true "Network" @Param address path string true "KT address" minlength(36) maxlength(36) @Param level query integer false "Level" @Accept json @Produce json @Success 200 {object} gin.H @Success 204 {object} gin.H @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /v1/contract/{network}/{address}/storage/rich [get].
GetContractStorageSchema godoc @Summary Get contract storage schema @Description Get contract storage schema @Tags contract @ID get-contract-storage-schema @Param network path string true "Network" @Param address path string true "KT address" minlength(36) maxlength(36) @Param fill_type query string false "Fill storage type" Enums(empty, current, initial) @Accept json @Produce json @Success 200 {object} EntrypointSchema @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /v1/contract/{network}/{address}/storage/schema [get].
GetContractTickets godoc @Summary Get tickets for contract @Description Get tickets for contract @Tags contract @ID get-contract-tickets @Param network path string true "network" @Param address path string true "KT address" minlength(36) maxlength(36) @Param size query integer false "Updates count" mininum(1) maximum(10) @Param offset query integer false "Offset" mininum(1) @Accept json @Produce json @Success 200 {array} Ticket @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /v1/contract/{network}/{address}/tickets [get].
GetContractTicketUpdates godoc @Summary Get ticket updates for contract @Description Get ticket updates for contract @Tags contract @ID get-contract-ticket-updates @Param network path string true "network" @Param address path string true "KT address" minlength(36) maxlength(36) @Param account query string false "Address" minlength(36) maxlength(36) @Param ticket_id query integer false "Ticket id" mininum(0) @Param size query integer false "Updates count" mininum(1) maximum(10) @Param offset query integer false "Offset" mininum(1) @Accept json @Produce json @Success 200 {array} TicketUpdate @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /v1/contract/{network}/{address}/ticket_updates [get].
GetCurrentBigMapKeyHash godoc @Summary Get current big map value by pointer and key hash @Description Get current big map value by pointer and key hash @Tags bigmap @ID get-bigmap-keyhash-current @Param network path string true "Network" @Param ptr path integer true "Big map pointer" @Param key_hash path string true "Key hash in big map" minlength(54) maxlength(54) @Accept json @Produce json @Success 200 {object} BigMapDiffByKeyResponse @Success 404 {object} Error @Failure 400 {object} Error @Failure 500 {object} Error @Router /v1/bigmap/{network}/{ptr}/keys/{key_hash}/current [get].
GetEntrypointData godoc @Summary Get entrypoint data from schema object @Description Get entrypoint data from schema object @Tags contract @ID get-contract-entrypoints-data @Param network path string true "Network" @Param address path string true "KT address" minlength(36) maxlength(36) @Param body body getEntrypointDataRequest true "Request body" @Accept json @Produce json @Success 200 {object} gin.H @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /v1/contract/{network}/{address}/entrypoints/data [post].
GetEntrypoints godoc @Summary Get contract entrypoints @Description Get contract entrypoints @Tags contract @ID get-contract-entrypoints @Param network path string true "Network" @Param address path string true "KT address" minlength(36) maxlength(36) @Accept json @Produce json @Success 200 {array} EntrypointSchema @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /v1/contract/{network}/{address}/entrypoints [get].
GetEntrypointSchema godoc @Summary Get contract`s entrypoint schema @Description Get contract`s entrypoint schema @Tags contract @ID get-contract-entrypoints-schema @Param network path string true "Network" @Param address path string true "KT address" minlength(36) maxlength(36) @Param entrypoint query string true "Entrypoint name" @Param fill_type query string false "Fill storage type" Enums(empty, latest) @Accept json @Produce json @Success 200 {object} EntrypointSchema @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /v1/contract/{network}/{address}/entrypoints/schema [get].
GetGlobalConstant godoc @Summary Get global constant @Description Get global constant @Tags global-constants @ID get-global-constant @Param network path string true "network" @Param address path string true "expr address of constant" minlength(54) maxlength(54) @Accept json @Produce json @Success 200 {object} GlobalConstant @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /v1/global_constants/{network}/{address} [get].
GetGlobalConstantContracts godoc @Summary Get contracts that use the global constant @Description Get contracts that use the global constant @Tags global-constants @ID get-global-constant-contracts @Param network path string true "network" @Param address path string true "expr address of constant" minlength(54) maxlength(54) @Param size query integer false "Constants count" mininum(1) maximum(10) @Param offset query integer false "Offset" mininum(1) @Accept json @Produce json @Success 200 {array} Contract @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /v1/global_constants/{network}/{address}/contracts [get].
GetHead godoc @Summary Show indexer head @Description Get indexer head for each network @Tags head @ID get-indexer-head @Accept json @Produce json @Success 200 {array} Head @Failure 500 {object} Error @Router /v1/head [get].
GetHeadByNetwork godoc @Summary Show indexer head for the network @Description Get indexer head for the network @Tags head @ID get-indexer-head-by-network @Param network path string true "Network" @Accept json @Produce json @Success 200 {object} Head @Failure 500 {object} Error @Router /v1/head/{network} [get].
GetImplicitOperation godoc @Summary Get implicit operation @DescriptionGet implicit operation @Tags operations @ID get-implicit-operation @Param network path string true "Network" @Param counter path integer true "Counter" @Accept json @Produce json @Success 200 {array} Operation @Success 204 {object} gin.H @Failure 400 {object} Error @Failure 500 {object} Error @Router /v1/implicit/{network}/{counter} [get].
GetInfo godoc @Summary Get account info @Description Get account info @Tags account @ID get-account-info @Param network path string true "Network" @Param address path string true "Address" minlength(36) maxlength(36) @Accept json @Produce json @Success 200 {object} AccountInfo @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /v1/account/{network}/{address} [get].
GetMempool godoc @Summary Get contract mempool operations @Description Get contract mempool operations @Tags contract @ID get-contract-mempool @Param network path string true "Network" @Param address path string true "KT address" minlength(36) maxlength(36) @Accept json @Produce json @Success 200 {array} Operation @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /v1/contract/{network}/{address}/mempool [get].
GetOperation godoc @Summary Get operation group @Description Get operation group by hash @Tags operations @ID get-opg @Param network path string true "Network" @Param hash path string true "Operation group hash" minlength(51) maxlength(51) @Param with_mempool query bool false "Search operation in mempool or not" @Param with_storage_diff query bool false "Include storage diff to operations or not" @Accept json @Produce json @Success 200 {array} Operation @Success 204 {object} gin.H @Failure 400 {object} Error @Failure 500 {object} Error @Router /v1/opg/{network}/{hash} [get].
GetOperationDiff godoc @Summary Get operation storage diff @DescriptionGet Get operation storage diff @Tags operations @ID get-operation-diff @Param network path string true "Network" @Param id path integer true "Internal BCD operation ID" @Accept json @Produce json @Success 200 {object} ast.MiguelNode @Failure 400 {object} Error @Failure 500 {object} Error @Router /v1/operation/{network}/{id}/diff [get].
GetOperationErrorLocation godoc @Summary Get code line where operation failed @Description Get code line where operation failed @Tags operations @ID get-operation-error-location @Param network path string true "Network" @Param id path integer true "Internal BCD operation ID" @Accept json @Produce json @Success 200 {object} GetErrorLocationResponse @Failure 400 {object} Error @Failure 500 {object} Error @Router /v1/operation/{network}/{id}/error_location [get].
GetOperationGroups - @Summary Get operation groups by account @Description Get operation groups by account @Tags contract @ID get-operation-groups-by-account @Param network path string true "Network" @Param address path string true "KT address" minlength(36) maxlength(36) @Param last_id query string false "Last operation ID" @Param size query integer false "Expected OPG count" mininum(1) @Accept json @Produce json @Success 200 {array} OPGResponse @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /v1/contract/{network}/{address}/opg [get].
GetSameContracts godoc @Summary Get same contracts @Description Get same contracts @Tags contract @ID get-contract-same @Param network path string true "Network" @Param address path string true "KT address" minlength(36) maxlength(36) @Param offset query integer false "Offset" @Param size query integer false "Requested count" mininum(1) maximum(10) @Accept json @Produce json @Success 200 {object} SameContractsResponse @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /v1/contract/{network}/{address}/same [get].
GetSmartRollup godoc @Summary Get smart rollup @Description Get smart rollup @Tags smart-rollups @ID get-smart-rollups @Param network path string true "network" @Param address path string true "expr address of smart rollup" minlength(36) maxlength(36) @Accept json @Produce json @Success 200 {object} SmartRollup @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /v1/smart_rollups/{network}/{address} [get].
GetStats godoc @Summary Show indexer stats @Description get indexer states for all networks @Tags statistics @ID get-stats @Accept json @Produce json @Success 200 {array} Block @Failure 500 {object} Error @Router /v1/stats [get].
GetTicketBalancesForAccount - @Router /v1/account/{network}/{address}/ticket_balances [get].
GetTicketUpdatesForOperation - @Router /v1/operation/{network}/{id}/ticket_updates [get].
GetViewsSchema godoc @Summary Get view schemas of contract metadata @Description Get view schemas of contract metadata @Tags contract @ID get-contract-tzip-views-schema @Param network path string true "Network" @Param address path string true "KT address" minlength(36) maxlength(36) @Param kind query string false "Views kind" Enums(on-chain, off-chain) @Accept json @Produce json @Success 200 {array} ViewSchema @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /v1/contract/{network}/{address}/views/schema [get].
ListEvents - @Summary List contract events @Description List contract events @Tags operations @ID list-events @Param network path string true "Network" @Param address path string true "KT address" minlength(36) maxlength(36) @Param offset query string false "Offset" @Param size query integer false "Expected events count" mininum(1) maximum(10) @Accept json @Produce json @Success 200 {array} Event @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /v1/contract/{network}/{address}/events [get].
ListGlobalConstants godoc @Summary List global constants @Description List global constants @Tags global-constants @ID list-global-constants @Param network path string true "network" @Param size query integer false "Constants count" mininum(1) maximum(10) @Param offset query integer false "Offset" mininum(1) @Param order_by query string false "Order by" Enums(level, timestamp, links_count, address) @Param sort query string false "Sort order" Enums(asc, desc) @Accept json @Produce json @Success 200 {array} GlobalConstantItem @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /v1/global_constants/{network} [get].
ListSmartRollups godoc @Summary List smart rollups @Description List smart rollups @Tags smart-rollups @ID list-smart-rollups @Param network path string true "network" @Param size query integer false "Constants count" mininum(1) maximum(10) @Param offset query integer false "Offset" mininum(1) @Param sort query string false "Sort order" Enums(asc, desc) @Accept json @Produce json @Success 200 {array} SmartRollup @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /v1/smart_rollups/{network} [get].
MainnetMiddleware -.
NetworkMiddleware -.
NewEvent -.
NewGlobalConstantFromModel -.
No description provided by the author
NewOPGResponse -.
NewSmartRollup -.
No description provided by the author
No description provided by the author
No description provided by the author
NewTicketUpdateFromModel -.
OffChainView godoc @Summary Get JSON schema for off-chain view @Description Get JSON schema for off-chain view @Tags contract @ID get-off-chain-view @Param body body json.RawMessage true "Micheline.
PrepareOperations -.
RecentlyCalledContracts godoc @Summary Show recently called contracts @Description Show recently called contracts @Tags statistics @ID get-recenly-called-contracts @Param network path string true "Network" @Param size query integer false "Contracts count" mininum(1) maximum(10) @Param offset query integer false "Offset" mininum(1) @Accept json @Produce json @Success 200 {array} RecentlyCalledContract @Failure 400 {object} Error @Failure 500 {object} Error @Router /v1/stats/{network}/recently_called_contracts [get].
RunCode godoc @Summary Execute entrypoint with passed arguments @Description Execute entrypoint with passed arguments @Tags contract @ID run-code @Param network path string true "Network" @Param address path string true "KT address" minlength(36) maxlength(36) @Param body body runCodeRequest true "Request body" @Accept json @Produce json @Success 200 {array} Operation @Failure 400 {object} Error @Failure 404 {object} Error @Failure 500 {object} Error @Router /v1/contract/{network}/{address}/entrypoints/trace [post].
RunOperation -.

# Constants

ViewSchemaKind.
ViewSchemaKind.
ViewSchemaKind.

# Structs

AccountInfo -.
BigMapDiffByKeyResponse -.
BigMapDiffItem -.
BigMapHistoryItem -.
BigMapHistoryResponse -.
BigMapItem -.
BigMapKeyStateResponse -.
BigMapResponseItem -.
Block -.
CodeDiffLeg -.
CodeDiffRequest -.
CodeDiffResponse -.
CodeFromMichelsonResponse -.
CodeFromMichelsonStorage -.
ConfigResponse -.
Contract -.
ContractWithStats -.
CountResponse -.
EntrypointSchema ;.
Error -.
Event -.
ForkResponse -.
FormatterRequest -.
GetBigMapResponse -.
GetErrorLocationResponse -.
GetTokenStatsRequest -.
GlobalConstant -.
No description provided by the author
Head -.
ImplicitOperationRequest -.
MetadataResponse -.
Migration -.
NetworkStats -.
OauthParams -.
OauthRequest -.
Operation -.
OperationGroupContentRequest -.
OperationResponse -.
OPGRequest -.
OPGResponse -.
Protocol -.
RecentlyCalledContract -.
SameContractsResponse -.
Screenshot -.
SearchBigMapDiff -.
SmartRollup -.
No description provided by the author
No description provided by the author
No description provided by the author
TicketUpdate -.
ViewSchema ;.

# Type aliases

Heads -.
Series -.
SeriesFloat -.
ViewSchemaKind -.