blockchain

Documentation

Overview

Package blockchain provides functions to access various blockchain data.

Index

• func GetHeight() int
• func GetTransactionFromBlock(heightOrHash interface{}, index int) interop.Hash256
• func GetTransactionHeight(hash interop.Hash256) int
• type Block
  • func GetBlock(heightOrHash interface{}) *Block
• type Transaction
  • func GetTransaction(hash interop.Hash256) *Transaction

Functions

func GetHeight

func GetHeight() int

GetHeight returns current block height (index of the last accepted block). Note that when transaction is being run as a part of new block this block is considered as not yet accepted (persisted) and thus you'll get an index of the previous (already accepted) block. This function uses `System.Blockchain.GetHeight` syscall.

func GetTransactionFromBlock

func GetTransactionFromBlock(heightOrHash interface{}, index int) interop.Hash256

GetTransactionFromBlock returns transaction hash (256 bit in BE format represented as a slice of 32 bytes) from the block found by the given hash or index (with the same encoding as for GetHeader) by its index. This function uses `System.Blockchain.GetTransactionFromBlock` syscall.

func GetTransactionHeight

func GetTransactionHeight(hash interop.Hash256) int

GetTransactionHeight returns transaction's height (index of the block that includes it) by the given ID (256 bit in BE format represented as a slice of 32 bytes). This function uses `System.Blockchain.GetTransactionHeight` syscall.

Types

type Block

type Block struct {
	// Hash represents the hash (256 bit BE value in a 32 byte slice) of the
	// given block.
	Hash interop.Hash256
	// Version of the block.
	Version int
	// PrevHash represents the hash (256 bit BE value in a 32 byte slice) of the
	// previous block.
	PrevHash interop.Hash256
	// MerkleRoot represents the root hash (256 bit BE value in a 32 byte slice)
	// of a transaction list.
	MerkleRoot interop.Hash256
	// Timestamp represents millisecond-precision block timestamp.
	Timestamp int
	// Index represents the height of the block.
	Index int
	// NextConsensus represents contract address of the next miner (160 bit BE
	// value in a 20 byte slice).
	NextConsensus interop.Hash160
	// TransactionsLength represents the length of block's transactions array.
	TransactionsLength int
}

Block represents a NEO block, it's a data structure that you can get block-related data from. It's similar to the Block class in the Neo .net framework. To use it you need to get it via GetBlock function call.

func GetBlock

func GetBlock(heightOrHash interface{}) *Block

GetBlock returns block found by the given hash or index (with the same encoding as for GetHeader). This function uses `System.Blockchain.GetBlock` syscall.

type Transaction

type Transaction struct {
	// Hash represents the hash (256 bit BE value in a 32 byte slice) of the
	// given transaction (which also is its ID).
	Hash interop.Hash256
	// Version represents the transaction version.
	Version int
	// Nonce is a random number to avoid hash collision.
	Nonce int
	// Sender represents the sender (160 bit BE value in a 20 byte slice) of the
	// given Transaction.
	Sender interop.Hash160
	// SysFee represents fee to be burned.
	SysFee int
	// NetFee represents fee to be distributed to consensus nodes.
	NetFee int
	// ValidUntilBlock is the maximum blockchain height exceeding which
	// transaction should fail verification.
	ValidUntilBlock int
	// Script represents code to run in NeoVM for this transaction.
	Script []byte
}

Transaction represents a NEO transaction. It's similar to Transaction class in Neo .net framework.

func GetTransaction

func GetTransaction(hash interop.Hash256) *Transaction

GetTransaction returns transaction found by the given hash (256 bit in BE format represented as a slice of 32 bytes). This function uses `System.Blockchain.GetTransaction` syscall.