models

package

v0.38.0 Latest Latest Go to latest Published: Mar 30, 2023 License: Apache-2.0 Imports: 1 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/onflow/flow-go-sdk

Links

Open Source Insights

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)

Index ¶

type Account
type AccountExpandable
type AccountPublicKey
type AggregatedSignature
type Block
type BlockEvents
type BlockExpandable
type BlockHeader
type BlockHeight
type BlockPayload
type BlockSeal
type Chunk
type Collection
type CollectionExpandable
type CollectionGuarantee
type Event
type ExecutionResult
type HashingAlgorithm
type InlineResponse200
type Links
type ModelError
type OneOfBlockHeight
type ProposalKey
type ScriptsBody
type SigningAlgorithm
type Transaction
type TransactionExecution
type TransactionExpandable
type TransactionResult
type TransactionSignature
type TransactionStatus
type TransactionsBody

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Account ¶

type Account struct {
	Address string `json:"address"`
	// Flow balance of the account.
	Balance    string             `json:"balance"`
	Keys       []AccountPublicKey `json:"keys,omitempty"`
	Contracts  map[string]string  `json:"contracts,omitempty"`
	Expandable *AccountExpandable `json:"_expandable"`
	Links      *Links             `json:"_links,omitempty"`
}

type AccountExpandable ¶

type AccountExpandable struct {
	Keys      string `json:"keys,omitempty"`
	Contracts string `json:"contracts,omitempty"`
}

type AccountPublicKey ¶

type AccountPublicKey struct {
	// Index of the public key.
	Index string `json:"index"`
	// Hex encoded public key.
	PublicKey        string            `json:"public_key"`
	SigningAlgorithm *SigningAlgorithm `json:"signing_algorithm"`
	HashingAlgorithm *HashingAlgorithm `json:"hashing_algorithm"`
	// Current account sequence number.
	SequenceNumber string `json:"sequence_number"`
	// Weight of the key.
	Weight string `json:"weight"`
	// Flag indicating whether the key is active or not.
	Revoked bool `json:"revoked"`
}

type AggregatedSignature ¶

type AggregatedSignature struct {
	VerifierSignatures []string `json:"verifier_signatures"`
	SignerIds          []string `json:"signer_ids"`
}

type Block ¶

type Block struct {
	Header          *BlockHeader     `json:"header"`
	Payload         *BlockPayload    `json:"payload,omitempty"`
	ExecutionResult *ExecutionResult `json:"execution_result,omitempty"`
	Expandable      *BlockExpandable `json:"_expandable"`
	Links           *Links           `json:"_links,omitempty"`
	BlockStatus     string           `json:"block_status"`
}

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"`
}

type BlockExpandable ¶

type BlockExpandable struct {
	Payload         string `json:"payload,omitempty"`
	ExecutionResult string `json:"execution_result,omitempty"`
}

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"`
}

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 Chunk ¶

type Chunk struct {
	BlockId              string `json:"block_id"`
	CollectionIndex      string `json:"collection_index"`
	StartState           string `json:"start_state"`
	EndState             string `json:"end_state"`
	EventCollection      string `json:"event_collection"`
	Index                string `json:"index"`
	NumberOfTransactions string `json:"number_of_transactions"`
	TotalComputationUsed string `json:"total_computation_used"`
}

type Collection ¶

type Collection struct {
	Id           string                `json:"id"`
	Transactions []Transaction         `json:"transactions,omitempty"`
	Expandable   *CollectionExpandable `json:"_expandable"`
	Links        *Links                `json:"_links,omitempty"`
}

type CollectionExpandable ¶

type CollectionExpandable struct {
	Transactions []string `json:"transactions,omitempty"`
}

type CollectionGuarantee ¶

type CollectionGuarantee struct {
	CollectionId string   `json:"collection_id"`
	SignerIds    []string `json:"signer_ids"`
	Signature    string   `json:"signature"`
}

type Event ¶

type Event struct {
	Type_            string `json:"type"`
	TransactionId    string `json:"transaction_id"`
	TransactionIndex string `json:"transaction_index"`
	EventIndex       string `json:"event_index"`
	Payload          string `json:"payload"`
}

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"`
}

type HashingAlgorithm ¶

type HashingAlgorithm string

const (
	SHA2_256_HashingAlgorithm HashingAlgorithm = "SHA2_256"
	SHA2_384_HashingAlgorithm HashingAlgorithm = "SHA2_384"
	SHA3_256_HashingAlgorithm HashingAlgorithm = "SHA3_256"
	SHA3_384_HashingAlgorithm HashingAlgorithm = "SHA3_384"
	KMAC128_HashingAlgorithm  HashingAlgorithm = "KMAC128"
)

List of HashingAlgorithm

type InlineResponse200 ¶

type InlineResponse200 struct {
	Value string `json:"value,omitempty"`
}

type Links ¶

type Links struct {
	Self string `json:"_self,omitempty"`
}

type ModelError ¶

type ModelError struct {
	Code    int32  `json:"code,omitempty"`
	Message string `json:"message,omitempty"`
}

type OneOfBlockHeight ¶

type OneOfBlockHeight struct {
}

type ProposalKey ¶

type ProposalKey struct {
	Address        string `json:"address"`
	KeyIndex       string `json:"key_index"`
	SequenceNumber string `json:"sequence_number"`
}

type ScriptsBody ¶

type ScriptsBody struct {
	// Base64 encoded content of the Cadence script.
	Script string `json:"script,omitempty"`
	// An list of arguments each encoded as Base64 passed in the [JSON-Cadence interchange format](https://docs.onflow.org/cadence/json-cadence-spec/).
	Arguments []string `json:"arguments,omitempty"`
}

type SigningAlgorithm ¶

type SigningAlgorithm string

const (
	BLSBLS12381_SigningAlgorithm     SigningAlgorithm = "BLSBLS12381"
	ECDSAP256_SigningAlgorithm       SigningAlgorithm = "ECDSAP256"
	ECDSA_SECP256K1_SigningAlgorithm SigningAlgorithm = "ECDSASecp256k1"
)

List of SigningAlgorithm

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"`
}

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

type TransactionExpandable ¶

type TransactionExpandable struct {
	Result string `json:"result,omitempty"`
}

type TransactionResult ¶

type TransactionResult struct {
	BlockId    string                `json:"block_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"`
}

type TransactionSignature ¶

type TransactionSignature struct {
	Address   string `json:"address"`
	KeyIndex  string `json:"key_index"`
	Signature string `json:"signature"`
}

Base64 encoded signature.

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

type TransactionsBody ¶

type TransactionsBody struct {
	// Base64 encoded content of the Cadence script.
	Script string `json:"script"`
	// A list of arguments each encoded as Base64 passed in the [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"`
	// A list of Base64 encoded signatures.
	PayloadSignatures []TransactionSignature `json:"payload_signatures"`
	// A list of Base64 encoded signatures.
	EnvelopeSignatures []TransactionSignature `json:"envelope_signatures"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL