Documentation
¶
Index ¶
- func DecodeContractDeploymentsCursor(raw string) (*accessmodel.ContractDeploymentsCursor, error)
- func EncodeAccountTransactionCursor(cursor *accessmodel.AccountTransactionCursor) (string, error)
- func EncodeContractDeploymentsCursor(cursor *accessmodel.ContractDeploymentsCursor) (string, error)
- func EncodeScheduledTxCursor(cursor *accessmodel.ScheduledTransactionCursor) (string, error)
- func EncodeTransferCursor(cursor *accessmodel.TransferCursor) (string, error)
- func ParseTransferCursor(raw string) (*accessmodel.TransferCursor, error)
- type GetAccountFTTransfers
- type GetAccountNFTTransfers
- type GetAccountScheduledTransactions
- type GetAccountTransactions
- type GetContract
- type GetContractDeployments
- type GetContracts
- type GetContractsByAddress
- type GetScheduledTransaction
- type GetScheduledTransactions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DecodeContractDeploymentsCursor ¶
func DecodeContractDeploymentsCursor(raw string) (*accessmodel.ContractDeploymentsCursor, error)
DecodeContractDeploymentsCursor decodes a base64url JSON string into a accessmodel.ContractDeploymentsCursor.
Expected error returns during normal operation:
- wrapped base64 or JSON decode error if the cursor is malformed.
func EncodeAccountTransactionCursor ¶
func EncodeAccountTransactionCursor(cursor *accessmodel.AccountTransactionCursor) (string, error)
EncodeAccountTransactionCursor encodes a cursor as base64-encoded JSON.
func EncodeContractDeploymentsCursor ¶
func EncodeContractDeploymentsCursor(cursor *accessmodel.ContractDeploymentsCursor) (string, error)
EncodeContractDeploymentsCursor encodes a accessmodel.ContractDeploymentsCursor as a base64url JSON string. Address and Name are included when non-empty (All/ByAddress cursors).
No error returns are expected during normal operation.
func EncodeScheduledTxCursor ¶
func EncodeScheduledTxCursor(cursor *accessmodel.ScheduledTransactionCursor) (string, error)
EncodeScheduledTxCursor encodes a cursor as base64 URL-encoded JSON.
All errors indicate the cursor is invalid.
func EncodeTransferCursor ¶
func EncodeTransferCursor(cursor *accessmodel.TransferCursor) (string, error)
EncodeTransferCursor encodes a transfer cursor as base64-encoded JSON.
All errors indicate the cursor is invalid.
func ParseTransferCursor ¶
func ParseTransferCursor(raw string) (*accessmodel.TransferCursor, error)
ParseTransferCursor decodes a base64-encoded JSON transfer cursor string.
All errors indicate the cursor is invalid.
Types ¶
type GetAccountFTTransfers ¶
type GetAccountFTTransfers struct {
Address flow.Address
Limit uint32
Cursor *accessmodel.TransferCursor
Filter extended.AccountTransferFilter
}
GetAccountFTTransfers holds the parsed request parameters for the GetAccountFungibleTokenTransfers endpoint.
func NewGetAccountFTTransfers ¶
func NewGetAccountFTTransfers(r *common.Request) (GetAccountFTTransfers, error)
NewGetAccountFTTransfers parses and validates the HTTP request for the GetAccountFungibleTokenTransfers endpoint.
All errors indicate the request is invalid.
type GetAccountNFTTransfers ¶
type GetAccountNFTTransfers struct {
Address flow.Address
Limit uint32
Cursor *accessmodel.TransferCursor
Filter extended.AccountTransferFilter
}
GetAccountNFTTransfers holds the parsed request parameters for the GetAccountNonFungibleTokenTransfers endpoint.
func NewGetAccountNFTTransfers ¶
func NewGetAccountNFTTransfers(r *common.Request) (GetAccountNFTTransfers, error)
NewGetAccountNFTTransfers parses and validates the HTTP request for the GetAccountNonFungibleTokenTransfers endpoint.
All errors indicate the request is invalid.
type GetAccountScheduledTransactions ¶
type GetAccountScheduledTransactions struct {
GetScheduledTransactions
Address flow.Address
}
GetAccountScheduledTransactions holds parsed request params for the list endpoints.
func NewGetScheduledTransactionsByAddress ¶
func NewGetScheduledTransactionsByAddress(r *common.Request) (GetAccountScheduledTransactions, error)
NewGetScheduledTransactionsByAddress parses GET /accounts/{address}/scheduled.
All errors indicate an invalid request.
type GetAccountTransactions ¶
type GetAccountTransactions struct {
Address flow.Address
Limit uint32
Cursor *accessmodel.AccountTransactionCursor
Filter extended.AccountTransactionFilter
}
GetAccountTransactions holds the parsed request parameters for the GetAccountTransactions endpoint.
func NewGetAccountTransactions ¶
func NewGetAccountTransactions(r *common.Request) (GetAccountTransactions, error)
NewGetAccountTransactions parses and validates the HTTP request for the GetAccountTransactions endpoint.
All errors indicate the request is invalid.
type GetContract ¶
type GetContract struct {
ID string
Filter extended.ContractDeploymentFilter
ExpandOptions extended.ContractDeploymentExpandOptions
}
GetContract holds parsed request params for GET /contracts/{identifier}.
func NewGetContract ¶
func NewGetContract(r *common.Request) (GetContract, error)
NewGetContract parses and validates the HTTP request for GET /contracts/{identifier}.
All errors indicate an invalid request.
type GetContractDeployments ¶
type GetContractDeployments struct {
ID string
Limit uint32
Cursor *accessmodel.ContractDeploymentsCursor
Filter extended.ContractDeploymentFilter
ExpandOptions extended.ContractDeploymentExpandOptions
}
GetContractDeployments holds parsed request params for GET /contracts/{identifier}/deployments.
func NewGetContractDeployments ¶
func NewGetContractDeployments(r *common.Request) (GetContractDeployments, error)
NewGetContractDeployments parses and validates the HTTP request for GET /contracts/{identifier}/deployments.
All errors indicate an invalid request.
type GetContracts ¶
type GetContracts struct {
Limit uint32
Cursor *accessmodel.ContractDeploymentsCursor
Filter extended.ContractDeploymentFilter
ExpandOptions extended.ContractDeploymentExpandOptions
}
GetContracts holds parsed request params for GET /contracts.
func NewGetContracts ¶
func NewGetContracts(r *common.Request) (GetContracts, error)
NewGetContracts parses and validates the HTTP request for GET /contracts.
All errors indicate an invalid request.
type GetContractsByAddress ¶
type GetContractsByAddress struct {
Address flow.Address
Limit uint32
Cursor *accessmodel.ContractDeploymentsCursor
Filter extended.ContractDeploymentFilter
ExpandOptions extended.ContractDeploymentExpandOptions
}
GetContractsByAddress holds parsed request params for GET /accounts/{address}/contracts.
func NewGetContractsByAddress ¶
func NewGetContractsByAddress(r *common.Request) (GetContractsByAddress, error)
NewGetContractsByAddress parses and validates the HTTP request for GET /accounts/{address}/contracts.
All errors indicate an invalid request.
type GetScheduledTransaction ¶
type GetScheduledTransaction struct {
ID uint64
ExpandOptions extended.ScheduledTransactionExpandOptions
}
GetScheduledTransaction holds parsed request params for the single-transaction endpoint.
func NewGetScheduledTransaction ¶
func NewGetScheduledTransaction(r *common.Request) (GetScheduledTransaction, error)
NewGetScheduledTransaction parses GET /scheduled/transaction/{id}.
All errors indicate an invalid request.
type GetScheduledTransactions ¶
type GetScheduledTransactions struct {
Limit uint32
Cursor *accessmodel.ScheduledTransactionCursor
Filter extended.ScheduledTransactionFilter
ExpandOptions extended.ScheduledTransactionExpandOptions
}
GetScheduledTransactions holds parsed request params for the list endpoints.
func NewGetScheduledTransactions ¶
func NewGetScheduledTransactions(r *common.Request) (GetScheduledTransactions, error)
NewGetScheduledTransactions parses and validates the HTTP request for GET /scheduled.
All errors indicate an invalid request.
Source Files