 Documentation
      ¶
      Documentation
      ¶
    
    
  
    
  
    Overview ¶
* Access API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Access API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Access API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Access API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Access API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Access API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Access API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Access API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Access API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Access API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Access API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Access API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Access API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Access API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Access API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Access API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Access API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Access API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Access API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Access API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Access API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Access API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Access API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Access API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
Index ¶
- Constants
- type AggregatedSignature
- type AggregatedSignatures
- type Block
- type BlockEvents
- type BlockExpandable
- type BlockHeader
- type BlockHeight
- type BlockPayload
- type BlockSeal
- type BlockSeals
- type BlockStatus
- type BlocksEvents
- type Chunk
- type Collection
- type CollectionExpandable
- type CollectionGuarantee
- type CollectionGuarantees
- type Event
- type Events
- type ExecutionResult
- type LinkFunc
- type LinkGenerator
- type LinkGeneratorImpl
- func (generator *LinkGeneratorImpl) AccountLink(address string) (string, error)
- func (generator *LinkGeneratorImpl) BlockLink(id flow.Identifier) (string, error)
- func (generator *LinkGeneratorImpl) CollectionLink(id flow.Identifier) (string, error)
- func (generator *LinkGeneratorImpl) ExecutionResultLink(id flow.Identifier) (string, error)
- func (generator *LinkGeneratorImpl) PayloadLink(id flow.Identifier) (string, error)
- func (generator *LinkGeneratorImpl) TransactionLink(id flow.Identifier) (string, error)
- func (generator *LinkGeneratorImpl) TransactionResultLink(id flow.Identifier) (string, error)
 
- type Links
- type ModelError
- type ProposalKey
- type Transaction
- type TransactionExecution
- type TransactionExpandable
- type TransactionResult
- type TransactionSignature
- type TransactionSignatures
- type TransactionStatus
- type Transactions
Constants ¶
const ( PENDING = PENDING_TransactionStatus FINALIZED = FINALIZED_TransactionStatus EXECUTED = EXECUTED_TransactionStatus SEALED = SEALED_TransactionStatus EXPIRED = EXPIRED_TransactionStatus )
const ( PENDING_RESULT = PENDING_TransactionExecution SUCCESS_RESULT = SUCCESS_TransactionExecution FAILURE_RESULT = FAILURE_TransactionExecution )
const ( BLOCK_UNKNOWN = UNKNOWN_BlockStatus BLOCK_FINALIZED = FINALIZED_BlockStatus BLOCK_SEALED = SEALED_BlockStatus )
const ExpandableExecutionResult = "execution_result"
    const ExpandableFieldPayload = "payload"
    const ExpandsTransactions = "transactions"
    Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AggregatedSignature ¶
type AggregatedSignature struct {
	VerifierSignatures []string `json:"verifier_signatures"`
	SignerIds          []string `json:"signer_ids"`
}
    func (*AggregatedSignature) Build ¶
func (a *AggregatedSignature) Build(signature flow.AggregatedSignature)
type AggregatedSignatures ¶
type AggregatedSignatures []AggregatedSignature
func (*AggregatedSignatures) Build ¶
func (a *AggregatedSignatures) Build(signatures []flow.AggregatedSignature)
type Block ¶
type Block struct {
	Header          *BlockHeader     `json:"header"`
	Payload         *BlockPayload    `json:"payload,omitempty"`
	ExecutionResult *ExecutionResult `json:"execution_result,omitempty"`
	Expandable      *BlockExpandable `json:"_expandable,omitempty"`
	Links           *Links           `json:"_links,omitempty"`
	BlockStatus     *BlockStatus     `json:"block_status"`
}
    func NewBlock ¶ added in v0.40.0
