klaytn: github.com/klaytn/klaytn Index | Files | Directories

package klaytn

import "github.com/klaytn/klaytn"

Package klaytn defines interfaces for interacting with Klaytn.


Package Files



var NotFound = errors.New("not found")

NotFound is returned by API methods if the requested item does not exist.

type CallMsg Uses

type CallMsg struct {
    From     common.Address  // the sender of the 'transaction'
    To       *common.Address // the destination contract (nil for contract creation)
    Gas      uint64          // if 0, the call executes with near-infinite gas
    GasPrice *big.Int        // peb <-> gas exchange ratio
    Value    *big.Int        // amount of peb sent along with the call
    Data     []byte          // input data, usually an ABI-encoded contract method invocation

CallMsg contains parameters for contract calls.

type ChainReader Uses

type ChainReader interface {
    BlockByHash(ctx context.Context, hash common.Hash) (*types.Block, error)
    BlockByNumber(ctx context.Context, number *big.Int) (*types.Block, error)
    HeaderByHash(ctx context.Context, hash common.Hash) (*types.Header, error)
    HeaderByNumber(ctx context.Context, number *big.Int) (*types.Header, error)
    TransactionCount(ctx context.Context, blockHash common.Hash) (uint, error)
    TransactionInBlock(ctx context.Context, blockHash common.Hash, index uint) (*types.Transaction, error)

    // This method subscribes to notifications about changes of the head block of
    // the canonical chain.
    SubscribeNewHead(ctx context.Context, ch chan<- *types.Header) (Subscription, error)

ChainReader provides access to the blockchain. The methods in this interface access raw data from either the canonical chain (when requesting by block number) or any blockchain fork that was previously downloaded and processed by the node. The block number argument can be nil to select the latest canonical block. Reading block headers should be preferred over full blocks whenever possible.

The returned error is NotFound if the requested item does not exist.

type ChainStateReader Uses

type ChainStateReader interface {
    BalanceAt(ctx context.Context, account common.Address, blockNumber *big.Int) (*big.Int, error)
    StorageAt(ctx context.Context, account common.Address, key common.Hash, blockNumber *big.Int) ([]byte, error)
    CodeAt(ctx context.Context, account common.Address, blockNumber *big.Int) ([]byte, error)
    NonceAt(ctx context.Context, account common.Address, blockNumber *big.Int) (uint64, error)

ChainStateReader wraps access to the state trie of the canonical blockchain. Note that implementations of the interface may be unable to return state values for old blocks. In many cases, using CallContract can be preferable to reading raw contract storage.

type ChainSyncReader Uses

type ChainSyncReader interface {
    SyncProgress(ctx context.Context) (*SyncProgress, error)

ChainSyncReader wraps access to the node's current sync status. If there's no sync currently running, it returns nil.

type ContractCaller Uses

type ContractCaller interface {
    CallContract(ctx context.Context, call CallMsg, blockNumber *big.Int) ([]byte, error)

A ContractCaller provides contract calls, essentially transactions that are executed by the EVM but not mined into the blockchain. ContractCall is a low-level method to execute such calls. For applications which are structured around specific contracts, the abigen tool provides a nicer, properly typed way to perform calls.

type FilterQuery Uses

type FilterQuery struct {
    FromBlock *big.Int         // beginning of the queried range, nil means genesis block
    ToBlock   *big.Int         // end of the range, nil means latest block
    Addresses []common.Address // restricts matches to events created by specific contracts

    // The Topic list restricts matches to particular event topics. Each event has a list
    // of topics. Topics matches a prefix of that list. An empty element slice matches any
    // topic. Non-empty elements represent an alternative that matches any of the
    // contained topics.
    // Examples:
    // {} or nil          matches any topic list
    // {{A}}              matches topic A in first position
    // {{}, {B}}          matches any topic in first position, B in second position
    // {{A}}, {B}}        matches topic A in first position, B in second position
    // {{A, B}}, {C, D}}  matches topic (A OR B) in first position, (C OR D) in second position
    Topics [][]common.Hash

FilterQuery contains options for contract log filtering.

type GasEstimator Uses

type GasEstimator interface {
    EstimateGas(ctx context.Context, call CallMsg) (uint64, error)

GasEstimator wraps EstimateGas, which tries to estimate the gas needed to execute a specific transaction based on the pending state. There is no guarantee that this is the true gas limit requirement as other transactions may be added or removed by miners, but it should provide a basis for setting a reasonable default.

type GasPricer Uses

type GasPricer interface {
    SuggestGasPrice(ctx context.Context) (*big.Int, error)

GasPricer wraps the gas price oracle, which monitors the blockchain to determine the optimal gas price given current fee market conditions.

type LogFilterer Uses

type LogFilterer interface {
    FilterLogs(ctx context.Context, q FilterQuery) ([]types.Log, error)
    SubscribeFilterLogs(ctx context.Context, q FilterQuery, ch chan<- types.Log) (Subscription, error)

LogFilterer provides access to contract log events using a one-off query or continuous event subscription.

Logs received through a streaming query subscription may have Removed set to true, indicating that the log was reverted due to a chain reorganisation.

type PendingContractCaller Uses

type PendingContractCaller interface {
    PendingCallContract(ctx context.Context, call CallMsg) ([]byte, error)

PendingContractCaller can be used to perform calls against the pending state.

type PendingStateEventer Uses

type PendingStateEventer interface {
    SubscribePendingTransactions(ctx context.Context, ch chan<- *types.Transaction) (Subscription, error)

A PendingStateEventer provides access to real time notifications about changes to the pending state.

type PendingStateReader Uses

type PendingStateReader interface {
    PendingBalanceAt(ctx context.Context, account common.Address) (*big.Int, error)
    PendingStorageAt(ctx context.Context, account common.Address, key common.Hash) ([]byte, error)
    PendingCodeAt(ctx context.Context, account common.Address) ([]byte, error)
    PendingNonceAt(ctx context.Context, account common.Address) (uint64, error)
    PendingTransactionCount(ctx context.Context) (uint, error)

A PendingStateReader provides access to the pending state, which is the result of all known executable transactions which have not yet been included in the blockchain. It is commonly used to display the result of ’unconfirmed’ actions (e.g. wallet value transfers) initiated by the user. The PendingNonceAt operation is a good way to retrieve the next available transaction nonce for a specific account.

type Subscription Uses

type Subscription interface {
    // Unsubscribe cancels the sending of events to the data channel
    // and closes the error channel.
    // Err returns the subscription error channel. The error channel receives
    // a value if there is an issue with the subscription (e.g. the network connection
    // delivering the events has been closed). Only one value will ever be sent.
    // The error channel is closed by Unsubscribe.
    Err() <-chan error

Subscription represents an event subscription where events are delivered on a data channel.

type SyncProgress Uses

type SyncProgress struct {
    StartingBlock uint64 // Block number where sync began
    CurrentBlock  uint64 // Current block number where sync is at
    HighestBlock  uint64 // Highest alleged block number in the chain
    PulledStates  uint64 // Number of state trie entries already downloaded
    KnownStates   uint64 // Total number of state trie entries known about

SyncProgress gives progress indications when the node is synchronising with the Klaytn network.

type TransactionReader Uses

type TransactionReader interface {
    // TransactionByHash checks the pool of pending transactions in addition to the
    // blockchain. The isPending return value indicates whether the transaction has been
    // mined yet. Note that the transaction may not be part of the canonical chain even if
    // it's not pending.
    TransactionByHash(ctx context.Context, txHash common.Hash) (tx *types.Transaction, isPending bool, err error)
    // TransactionReceipt returns the receipt of a mined transaction. Note that the
    // transaction may not be included in the current canonical chain even if a receipt
    // exists.
    TransactionReceipt(ctx context.Context, txHash common.Hash) (*types.Receipt, error)

TransactionReader provides access to past transactions and their receipts. Implementations may impose arbitrary restrictions on the transactions and receipts that can be retrieved. Historic transactions may not be available.

Avoid relying on this interface if possible. Contract logs (through the LogFilterer interface) are more reliable and usually safer in the presence of chain reorganisations.

The returned error is NotFound if the requested item does not exist.

type TransactionSender Uses

type TransactionSender interface {
    SendTransaction(ctx context.Context, tx *types.Transaction) error

TransactionSender wraps transaction sending. The SendTransaction method injects a signed transaction into the pending transaction pool for execution. If the transaction was a contract creation, the TransactionReceipt method can be used to retrieve the contract address after the transaction has been mined.

The transaction must be signed and have a valid nonce to be included. Consumers of the API can use package accounts to maintain local private keys and need can retrieve the next available nonce using PendingNonceAt.


accountsPackage accounts implements high level Klaytn account management.
accounts/abiPackage abi implements the Klaytn ABI (Application Binary Interface).
accounts/abi/bindPackage bind generates Go bindings for Klaytn contracts.
accounts/abi/bind/backendsPackage backends implements simulated bind contract backend for testing contract bindings.
accounts/keystorePackage keystore implements encrypted storage of secp256k1 private keys.
accounts/mocksPackage mock_accounts is a generated GoMock package.
apiPackage api implements the general Klaytn API functions.
api/debugPackage debug provides interfaces for Go runtime debugging facilities.
api/mocksPackage mock_api is a generated GoMock package.
blockchainPackage blockchain implements the canonical chain and the state transition model of Klaytn.
blockchain/asmPackage asm provides support for dealing with EVM assembly instructions (e.g., disassembling them).
blockchain/bloombitsPackage bloombits implements bloom filtering on batches of data.
blockchain/statePackage state provides an uppermost caching layer of the Klaytn state trie.
blockchain/typesPackage types contains data types related to Klatyn consensus.
blockchain/types/accountPackage account implements Account used in Klaytn.
blockchain/types/accountkeyPackage accountkey implements the AccountKey used in Klaytn.
blockchain/vmPackage vm implements the Ethereum Virtual Machine.
blockchain/vm/runtimePackage runtime provides a basic execution model for executing EVM code.
clientPackage client provides a client for the Klaytn RPC API.
cmd/abigenabigen is a command line interface to generate a Go binding from a contract's ABI or bytecode.
cmd/homihomi is a command line interface which helps to create configuration files for a new network homi supports various options for different deployment modes, number of nodes, etc.
cmd/homi/commoncommon package provides utility functions to generate random keys and random directory
cmd/homi/dockerdocker package contains service packages which are to be used to create a docker-compose.yml with given options docker support is enabled by default when using `setup` command and can be set explicitly by giving `docker` as a type argument
cmd/homi/docker/composecompose package provides homi object which is to be used to create a docker-compose.yml
cmd/homi/docker/serviceservice package provides various templates to build a docker-compose.yml
cmd/homi/extraextra defines options for homi's extra command It supports encoding and decoding of extra data in genesis.json file
cmd/homi/genesisgenesis package provides utility functions to generate new genesis file to init a chain
cmd/homi/setupsetup package generates config files following the given deployment options.
cmd/kbnkbn runs a bootstrap node for the Klaytn Node Discovery Protocol.
cmd/kcnkcn is the command-line client for Klaytn Consensus Node.
cmd/kenken is the command-line client for Klaytn Endpoint Node.
cmd/kgenkgen can be used to generate a nodekey and a derived address and kni information.
cmd/kpnkpn is the command-line client for Klaytn Proxy Node.
cmd/kscnkscn is the command-line client for Klaytn ServiceChain Consensus Node.
cmd/ksenksen is the command-line client for Klaytn ServiceChain Endpoint Node.
cmd/kspnkspn is the command-line client for Klaytn ServiceChain Proxy Node.
cmd/utilsPackage utils contains internal helper functions for klaytn commands.
cmd/utils/nodecmdPackage nodecmd contains command definitions and related functions used for node cmds, such as kcn, kpn, and ken.
commonPackage common contains various helper functions, commonly used data types and constants.
common/bitutilPackage bitutil implements fast bitwise operations and compression/decompressions.
common/compilerPackage compiler wraps the Solidity compiler executable (solc).
common/fdlimitPackage fdlimit handles file descriptors based on the operating system.
common/hexutilPackage hexutil implements hex encoding with 0x prefix.
common/mathPackage math provides convenience functions to use big.Int and to parse a string into an integer.
common/mclockPackage mclock is a wrapper for a monotonic clock source.
common/profilePackage profile provides a profiler which can store a key and related TimeRecord.
consensusPackage consensus defines interfaces for consensus engines and ChainReader.
consensus/cliquePackage clique implements PoA (Proof of Authority) consensus engine which is mainly for private chains.
consensus/gxhashPackage gxhash implements the gxhash proof-of-work consensus engine.
consensus/istanbulPackage istanbul is a BFT based consensus engine which implements consensus/Engine interface.
consensus/istanbul/backendPackage backend defines backend struct which implements Backend interface of Istanbul consensus engine.
consensus/istanbul/corePackage core implements the core functionality of Istanbul consensus engine.
consensus/istanbul/mocksPackage mock_istanbul is a generated GoMock package.
consensus/istanbul/validatorPackage validator implements the types related to the validators participating in consensus.
consensus/mocksPackage mocks is a generated GoMock package.
consolePackage console implements JavaScript console.
console/jsrePackage jsre provides an execution environment for JavaScript.
console/jsre/depsPackage deps contains the console's dependencies of Javascript libraries to be embedded in Go source code.
console/web3extPackage web3ext contains the Klaytn specific web3.js extensions.
contracts/reward/contractPackage contract contains predefined Klaytn reward contracts.
cryptoPackage crypto contains several cryptography modules used in Klaytn.
crypto/bn256Package bn256 implements a particular bilinear group.
crypto/bn256/cloudflarePackage bn256 implements a particular bilinear group at the 128-bit security level.
crypto/bn256/googlePackage bn256 implements a particular bilinear group at the 128-bit security level.
crypto/eciesPackage ecies implements the Elliptic Curve Integrated Encryption Scheme.
crypto/secp256k1Package secp256k1 wraps the bitcoin secp256k1 C library.
crypto/sha3Package sha3 implements the SHA-3 fixed-output-length hash functions and the SHAKE variable-output-length hash functions defined by FIPS-202.
datasync/chaindatafetcher/kas/mocksPackage mocks is a generated GoMock package.
datasync/chaindatafetcher/mocksPackage mocks is a generated GoMock package.
datasync/dbsyncerPackage dbsyncer implements blockchain data synchronisation to relational database.
datasync/downloaderPackage downloader contains the manual full chain synchronisation.
datasync/fetcherPackage fetcher contains the block announcement based synchronisation.
eventPackage event deals with subscriptions to real-time events.
event/mocksPackage mocks is a generated GoMock package.
forkPackage fork has information related to hard forks.
governancePackage governance contains functions and variables used for voting and reflecting vote results in Klaytn.
kas/mocksPackage mocks is a generated GoMock package.
kerrorsPackage kerrors contains common error variables used in Klaytn.
logPackage log provides an opinionated, simple toolkit for best-practice logging.
log/termPackage term contains checking specific operating system terminals.
metrics/expPackage exp hooks go-metrics into expvar on any metrics request, loads all vars from the registry into expvar, and executes regular expvar handler.
metrics/influxdbPackage influxdb implements go-metrics library which will post to the influxDB.
metrics/libratoPackage librato implements go-metrics library which will post to the Librato.
metrics/prometheusPackage prometheusmetrics implements go-metrics library which will post to the prometheus client registry.
networks/grpcPackage grpc implements the gRPC protocol for Klaytn.
networks/p2pPackage p2p implements the Klaytn p2p network protocols.
networks/p2p/discoverPackage discover implements the Node Discovery Protocol.
networks/p2p/natPackage nat provides access to common network port mapping protocols.
networks/p2p/netutilPackage netutil contains extensions to the net package.
networks/p2p/simulationsPackage simulations simulates p2p networks.
networks/p2p/simulations/adaptersPackage adapters implements simulation network adapters in several ways.
networks/p2p/simulations/pipesPackage pipes implements in process pipes on a localhost TCP socket.
networks/rpcPackage rpc provides access to the exported methods of an object across a network or other I/O connection.
nodePackage node sets up multi-protocol Klaytn nodes.
node/cnPackage cn implements components related to network management and message handling.
node/cn/filtersPackage filters implements a Klaytn filtering system for blocks, transactions and log events.
node/cn/filters/mockPackage cn is a generated GoMock package.
node/cn/gaspricePackage gasprice contains Oracle type which recommends gas prices based on recent blocks.
node/cn/mocksPackage mocks is a generated GoMock package.
node/cn/tracersPackage tracers provides implementation of Tracer that evaluates a Javascript function for each VM execution step.
node/cn/tracers/internal/tracersPackage tracers contains the actual JavaScript tracer assets.
node/scPackage sc implements an auxiliary blockchain called Service Chain.
node/sc/bridgepoolPackage bridgepool implements a pool of transactions generated by RemoteBackend.
node/sc/kas/mocksPackage mocks is a generated GoMock package.
paramsPackage params contains configuration parameters for Klaytn.
rewardPackage reward implements the Klaytn Reward System.
ser/rlpPackage rlp implements the RLP serialization format.
storage/databasePackage database implements various types of databases used in Klaytn.
storage/statedbPackage statedb implements the Merkle Patricia Trie structure used for state object trie.
testsPackage tests implements execution of Klaytn scenario-based tests and JSON tests.
tests/benchmarksPackage benchmarks contains go-benchmark tests to measure performance of Klaytn.
workPackage work implements Klaytn block creation and mining.
work/mocksPackage mocks is a generated GoMock package.

Package klaytn imports 5 packages (graph) and is imported by 19 packages. Updated 2020-10-27. Refresh now. Tools for package owners.