package
23.1.6+incompatible
Repository: https://github.com/zeta-chain/node.git
Documentation: pkg.go.dev

# Functions

BitcoinChainIDFromNetworkName returns the chain id for the given bitcoin network name.
BitcoinNetParamsFromChainID returns the bitcoin net params to be used from the chain id.
BtcNonceMarkOffset is the offset satoshi amount to calculate the nonce mark output.
ChainIDInChainList checks whether the chainID is in the chain list.
ChainListByConsensus returns a list of chains by consensus.
No description provided by the author
ChainListByNetwork returns a list of chains by network.
ChainListByNetworkType returns a list of chains by network type.
CombineChainList combines a list of chains with a list of chains duplicated chain ID are overwritten by the second list.
CombineDefaultChainsList combines the default chains list with a list of chains duplicated chain ID are overwritten by the second list.
CombineFilterChains combines multiple lists of chains into a single list.
No description provided by the author
CosmosToEthChainID converts a Cosmos chain ID to an Ethereum chain ID parse value between _ and - e.g.
DecodeAddressFromChainID decode the address string to bytes additionalChains is a list of additional chains to search from in practice, it is used in the protocol to dynamically support new chains without doing an upgrade.
DecodeBtcAddress decodes a BTC address from a given string and chainID.
DecodeSolanaWalletAddress decodes a Solana wallet address from a given string.
DefaultChainsList returns a list of default chains.
ExternalChainList returns a list chains that are not Zeta.
FilterByConsensus filters chains by consensus type.
FilterByGateway filters chains by gateway.
FilterChains applies a list of filters to a list of chains.
FilterExternalChains filters chains that are external.
GetBTCChainIDFromChainParams returns the bitcoin chain ID from the chain config params.
GetBTCChainParams returns the bitcoin chain config params from the chain ID.
GetChainFromChainID returns the chain from the chain ID additionalChains is a list of additional chains to search from in practice, it is used in the protocol to dynamically support new chains without doing an upgrade.
IsBitcoinChain returns true if the chain is a Bitcoin-based chain or uses the bitcoin consensus mechanism for block finality additionalChains is a list of additional chains to search from in practice, it is used in the protocol to dynamically support new chains without doing an upgrade.
IsBitcoinMainnet returns true if the chain id is for the mainnet.
IsBitcoinRegnet returns true if the chain id is for the regnet.
IsBtcAddressSupported returns true if the given BTC address is supported.
IsEthereumChain returns true if the chain is an Ethereum chain additionalChains is a list of additional chains to search from in practice, it is used in the protocol to dynamically support new chains without doing an upgrade.
IsEVMChain returns true if the chain is an EVM chain additionalChains is a list of additional chains to search from in practice, it is used in the protocol to dynamically support new chains without doing an upgrade.
IsSolanaChain returns true if the chain is a Solana chain.
IsTONChain returns true is the chain is TON chain.
IsZetaChain returns true if the chain is a Zeta chain additionalChains is a list of additional chains to search from in practice, it is used in the protocol to dynamically support new chains without doing an upgrade.
NewAddress create a new Address.
NonceMarkAmount uses special value to mark current nonce in UTXO.
ReceiveStatusFromString returns a ReceiveStatus from a string using in CLI 0 for success, 1 for failed TODO: remove "receive" naming ans use outbound https://github.com/zeta-chain/node/issues/1797.
StringToHash convert string to hash bytes.
ZetaChainFromChainID returns a ZetaChain chain object from a chain ID.
ZetaChainFromCosmosChainID returns a ZetaChain chain object from a Cosmos chain ID.

# Constants

observers is the CCTX gateway for chains relying on the observer set to observe inbounds and TSS for outbounds.
zevm is the internal CCTX gateway to process outbound on the ZEVM and read inbound events from the ZEVM only used for ZetaChain chains.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Created is used for inbounds.
No description provided by the author
No description provided by the author
TestNet4 represents the test network (version 4).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

Amoy is Polygon amoy testnet.
BaseMainnet is Base mainnet.
BaseSepolia is Base sepolia testnet.
BitcoinMainnet is Bitcoin mainnet.
BitcoinRegtest is Bitcoin regtest (localnet).
BitcoinSignetTestnet is Bitcoin Signet testnet.
BitcoinTestnet is Bitcoin testnet3.
BitcoinTestnet4 is Bitcoin testnet4.
BscMainnet is Binance Smart Chain mainnet.
BscTestnet is Binance Smart Chain testnet.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ErrNotZetaChain is the error for chain not being a ZetaChain chain.
No description provided by the author
Ethereum is Ethereum mainnet.
Goerli is Ethereum goerli testnet (deprecated for sepolia).
GoerliLocalnet is Ethereum local goerli (localnet).
Mumbai is Polygon mumbai testnet (deprecated for amoy).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
OptimismMainnet is Optimism mainnet.
OptimismSepolia is Optimism sepolia testnet.
Polygon is Polygon mainnet.
No description provided by the author
No description provided by the author
Sepolia is Ethereum sepolia testnet.
SolanaDevnet is Solana devnet NOTE: Solana devnet refers to Solana testnet in our terminology Solana uses devnet denomitation for network for development TODO: define final chain ID https://github.com/zeta-chain/node/issues/2421.
SolanaLocalnet is Solana localnet TODO: define final chain ID https://github.com/zeta-chain/node/issues/2421.
SolanaMainnet is Solana mainnet TODO: define final chain ID https://github.com/zeta-chain/node/issues/2421.
TestNet4Params defines the network parameters for the test Bitcoin network (version 4).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ZetaChainDevnet is the devnet chain for Zeta used as live testing environment.
ZetaChainMainnet is the mainnet chain for Zeta.
ZetaChainPrivnet is the privnet chain for Zeta (localnet).
ZetaChainTestnet is the testnet chain for Zeta.

# Structs

Chain represents static data about a blockchain network it is identified by a unique chain ID.

# Type aliases

No description provided by the author
CCTXGateway describes for the chain the gateway used to handle CCTX outbounds.
ChainFilter is a function that filters chains based on some criteria.
ChainName represents the name of the chain Deprecated(v19): replaced with Chain.Name as string.
Consensus represents the consensus algorithm used by the chain this can represent the consensus of a L1 this can also represent the solution of a L2.
Network represents the network of the chain there is a single instance of the network on mainnet then the network can have eventual testnets or devnets.
NetworkType represents the network type of the chain Mainnet, Testnet, Privnet, Devnet.
ReceiveStatus represents the status of an outbound TODO: Rename and move https://github.com/zeta-chain/node/issues/2257.
Vm represents the virtual machine type of the chain to support smart contracts.