func NewBlock( block *flow.Block, execResult *flow.ExecutionResult, link LinkGenerator, blockStatus flow.BlockStatus, expand map[string]bool, ) (*Block, error)
func (*Block) Build ¶
func (b *Block) Build( block *flow.Block, execResult *flow.ExecutionResult, link LinkGenerator, blockStatus flow.BlockStatus, expand map[string]bool, ) error
type BlockEvents ¶
type BlockEvents struct {
	BlockId        string    `json:"block_id,omitempty"`
	BlockHeight    string    `json:"block_height,omitempty"`
	BlockTimestamp time.Time `json:"block_timestamp,omitempty"`
	Events         []Event   `json:"events,omitempty"`
	Links          *Links    `json:"_links,omitempty"`
}
    func (*BlockEvents) Build ¶
func (b *BlockEvents) Build(blockEvents flow.BlockEvents)
type BlockExpandable ¶
type BlockHeader ¶
type BlockHeader struct {
	Id                   string    `json:"id"`
	ParentId             string    `json:"parent_id"`
	Height               string    `json:"height"`
	Timestamp            time.Time `json:"timestamp"`
	ParentVoterSignature string    `json:"parent_voter_signature"`
}
    func NewBlockHeader ¶ added in v0.40.0
func NewBlockHeader(header *flow.Header) *BlockHeader
func (*BlockHeader) Build ¶
func (b *BlockHeader) Build(header *flow.Header)
type BlockHeight ¶
type BlockHeight struct {
}
    type BlockPayload ¶
type BlockPayload struct {
	CollectionGuarantees []CollectionGuarantee `json:"collection_guarantees"`
	BlockSeals           []BlockSeal           `json:"block_seals"`
}
    type BlockSeal ¶
type BlockSeal struct {
	BlockId                      string                `json:"block_id"`
	ResultId                     string                `json:"result_id"`
	FinalState                   string                `json:"final_state"`
	AggregatedApprovalSignatures []AggregatedSignature `json:"aggregated_approval_signatures"`
}
    type BlockSeals ¶
type BlockSeals []BlockSeal
type BlockStatus ¶ added in v0.39.0
type BlockStatus string
BlockStatus : This value indicates the status of a block.
const ( UNKNOWN_BlockStatus BlockStatus = "BLOCK_UNKNOWN" FINALIZED_BlockStatus BlockStatus = "BLOCK_FINALIZED" SEALED_BlockStatus BlockStatus = "BLOCK_SEALED" )
List of BlockStatus
func (*BlockStatus) Build ¶ added in v0.39.0
func (b *BlockStatus) Build(status flow.BlockStatus)
type BlocksEvents ¶
type BlocksEvents []BlockEvents
func (*BlocksEvents) Build ¶
func (b *BlocksEvents) Build(blocksEvents []flow.BlockEvents)
type Chunk ¶
type Chunk struct {
	CollectionIndex      string `json:"collection_index"`
	StartState           string `json:"start_state"`
	EventCollection      string `json:"event_collection"`
	BlockId              string `json:"block_id"`
	TotalComputationUsed string `json:"total_computation_used"`
	NumberOfTransactions string `json:"number_of_transactions"`
	Index                string `json:"index"`
	EndState             string `json:"end_state"`
}
    type Collection ¶
type Collection struct {
	Id           string                `json:"id"`
	Transactions []Transaction         `json:"transactions,omitempty"`
	Expandable   *CollectionExpandable `json:"_expandable"`
	Links        *Links                `json:"_links,omitempty"`
}
    func (*Collection) Build ¶
func (c *Collection) Build( collection *flow.LightCollection, txs []*flow.TransactionBody, link LinkGenerator, expand map[string]bool) error
type CollectionExpandable ¶
type CollectionExpandable struct {
	Transactions []string `json:"transactions,omitempty"`
}
    type CollectionGuarantee ¶
type CollectionGuarantee struct {
	CollectionId     string `json:"collection_id"`
	SignerIndices    string `json:"signer_indices"`
	Signature        string `json:"signature"`
	ReferenceBlockID string `json:"reference_block_id"`
	ClusterChainID   string `json:"cluster_chain_id"`
}
    func (*CollectionGuarantee) Build ¶
