api

Documentation

Index

• type BlockHeaderPrintable
• type BlockPrintable
• type OutputPrintable
• type Status
• type TxKernelsPrintables

Types

type BlockHeaderPrintable

type BlockHeaderPrintable struct {
	// Hash
	Hash string `json:"hash"`
	// Version of the block
	Version uint16 `json:"version"`
	// Height of this block since the genesis block (height 0)
	Height uint64 `json:"height"`
	// Hash of the block previous to this in the chain.
	Previous string `json:"previous"`
	// Root hash of the header MMR at the previous header.
	PrevRoot string `json:"prev_root"`
	// rfc3339 timestamp at which the block was built.
	Timestamp string `json:"timestamp"`
	// Merklish root of all the commitments in the TxHashSet
	OutputRoot string `json:"output_root"`
	// Merklish root of all range proofs in the TxHashSet
	RangeProofRoot string `json:"range_proof_root"`
	// Merklish root of all transaction kernels in the TxHashSet
	KernelRoot string `json:"kernel_root"`
	// Nonce increment used to mine this block.
	Nonce uint64 `json:"nonce"`
	// Size of the cuckoo graph
	EdgeBits uint8 `json:"edge_bits"`
	// Nonces of the cuckoo solution
	CuckooSolution []uint64 `json:"cuckoo_solution"`
	// Total accumulated difficulty since genesis block
	TotalDifficulty uint64 `json:"total_difficulty"`
	// Network secondary PoW factor or factor to use
	SecondaryScaling uint64 `json:"secondary_scaling"`
	// Total kernel offset since genesis block
	TotalKernelOffset string `json:"total_kernel_offset"`
}

BlockHeaderPrintable is the header of the BlockPrintable

type BlockPrintable

type BlockPrintable struct {
	Header  BlockHeaderPrintable  `json:"header"`
	Inputs  []string              `json:"inputs"`
	Outputs []OutputPrintable     `json:"outputs"`
	Kernels []TxKernelsPrintables `json:"kernels"`
}

BlockPrintable is the result of the Grin block API

type OutputPrintable

type OutputPrintable struct {
	// The type of output Coinbase|Transaction
	OutputType string `json:"output_type"`
	// The homomorphic commitment representing the output's amount
	// (as hex string)
	Commit string `json:"commit"`
	// Whether the output has been spent
	Spent bool `json:"spent"`
	// Rangeproof (as hex string)
	Proof string `json:"proof"`
	// Rangeproof hash (as hex string)
	ProofHash   string `json:"proof_hash"`
	MerkleProof string `json:"merkle_proof"`
}

OutputPrintable represents the output of a block

type Status

type Status struct {
	ProtocolVersion int    `json:"protocol_version"`
	UserAgent       string `json:"user_agent"`
	Connections     int    `json:"connections"`
	Tip             struct {
		Height          int    `json:"height"`
		LastBlockPushed string `json:"last_block_pushed"`
		PrevBlockToLast string `json:"prev_block_to_last"`
		TotalDifficulty int    `json:"total_difficulty"`
	} `json:"tip"`
}

The Status represents various statistics about the network

type TxKernelsPrintables

type TxKernelsPrintables struct {
	Features   string `json:"features"`
	Fee        uint64 `json:"fee"`
	LockHeight uint64 `json:"lock_height"`
	Excess     string `json:"excess"`
	ExcessSig  string `json:"excess_sig"`
}

TxKernelsPrintables is the tx kernel