README
¶
TzKT events wrapper
Golang library for TzKT events API
Usage
TzKT client
First of all, import library
import events "github.com/dipdup-net/go-lib/tzkt/events"
Then create TzKT client, connect to server and subscribe to channels.
tzkt := events.NewTzKT(events.BaseURL)
if err := tzkt.Connect(); err != nil {
log.Panic(err)
}
defer tzkt.Close()
if err := tzkt.SubscribeToBlocks(); err != nil {
log.Panic(err)
}
Now, you can listen message channel
for msg := range tzkt.Listen() {
log.Println(msg)
}
Message is struct with fields:
type Message struct {
Channel string // is channel name: head, block or operations
Type MessageType // is message type: 0, 1 or 2 (state, data, reorg)
State uint64 // is current level
Body interface{} // is map or array of data depending of channel
}
SignalR
If you want to write custom client or re-use SignalR in another package you can import only signalr and use it.
import "github.com/dipdup-net/go-lib/tzkt/events/signalr"
client := signalr.NewSignalR("https://api.tzkt.io/v1/events")
Documentation
¶
Index ¶
- Constants
- type Message
- type MessageType
- type TzKT
- func (tzkt *TzKT) Close() error
- func (tzkt *TzKT) Connect() error
- func (tzkt *TzKT) Listen() <-chan Message
- func (tzkt *TzKT) SubscribeToBigMaps(ptr *int64, contract, path string, tags ...string) error
- func (tzkt *TzKT) SubscribeToBlocks() error
- func (tzkt *TzKT) SubscribeToHead() error
- func (tzkt *TzKT) SubscribeToOperations(address string, types ...string) error
Constants ¶
const ( MethodHead = "SubscribeToHead" MethodBlocks = "SubscribeToBlocks" MethodOperations = "SubscribeToOperations" MethodBigMap = "SubscribeToBigMaps" )
Methods
const ( ChannelHead = "head" ChannelBlocks = "blocks" ChannelOperations = "operations" ChannelBigMap = "bigmaps" )
Channels
const ( KindTransaction = "transaction" KindOrigination = "origination" KindDelegation = "delegation" KindEndorsement = "endorsement" KindBallot = "ballot" KindProposal = "proposal" KindActivation = "activation" KindDoubleBaking = "double_baking" KindDoubleEndorsing = "double_endorsing" KindNonceRevelation = "nonce_revelation" KindReveal = "reveal" )
operation kinds
const ( BigMapTagMetadata = "metadata" BigMapTagTokenMetadata = "token_metadata" )
Big map tags
const (
BaseURL = "https://api.tzkt.io/v1/events"
)
Base URL
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Message ¶
type Message struct {
Channel string
Type MessageType
State uint64
Body interface{}
}
Message - message struct
type MessageType ¶
type MessageType int
MessageType - TzKT message type
const ( MessageTypeState MessageType = iota MessageTypeData MessageTypeReorg )
message types
type TzKT ¶
type TzKT struct {
// contains filtered or unexported fields
}
TzKT - struct that used for connection to TzKT events server
func NewTzKT ¶
NewTzKT - constructor of `TzKT`. `url` is TzKT events base URL. If it's empty https://api.tzkt.io/v1/events is set.
func (*TzKT) SubscribeToBigMaps ¶
SubscribeToBigMaps - subscribe to bigmaps channel. Sends bigmap updates.
func (*TzKT) SubscribeToBlocks ¶
SubscribeToBlocks - subscribe to blocks channel. Sends blocks added to the blockchain.
func (*TzKT) SubscribeToHead ¶
SubscribeToHead - subscribe to head channel. Sends the blockchain head every time it has been updated.
func (*TzKT) SubscribeToOperations ¶
SubscribeToOperations - subscribe to operations channel. Sends operations of specified types or related to specified accounts, included into the blockchain. Filters by `address` and list of `types` is appliable.
Source Files
Directories