func (c *CollectionGuarantee) Build(guarantee *flow.CollectionGuarantee)
type CollectionGuarantees ¶
type CollectionGuarantees []CollectionGuarantee
func (*CollectionGuarantees) Build ¶
func (c *CollectionGuarantees) Build(guarantees []*flow.CollectionGuarantee)
type Event ¶
type ExecutionResult ¶
type ExecutionResult struct {
	Id               string  `json:"id"`
	BlockId          string  `json:"block_id"`
	Events           []Event `json:"events"`
	Chunks           []Chunk `json:"chunks,omitempty"`
	PreviousResultId string  `json:"previous_result_id"`
	Links            *Links  `json:"_links,omitempty"`
}
    func (*ExecutionResult) Build ¶
func (e *ExecutionResult) Build( exeResult *flow.ExecutionResult, link LinkGenerator, ) error
type LinkGenerator ¶
type LinkGenerator interface {
	BlockLink(id flow.Identifier) (string, error)
	TransactionLink(id flow.Identifier) (string, error)
	TransactionResultLink(id flow.Identifier) (string, error)
	PayloadLink(id flow.Identifier) (string, error)
	ExecutionResultLink(id flow.Identifier) (string, error)
	AccountLink(address string) (string, error)
	CollectionLink(id flow.Identifier) (string, error)
}
    LinkGenerator generates the expandable value for the known endpoints e.g. "/v1/blocks/c5e935bc75163db82e4a6cf9dc3b54656709d3e21c87385138300abd479c33b7"
type LinkGeneratorImpl ¶
type LinkGeneratorImpl struct {
	// contains filtered or unexported fields
}
    func NewLinkGeneratorImpl ¶
func NewLinkGeneratorImpl(router *mux.Router) *LinkGeneratorImpl
func (*LinkGeneratorImpl) AccountLink ¶
func (generator *LinkGeneratorImpl) AccountLink(address string) (string, error)
func (*LinkGeneratorImpl) BlockLink ¶
func (generator *LinkGeneratorImpl) BlockLink(id flow.Identifier) (string, error)
func (*LinkGeneratorImpl) CollectionLink ¶
func (generator *LinkGeneratorImpl) CollectionLink(id flow.Identifier) (string, error)
func (*LinkGeneratorImpl) ExecutionResultLink ¶
func (generator *LinkGeneratorImpl) ExecutionResultLink(id flow.Identifier) (string, error)
func (*LinkGeneratorImpl) PayloadLink ¶
func (generator *LinkGeneratorImpl) PayloadLink(id flow.Identifier) (string, error)
func (*LinkGeneratorImpl) TransactionLink ¶
func (generator *LinkGeneratorImpl) TransactionLink(id flow.Identifier) (string, error)
func (*LinkGeneratorImpl) TransactionResultLink ¶
func (generator *LinkGeneratorImpl) TransactionResultLink(id flow.Identifier) (string, error)
type Links ¶
type Links struct {
	Self string `json:"_self,omitempty"`
}
    type ModelError ¶
type ProposalKey ¶
type ProposalKey struct {
	Address        string `json:"address"`
	KeyIndex       string `json:"key_index"`
	SequenceNumber string `json:"sequence_number"`
}
    func (*ProposalKey) Build ¶
func (p *ProposalKey) Build(key flow.ProposalKey)
type Transaction ¶
type Transaction struct {
	Id string `json:"id"`
	// Base64 encoded Cadence script.
	Script string `json:"script"`
	// Array of Base64 encoded arguments with in [JSON-Cadence interchange format](https://docs.onflow.org/cadence/json-cadence-spec/).
	Arguments        []string `json:"arguments"`
	ReferenceBlockId string   `json:"reference_block_id"`
	// The limit on the amount of computation a transaction is allowed to preform.
	GasLimit           string                 `json:"gas_limit"`
	Payer              string                 `json:"payer"`
	ProposalKey        *ProposalKey           `json:"proposal_key"`
	Authorizers        []string               `json:"authorizers"`
	PayloadSignatures  []TransactionSignature `json:"payload_signatures"`
	EnvelopeSignatures []TransactionSignature `json:"envelope_signatures"`
	Result             *TransactionResult     `json:"result,omitempty"`
	Expandable         *TransactionExpandable `json:"_expandable"`
	Links              *Links                 `json:"_links,omitempty"`
}
    func (*Transaction) Build ¶
