import "github.com/ecadlabs/go-tezos"
block.go client.go errors.go operations.go service.go utils.go votes.go
const (
// ErrorKindPermanent Tezos RPC error kind.
ErrorKindPermanent = "permanent"
// ErrorKindTemporary Tezos RPC error kind.
ErrorKindTemporary = "temporary"
// ErrorKindBranch Tezos RPC error kind.
ErrorKindBranch = "branch"
)BalanceChange is a string encoded int64
func (b *BalanceChange) UnmarshalJSON(data []byte) (err error)
UnmarshalJSON implements json.Unmarshaler
BalanceUpdate is a variable structure depending on the Kind field
type BalanceUpdates []BalanceUpdate
BalanceUpdates is a list of balance update operations
func (b *BalanceUpdates) UnmarshalJSON(data []byte) error
UnmarshalJSON implements json.Unmarshaler
Ballot holds information about a Tezos ballot
BallotListing holds information about a Tezos delegate and his voting weight in rolls
type BallotOperationElem struct {
GenericOperationElem
Source string `json:"source"`
Period int `json:"period"`
Proposal string `json:"proposal"`
Metadata map[string]interface{} `json:"metadata"`
Ballot string `json:"ballot"`
}BallotOperationElem represents a ballot operation
func FilterBallotOps(ops []OperationElem) []*BallotOperationElem
FilterBallotOps filter all BallotOperationElem from a slice of OperationElem
Ballots holds summary data about a voting period
type Block struct {
Protocol string `json:"protocol"`
ChainID string `json:"chain_id"`
Hash string `json:"hash"`
Header RawBlockHeader `json:"header"`
Metadata BlockHeaderMetadata `json:"metadata"`
Operations [][]*Operation `json:"operations"`
}Block holds information about a Tezos block
type BlockHeaderMetadata struct {
Protocol string `json:"protocol"`
NextProtocol string `json:"next_protocol"`
TestChainStatus TestChainStatus `json:"-"`
MaxOperationsTTL int `json:"max_operations_ttl"`
MaxOperationDataLength int `json:"max_operation_data_length"`
MaxBlockHeaderLength int `json:"max_block_header_length"`
MaxOperationListLength []*MaxOperationListLength `json:"max_operation_list_length"`
Baker string `json:"baker"`
Level BlockHeaderMetadataLevel `json:"level"`
VotingPeriodKind string `json:"voting_period_kind"`
NonceHash string `json:"nonce_hash"`
ConsumedGas big.Int `json:"-"`
Deactivated []string `json:"deactivated"`
BalanceUpdates BalanceUpdates `json:"balance_updates"`
}BlockHeaderMetadata is a part of the Tezos block data
func (bhm *BlockHeaderMetadata) UnmarshalJSON(data []byte) error
UnmarshalJSON unmarshals the BlockHeaderMetadata JSON
type BlockHeaderMetadataLevel struct {
Level int `json:"level"`
LevelPosition int `json:"level_position"`
Cycle int `json:"cycle"`
CyclePosition int `json:"cycle_position"`
VotingPeriod int `json:"voting_period"`
VotingPeriodPosition int `json:"voting_period_position"`
ExpectedCommitment bool `json:"expected_commitment"`
}BlockHeaderMetadataLevel is a part of BlockHeaderMetadata
type BootstrappedBlock struct {
Block string `json:"block"`
Timestamp time.Time `json:"timestamp"`
}BootstrappedBlock represents bootstrapped block stream message
type ContractBalanceUpdate struct {
GenericBalanceUpdate
Contract string `json:"contract"`
}ContractBalanceUpdate is a BalanceUpdatesType variant for Kind=contract
type EndorsementOperationElem struct {
GenericOperationElem
Level int `json:"level"`
Metadata *EndorsementOperationMetadata `json:"metadata"`
}EndorsementOperationElem represents an endorsement operation
func FilterEndorsmentOps(ops []OperationElem) []*EndorsementOperationElem
FilterEndorsmentOps filter all EndorsementOperationElem from a slice of OperationElem
type EndorsementOperationMetadata struct {
BalanceUpdates BalanceUpdates `json:"balance_updates"`
Delegate string `json:"delegate"`
Slots []int `json:"slots"`
}EndorsementOperationMetadata represents an endorsement operation metadata
Error is a Tezos error as documented on http://tezos.gitlab.io/mainnet/api/errors.html.
Errors is a slice of Error with custom JSON unmarshaller
ErrorID returns Tezos error id
ErrorKind returns Tezos error kind
UnmarshalJSON implements json.Unmarshaler
type ForkingTestChainStatus struct {
GenericTestChainStatus
Protocol string `json:"protocol"`
Expiration string `json:"expiration"`
}ForkingTestChainStatus is a TestChainStatus variant for Status=forking
type FreezerBalanceUpdate struct {
GenericBalanceUpdate
Category string `json:"category"`
Delegate string `json:"delegate"`
Level int `json:"level"`
}FreezerBalanceUpdate is a BalanceUpdatesType variant for Kind=freezer
type GenericBalanceUpdate struct {
Kind string `json:"kind"`
Change BalanceChange `json:"change"`
}GenericBalanceUpdate holds the common values among all BalanceUpdatesType variants
func (g *GenericBalanceUpdate) BalanceUpdateKind() string
BalanceUpdateKind returns the BalanceUpdateType's Kind field
GenericError is a basic error type
func (e *GenericError) Error() string
func (e *GenericError) ErrorID() string
ErrorID returns Tezos error id
func (e *GenericError) ErrorKind() string
ErrorKind returns Tezos error kind
GenericOperationElem is a most generic element type
func (e *GenericOperationElem) OperationElemKind() string
OperationElemKind implements OperationElem
GenericTestChainStatus holds the common values among all TestChainStatus variants
func (t *GenericTestChainStatus) TestChainStatus() string
TestChainStatus gets the TestChainStatus's Status field
type HTTPError interface {
error
HTTPStatus
}HTTPError retains HTTP status
type HTTPStatus interface {
Status() string // e.g. "200 OK"
StatusCode() int // e.g. 200
Body() []byte
}HTTPStatus interface represents an unprocessed HTTP reply
HexBytes represents bytes as a JSON string of hexadecimal digits
UnmarshalText umarshalls a hex string to bytes
IDTimestamp represents peer id with timestamp
func (i *IDTimestamp) UnmarshalJSON(data []byte) error
UnmarshalJSON implements json.Unmarshaler
type InvalidBlock struct {
Block string `json:"block"`
Level int `json:"level"`
Error Errors `json:"error"`
}InvalidBlock represents invalid block hash along with the errors that led to it being declared invalid
MaxOperationListLength is a part of the BlockHeaderMetadata
type MempoolOperations struct {
Applied []*Operation `json:"applied"`
Refused []*OperationWithErrorAlt `json:"refused"`
BranchRefused []*OperationWithErrorAlt `json:"branch_refused"`
BranchDelayed []*OperationWithErrorAlt `json:"branch_delayed"`
Unprocessed []*OperationAlt `json:"unprocessed"`
}MempoolOperations represents mempool operations
type MonitorBlock struct {
Level int `json:"level"`
Proto int `json:"proto"`
Predecessor string `json:"predecessor"`
Timestamp time.Time `json:"timestamp"`
ValidationPass int `json:"validation_pass"`
OperationsHash string `json:"operations_hash"`
Fitness []HexBytes `json:"fitness"`
Context string `json:"context"`
Priority int `json:"priority"`
Hash string `json:"hash"`
ProtocolData string `json:"protocol_data"`
}MonitorBlock holds information about block returned by monitor heads endpoint
NetworkAddress models a point's address and port.
type NetworkConnection struct {
Incoming bool `json:"incoming"`
PeerID string `json:"peer_id"`
IDPoint NetworkAddress `json:"id_point"`
RemoteSocketPort uint16 `json:"remote_socket_port"`
Versions []*NetworkVersion `json:"versions"`
Private bool `json:"private"`
LocalMetadata NetworkMetadata `json:"local_metadata"`
RemoteMetadata NetworkMetadata `json:"remote_metadata"`
}NetworkConnection models detailed information for one network connection.
type NetworkConnectionTimestamp struct {
NetworkAddress
Timestamp time.Time
}NetworkConnectionTimestamp represents peer address with timestamp added
func (n *NetworkConnectionTimestamp) UnmarshalJSON(data []byte) error
UnmarshalJSON implements json.Unmarshaler
type NetworkMetadata struct {
DisableMempool bool `json:"disable_mempool"`
PrivateNode bool `json:"private_node"`
}NetworkMetadata models metadata of a node.
type NetworkPeer struct {
PeerID string `json:"-"`
Score int64 `json:"score"`
Trusted bool `json:"trusted"`
ConnMetadata *NetworkMetadata `json:"conn_metadata"`
State string `json:"state"`
ReachableAt *NetworkAddress `json:"reachable_at"`
Stat NetworkStats `json:"stat"`
LastEstablishedConnection *NetworkConnectionTimestamp `json:"last_established_connection"`
LastSeen *NetworkConnectionTimestamp `json:"last_seen"`
LastFailedConnection *NetworkConnectionTimestamp `json:"last_failed_connection"`
LastRejectedConnection *NetworkConnectionTimestamp `json:"last_rejected_connection"`
LastDisconnection *NetworkConnectionTimestamp `json:"last_disconnection"`
LastMiss *NetworkConnectionTimestamp `json:"last_miss"`
}NetworkPeer represents peer info
type NetworkPeerLogEntry struct {
NetworkAddress
Kind string `json:"kind"`
Timestamp time.Time `json:"timestamp"`
}NetworkPeerLogEntry represents peer log entry
type NetworkPoint struct {
Address string `json:"-"`
Trusted bool `json:"trusted"`
GreylistedUntil time.Time `json:"greylisted_until"`
State NetworkPointState `json:"state"`
P2PPeerID string `json:"p2p_peer_id"`
LastFailedConnection time.Time `json:"last_failed_connection"`
LastRejectedConnection *IDTimestamp `json:"last_rejected_connection"`
LastEstablishedConnection *IDTimestamp `json:"last_established_connection"`
LastDisconnection *IDTimestamp `json:"last_disconnection"`
LastSeen *IDTimestamp `json:"last_seen"`
LastMiss time.Time `json:"last_miss"`
}NetworkPoint represents network point info
type NetworkPointLogEntry struct {
Kind NetworkPointState `json:"kind"`
Timestamp time.Time `json:"timestamp"`
}NetworkPointLogEntry represents point's log entry
type NetworkPointState struct {
EventKind string `json:"event_kind"`
P2PPeerID string `json:"p2p_peer_id"`
}NetworkPointState represents point state
type NetworkStats struct {
TotalBytesSent int64 `json:"total_sent,string"`
TotalBytesRecv int64 `json:"total_recv,string"`
CurrentInflow int64 `json:"current_inflow"`
CurrentOutflow int64 `json:"current_outflow"`
}NetworkStats models global network bandwidth totals and usage in B/s.
type NetworkVersion struct {
Name string `json:"name"`
Major uint16 `json:"major"`
Minor uint16 `json:"minor"`
}NetworkVersion models a network-layer version of a node.
type NotRunningTestChainStatus struct {
GenericTestChainStatus
}NotRunningTestChainStatus is a TestChainStatus variant for Status=not_running
type Operation struct {
Protocol string `json:"protocol"`
ChainID string `json:"chain_id"`
Hash string `json:"hash"`
Branch string `json:"branch"`
Contents OperationElements `json:"contents"`
Signature string `json:"signature"`
}Operation represents an operation included into block
OperationAlt is a heterogeneously encoded Operation with hash as a first array member, i.e.
[
"...", // hash
{
"protocol": "...",
...
}
]
instead of
{
"protocol": "...",
"hash": "...",
...
}
func (o *OperationAlt) UnmarshalJSON(data []byte) error
UnmarshalJSON implements json.Unmarshaler
OperationElem must be implemented by all operation elements
type OperationElements []OperationElem
OperationElements is a slice of OperationElem with custom JSON unmarshaller
func (e *OperationElements) UnmarshalJSON(data []byte) error
UnmarshalJSON implements json.Unmarshaler
OperationWithError represents unsuccessful operation
type OperationWithErrorAlt OperationWithError
OperationWithErrorAlt is a heterogeneously encoded OperationWithError with hash as a first array member. See OperationAlt for details
func (o *OperationWithErrorAlt) UnmarshalJSON(data []byte) error
UnmarshalJSON implements json.Unmarshaler
PeriodKind contains information about tezos voting period kind
func (p PeriodKind) IsPromotionVote() bool
IsPromotionVote true if period kind is promotion vote
func (p PeriodKind) IsProposal() bool
IsProposal return true if period kind is proposal
func (p PeriodKind) IsTesting() bool
IsTesting return true if period kind is testing
func (p PeriodKind) IsTestingVote() bool
IsTestingVote return true if period kind is testing vote
Proposal holds summary data about a proposal and his number of supporter
type ProposalOperationElem struct {
GenericOperationElem
Source string `json:"source"`
Period int `json:"period"`
Proposals []string `json:"proposals"`
Metadata map[string]interface{} `json:"metadata"`
}ProposalOperationElem represents a proposal operation
func FilterProposalOps(ops []OperationElem) []*ProposalOperationElem
FilterProposalOps filter all ProposalOperationElem from a slice of OperationElem
type RPCClient struct {
// HTTP client used to communicate with the Tezos node API.
Client *http.Client
// Base URL for API requests.
BaseURL *url.URL
// User agent name for client.
UserAgent string
// Optional callback for metrics.
RPCStatusCallback func(req *http.Request, status int, duration time.Duration, err error)
// Optional callback for metrics.
RPCHeaderCallback func(req *http.Request, resp *http.Response, duration time.Duration)
}RPCClient manages communication with a Tezos RPC server.
NewRPCClient returns a new Tezos RPC client.
Do retrieves values from the API and marshals them into the provided interface.
func (c *RPCClient) NewRequest(ctx context.Context, method, urlStr string, body interface{}) (*http.Request, error)
NewRequest creates a Tezos RPC request.
type RPCError interface {
Error
HTTPStatus
Errors() []Error // returns all errors as a slice
}RPCError is a Tezos RPC error as documented on http://tezos.gitlab.io/mainnet/api/errors.html.
type RawBlockHeader struct {
Level int `json:"level"`
Proto int `json:"proto"`
Predecessor string `json:"predecessor"`
Timestamp time.Time `json:"timestamp"`
ValidationPass int `json:"validation_pass"`
OperationsHash string `json:"operations_hash"`
Fitness []HexBytes `json:"fitness"`
Context string `json:"context"`
Priority int `json:"priority"`
ProofOfWorkNonce HexBytes `json:"proof_of_work_nonce"`
SeedNonceHash string `json:"seed_nonce_hash"`
Signature string `json:"signature"`
}RawBlockHeader is a part of the Tezos block data
type RunningTestChainStatus struct {
GenericTestChainStatus
ChainID string `json:"chain_id"`
Genesis string `json:"genesis"`
Protocol string `json:"protocol"`
Expiration string `json:"expiration"`
}RunningTestChainStatus is a TestChainStatus variant for Status=running
Service implements fetching of information from Tezos nodes via JSON.
BanNetworkPeer blacklists the given peer. https://tezos.gitlab.io/mainnet/api/rpc.html#get-network-peers-peer-id-ban
BanNetworkPoint blacklists the given address. https://tezos.gitlab.io/mainnet/api/rpc.html#get-network-points-point-ban
func (s *Service) ConnectToNetworkPoint(ctx context.Context, address string, timeout time.Duration) error
ConnectToNetworkPoint used to connect to a peer. https://tezos.gitlab.io/mainnet/api/rpc.html#put-network-points-point
GetBallotList returns ballots casted so far during a voting period. https://tezos.gitlab.io/alphanet/api/rpc.html#get-block-id-votes-ballot-list
func (s *Service) GetBallotListings(ctx context.Context, chainID, blockID string) ([]*BallotListing, error)
GetBallotListings returns a list of delegates with their voting weight, in number of rolls. https://tezos.gitlab.io/alphanet/api/rpc.html#get-block-id-votes-listings
GetBallots returns sum of ballots casted so far during a voting period. https://tezos.gitlab.io/alphanet/api/rpc.html#get-block-id-votes-ballots
GetBlock returns information about a Tezos block https://tezos.gitlab.io/alphanet/api/rpc.html#get-block-id
GetBootstrapped reads from the bootstrapped blocks stream http://tezos.gitlab.io/mainnet/api/rpc.html#get-monitor-bootstrapped
func (s *Service) GetContractBalance(ctx context.Context, chainID string, blockID string, contractID string) (*big.Int, error)
GetContractBalance returns a contract's balance http://tezos.gitlab.io/mainnet/api/rpc.html#get-block-id-context-contracts-contract-id-balance
func (s *Service) GetCurrentPeriodKind(ctx context.Context, chainID, blockID string) (PeriodKind, error)
GetCurrentPeriodKind returns the current period kind https://tezos.gitlab.io/alphanet/api/rpc.html#get-block-id-votes-current-period-kind
func (s *Service) GetCurrentProposals(ctx context.Context, chainID, blockID string) (string, error)
GetCurrentProposals returns the current proposal under evaluation. https://tezos.gitlab.io/alphanet/api/rpc.html#get-block-id-votes-current-proposal
GetCurrentQuorum returns the current expected quorum. https://tezos.gitlab.io/alphanet/api/rpc.html#get-block-id-votes-current-quorum
func (s *Service) GetDelegateBalance(ctx context.Context, chainID string, blockID string, pkh string) (*big.Int, error)
GetDelegateBalance returns a delegate's balance http://tezos.gitlab.io/mainnet/api/rpc.html#get-block-id-context-delegates-pkh-balance
GetInvalidBlocks lists blocks that have been declared invalid along with the errors that led to them being declared invalid. https://tezos.gitlab.io/alphanet/api/rpc.html#get-chains-chain-id-invalid-blocks
func (s *Service) GetMempoolPendingOperations(ctx context.Context, chainID string) (*MempoolOperations, error)
GetMempoolPendingOperations returns mempool pending operations
func (s *Service) GetMonitorHeads(ctx context.Context, chainID string, results chan<- *MonitorBlock) error
GetMonitorHeads reads from the heads blocks stream https://tezos.gitlab.io/mainnet/api/rpc.html#get-monitor-heads-chain-id
GetNetworkConnections returns all network connections http://tezos.gitlab.io/mainnet/api/rpc.html#get-network-connections
GetNetworkPeer returns details about a given peer. https://tezos.gitlab.io/mainnet/api/rpc.html#get-network-peers-peer-id
GetNetworkPeerBanned checks if a given peer is blacklisted or greylisted. https://tezos.gitlab.io/mainnet/api/rpc.html#get-network-peers-peer-id-banned
func (s *Service) GetNetworkPeerLog(ctx context.Context, peerID string) ([]*NetworkPeerLogEntry, error)
GetNetworkPeerLog monitors network events related to a given peer. https://tezos.gitlab.io/mainnet/api/rpc.html#get-network-peers-peer-id-log
GetNetworkPeers returns the list the peers the node ever met. https://tezos.gitlab.io/mainnet/api/rpc.html#get-network-peers
GetNetworkPoint returns details about a given `IP:addr`. https://tezos.gitlab.io/mainnet/api/rpc.html#get-network-points-point
GetNetworkPointBanned check is a given address is blacklisted or greylisted. https://tezos.gitlab.io/mainnet/api/rpc.html#get-network-points-point-banned
func (s *Service) GetNetworkPointLog(ctx context.Context, address string) ([]*NetworkPointLogEntry, error)
GetNetworkPointLog monitors network events related to an `IP:addr`. https://tezos.gitlab.io/mainnet/api/rpc.html#get-network-peers-peer-id-log
GetNetworkPoints returns list the pool of known `IP:port` used for establishing P2P connections. https://tezos.gitlab.io/mainnet/api/rpc.html#get-network-points
GetNetworkStats returns current network stats https://tezos.gitlab.io/betanet/api/rpc.html#get-network-stat
GetProposals returns a list of proposals with number of supporters. https://tezos.gitlab.io/alphanet/api/rpc.html#get-block-id-votes-proposals
func (s *Service) MonitorMempoolOperations(ctx context.Context, chainID, filter string, results chan<- []*Operation) error
MonitorMempoolOperations monitors mempool pending operations. The connection is closed after every new block.
func (s *Service) MonitorNetworkPeerLog(ctx context.Context, peerID string, results chan<- []*NetworkPeerLogEntry) error
MonitorNetworkPeerLog monitors network events related to a given peer. https://tezos.gitlab.io/mainnet/api/rpc.html#get-network-peers-peer-id-log
func (s *Service) MonitorNetworkPointLog(ctx context.Context, address string, results chan<- []*NetworkPointLogEntry) error
MonitorNetworkPointLog monitors network events related to an `IP:addr`. https://tezos.gitlab.io/mainnet/api/rpc.html#get-network-peers-peer-id-log
TrustNetworkPeer used to trust a given peer permanently: the peer cannot be blocked (but its host IP still can). https://tezos.gitlab.io/mainnet/api/rpc.html#get-network-peers-peer-id-trust
TrustNetworkPoint used to trust a given address permanently. Connections from this address can still be closed on authentication if the peer is blacklisted or greylisted. https://tezos.gitlab.io/mainnet/api/rpc.html#get-network-points-point-trust
TestChainStatus is a variable structure depending on the Status field
type TransactionOperationElem struct {
GenericOperationElem
Source string `json:"source"`
Fee bigIntStr `json:"fee"`
Counter bigIntStr `json:"counter"`
GasLimit bigIntStr `json:"gas_limit"`
StorageLimit bigIntStr `json:"storage_limit"`
Amount bigIntStr `json:"amount"`
Destination string `json:"destination"`
Parameters map[string]interface{} `json:"parameters"`
Metadata *EndorsementOperationMetadata `json:"metadata"`
}TransactionOperationElem represents a transaction operation
func FilterTransactionOps(ops []OperationElem) []*TransactionOperationElem
FilterTransactionOps filter all TransactionOperationElem from a slice of OperationElem
Package tezos imports 14 packages (graph). Updated 2019-07-10. Refresh now. Tools for package owners.