Documentation
¶
Index ¶
- Constants
- type CreateTransaction
- type GetAccount
- type GetAccountBalance
- type GetAccountKey
- type GetAccountKeys
- type GetBlock
- type GetBlockByIDs
- type GetBlockPayload
- type GetByIDRequest
- type GetCollection
- type GetEvents
- type GetExecutionResult
- type GetExecutionResultByBlockIDs
- type GetScript
- type GetTransaction
- type GetTransactionResult
- type Height
- type Heights
- type Script
- type TransactionOptionals
Constants ¶
const EmptyHeight uint64 = math.MaxUint64 - 3
const ExpandsTransactions = "transactions"
const FinalHeight uint64 = math.MaxUint64 - 2
const MaxBlockRequestHeightRange = 50
const MaxEventRequestHeightRange = 250
const SealedHeight uint64 = math.MaxUint64 - 1
Special height values
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CreateTransaction ¶
type CreateTransaction struct {
Transaction flow.TransactionBody
}
func CreateTransactionRequest ¶
func CreateTransactionRequest(r *common.Request) (CreateTransaction, error)
type GetAccount ¶
func GetAccountRequest ¶
func GetAccountRequest(r *common.Request) (GetAccount, error)
GetAccountRequest extracts necessary variables and query parameters from the provided request, builds a GetAccount instance, and validates it.
No errors are expected during normal operation.
type GetAccountBalance ¶
func GetAccountBalanceRequest ¶
func GetAccountBalanceRequest(r *common.Request) (GetAccountBalance, error)
GetAccountBalanceRequest extracts necessary variables and query parameters from the provided request, builds a GetAccountBalance instance, and validates it.
No errors are expected during normal operation.
type GetAccountKey ¶
func GetAccountKeyRequest ¶
func GetAccountKeyRequest(r *common.Request) (GetAccountKey, error)
GetAccountKeyRequest extracts necessary variables and query parameters from the provided request, builds a GetAccountKey instance, and validates it.
No errors are expected during normal operation.
type GetAccountKeys ¶
func GetAccountKeysRequest ¶
func GetAccountKeysRequest(r *common.Request) (GetAccountKeys, error)
GetAccountKeysRequest extracts necessary variables and query parameters from the provided request, builds a GetAccountKeys instance, and validates it.
No errors are expected during normal operation.
type GetBlock ¶
type GetBlock struct {
Heights []uint64
StartHeight uint64
EndHeight uint64
FinalHeight bool
SealedHeight bool
}
func GetBlockRequest ¶
GetBlockRequest extracts necessary query parameters from the provided request, builds a GetBlock instance, and validates it.
No errors are expected during normal operation.
func (*GetBlock) HasHeights ¶
type GetBlockByIDs ¶
type GetBlockByIDs struct {
IDs []flow.Identifier
}
func GetBlockByIDsRequest ¶
func GetBlockByIDsRequest(r *common.Request) (GetBlockByIDs, error)
GetBlockByIDsRequest extracts necessary variables from the provided request, builds a GetBlockByIDs instance, and validates it.
No errors are expected during normal operation.
func (*GetBlockByIDs) Parse ¶
func (g *GetBlockByIDs) Parse(rawIds []string) error
type GetBlockPayload ¶
type GetBlockPayload struct {
GetByIDRequest
}
func GetBlockPayloadRequest ¶
func GetBlockPayloadRequest(r *common.Request) (GetBlockPayload, error)
GetBlockPayloadRequest extracts necessary variables from the provided request, builds a GetBlockPayload instance, and validates it.
No errors are expected during normal operation.
type GetByIDRequest ¶
type GetByIDRequest struct {
ID flow.Identifier
}
func (*GetByIDRequest) Parse ¶
func (g *GetByIDRequest) Parse(rawID string) error
type GetCollection ¶
type GetCollection struct {
GetByIDRequest
ExpandsTransactions bool
}
func GetCollectionRequest ¶
func GetCollectionRequest(r *common.Request) (GetCollection, error)
GetCollectionRequest extracts necessary variables from the provided request, builds a GetCollection instance, and validates it.
No errors are expected during normal operation.
type GetEvents ¶
type GetEvents struct {
StartHeight uint64
EndHeight uint64
Type string
BlockIDs []flow.Identifier
}
func GetEventsRequest ¶
GetEventsRequest extracts necessary variables from the provided request, builds a GetEvents instance, and validates it.
No errors are expected during normal operation.
type GetExecutionResult ¶
type GetExecutionResult struct {
GetByIDRequest
}
func GetExecutionResultRequest ¶
func GetExecutionResultRequest(r *common.Request) (GetExecutionResult, error)
GetExecutionResultRequest extracts necessary variables from the provided request, builds a GetExecutionResult instance, and validates it.
No errors are expected during normal operation.
type GetExecutionResultByBlockIDs ¶
type GetExecutionResultByBlockIDs struct {
BlockIDs []flow.Identifier
}
func GetExecutionResultByBlockIDsRequest ¶
func GetExecutionResultByBlockIDsRequest(r *common.Request) (GetExecutionResultByBlockIDs, error)
GetExecutionResultByBlockIDsRequest extracts necessary variables from the provided request, builds a GetExecutionResultByBlockIDs instance, and validates it.
No errors are expected during normal operation.
func (*GetExecutionResultByBlockIDs) Build ¶
func (g *GetExecutionResultByBlockIDs) Build(r *common.Request) error
func (*GetExecutionResultByBlockIDs) Parse ¶
func (g *GetExecutionResultByBlockIDs) Parse(rawIDs []string) error
type GetScript ¶
type GetScript struct {
BlockID flow.Identifier
BlockHeight uint64
Script Script
}
func GetScriptRequest ¶
GetScriptRequest extracts necessary variables from the provided request, builds a GetScript instance, and validates it.
No errors are expected during normal operation.
type GetTransaction ¶
type GetTransaction struct {
GetByIDRequest
TransactionOptionals
ExpandsResult bool
}
func GetTransactionRequest ¶
func GetTransactionRequest(r *common.Request) (GetTransaction, error)
GetTransactionRequest extracts necessary variables from the provided request, builds a GetTransaction instance, and validates it.
No errors are expected during normal operation.
type GetTransactionResult ¶
type GetTransactionResult struct {
GetByIDRequest
TransactionOptionals
}
func GetTransactionResultRequest ¶
func GetTransactionResultRequest(r *common.Request) (GetTransactionResult, error)
GetTransactionResultRequest extracts necessary variables from the provided request, builds a GetTransactionResult instance, and validates it.
No errors are expected during normal operation.
type TransactionOptionals ¶
type TransactionOptionals struct {
BlockID flow.Identifier
CollectionID flow.Identifier
}
Source Files