func (t *Transaction) Build(tx *flow.TransactionBody, txr *accessmodel.TransactionResult, link LinkGenerator)
type TransactionExecution ¶
type TransactionExecution string
TransactionExecution : This value indicates whether the transaction execution succeded or not, this value should be checked when determining transaction success.
const ( PENDING_TransactionExecution TransactionExecution = "Pending" SUCCESS_TransactionExecution TransactionExecution = "Success" FAILURE_TransactionExecution TransactionExecution = "Failure" )
List of TransactionExecution
func (*TransactionExecution) Build ¶
func (t *TransactionExecution) Build(result *accessmodel.TransactionResult)
type TransactionExpandable ¶
type TransactionExpandable struct {
	Result string `json:"result,omitempty"`
}
    type TransactionResult ¶
type TransactionResult struct {
	BlockId      string                `json:"block_id"`
	CollectionId string                `json:"collection_id"`
	Execution    *TransactionExecution `json:"execution,omitempty"`
	Status       *TransactionStatus    `json:"status"`
	StatusCode   int32                 `json:"status_code"`
	// Provided transaction error in case the transaction wasn't successful.
	ErrorMessage    string  `json:"error_message"`
	ComputationUsed string  `json:"computation_used"`
	Events          []Event `json:"events"`
	Links           *Links  `json:"_links,omitempty"`
}
    func (*TransactionResult) Build ¶
func (t *TransactionResult) Build(txr *accessmodel.TransactionResult, txID flow.Identifier, link LinkGenerator)
type TransactionSignature ¶
type TransactionSignature struct {
	Address       string `json:"address"`
	KeyIndex      string `json:"key_index"`
	Signature     string `json:"signature"`
	ExtensionData string `json:"extension_data,omitempty"`
}
    func (*TransactionSignature) Build ¶
func (t *TransactionSignature) Build(sig flow.TransactionSignature)
type TransactionSignatures ¶
type TransactionSignatures []TransactionSignature
func (*TransactionSignatures) Build ¶
func (t *TransactionSignatures) Build(signatures []flow.TransactionSignature)
type TransactionStatus ¶
type TransactionStatus string
TransactionStatus : This value indicates the state of the transaction execution. Only sealed and expired are final and immutable states.
const ( PENDING_TransactionStatus TransactionStatus = "Pending" FINALIZED_TransactionStatus TransactionStatus = "Finalized" EXECUTED_TransactionStatus TransactionStatus = "Executed" SEALED_TransactionStatus TransactionStatus = "Sealed" EXPIRED_TransactionStatus TransactionStatus = "Expired" )
List of TransactionStatus
func (*TransactionStatus) Build ¶
func (t *TransactionStatus) Build(status flow.TransactionStatus)
type Transactions ¶
type Transactions []Transaction
func (*Transactions) Build ¶
func (t *Transactions) Build(transactions []*flow.TransactionBody, link LinkGenerator)
       Source Files
      ¶
      Source Files
      ¶
    
- block.go
- collection.go
- enums.go
- event.go
- execution_result.go
- link.go
- model_aggregated_signature.go
- model_block.go
- model_block__expandable.go
- model_block_events.go
- model_block_header.go
- model_block_height.go
- model_block_payload.go
- model_block_seal.go
- model_block_status.go
- model_chunk.go
- model_collection.go
- model_collection__expandable.go
- model_collection_guarantee.go
- model_error.go
- model_event.go
- model_execution_result.go
- model_links.go
- model_proposal_key.go
- model_transaction.go
- model_transaction__expandable.go
- model_transaction_execution.go
- model_transaction_result.go
- model_transaction_signature.go
- model_transaction_status.go
- transaction.go