Add Transfers to TzKT API

Author: aopoltorzhicky

tzkt/api/data.go

@@ -340,3 +340,26 @@ func (props *AdditionalProperties) UnmarshalJSON(data []byte) error {
 	props.Value = &JSONSchema{}
 	return json.Unmarshal(data, props.Value)
 }
+
+// Transfer -
+type Transfer struct {
+	ID            uint64    `json:"id"`
+	Level         uint64    `json:"level"`
+	Timestamp     time.Time `json:"timestamp"`
+	Token         Token     `json:"token"`
+	From          *Address  `json:"from,omitempty"`
+	To            *Address  `json:"to,omitempty"`
+	Amount        string    `json:"amount"`
+	TransactionID *uint64   `json:"transactionId,omitempty"`
+	OriginationID *uint64   `json:"originationId,omitempty"`
+	MigrationID   *uint64   `json:"migrationId,omitempty"`
+}
+
+// Token -
+type Token struct {
+	ID       uint64             `json:"id"`
+	Contract Address            `json:"contract"`
+	TokenID  string             `json:"tokenId"`
+	Standard string             `json:"standard"`
+	Metadata stdJSON.RawMessage `json:"metadata,omitempty"`
+}

tzkt/api/tokens.go

@@ -0,0 +1,9 @@
+package api
+
+import "context"
+
+// GetTokenTransfers -
+func (tzkt *API) GetTokenTransfers(ctx context.Context, filters map[string]string) (transfers []Transfer, err error) {
+	err = tzkt.json(ctx, "/v1/tokens/transfers", filters, &transfers)
+	return
+}

tzkt/events/consts.go

@@ -2,11 +2,12 @@ package events
 
 // Methods
 const (
-	MethodHead       = "SubscribeToHead"
-	MethodBlocks     = "SubscribeToBlocks"
-	MethodOperations = "SubscribeToOperations"
-	MethodBigMap     = "SubscribeToBigMaps"
-	MethodAccounts   = "SubscribeToAccounts"
+	MethodHead           = "SubscribeToHead"
+	MethodBlocks         = "SubscribeToBlocks"
+	MethodOperations     = "SubscribeToOperations"
+	MethodBigMap         = "SubscribeToBigMaps"
+	MethodAccounts       = "SubscribeToAccounts"
+	MethodTokenTransfers = "SubscribeToTokenTransfers"
 )
 
 // Channels
@@ -16,6 +17,7 @@ const (
 	ChannelOperations = "operations"
 	ChannelBigMap     = "bigmaps"
 	ChannelAccounts   = "accounts"
+	ChannelTransfers  = "transfers"
 )
 
 // operation kinds

tzkt/events/message.go

@@ -269,3 +269,26 @@ type QuoteShort struct {
 	KRW decimal.Decimal `json:"krw,omitempty"`
 	ETH decimal.Decimal `json:"eth,omitempty"`
 }
+
+// Transfer -
+type Transfer struct {
+	ID            uint64    `json:"id"`
+	Level         uint64    `json:"level"`
+	Timestamp     time.Time `json:"timestamp"`
+	Token         Token     `json:"token"`
+	From          *Alias    `json:"from,omitempty"`
+	To            *Alias    `json:"to,omitempty"`
+	Amount        string    `json:"amount"`
+	TransactionID *uint64   `json:"transactionId,omitempty"`
+	OriginationID *uint64   `json:"originationId,omitempty"`
+	MigrationID   *uint64   `json:"migrationId,omitempty"`
+}
+
+// Token -
+type Token struct {
+	ID       uint64             `json:"id"`
+	Contract Alias              `json:"contract"`
+	TokenID  string             `json:"tokenId"`
+	Standard string             `json:"standard"`
+	Metadata stdJSON.RawMessage `json:"metadata,omitempty"`
+}

tzkt/events/tzkt.go

@@ -111,7 +111,7 @@ func (tzkt *TzKT) SubscribeToBigMaps(ptr *int64, contract, path string, tags ...
 	return tzkt.subscribe(MethodBigMap, args)
 }
 
-// SubscribeToBigMaps - subscribe to accounts channel. Sends touched accounts (affected by any operation in any way)..
+// SubscribeToAccounts - subscribe to accounts channel. Sends touched accounts (affected by any operation in any way)..
 func (tzkt *TzKT) SubscribeToAccounts(addresses ...string) error {
 	args := make(map[string]interface{})
 	if len(addresses) > 0 {
@@ -120,6 +120,21 @@ func (tzkt *TzKT) SubscribeToAccounts(addresses ...string) error {
 	return tzkt.subscribe(MethodAccounts, args)
 }
 
+// SubscribeToTokenTransfers - subscribe to transfers channel. Sends token transfers.
+func (tzkt *TzKT) SubscribeToTokenTransfers(account, contract, tokenID string) error {
+	args := make(map[string]interface{})
+	if account != "" {
+		args["account"] = account
+	}
+	if contract != "" {
+		args["contract"] = contract
+	}
+	if tokenID != "" {
+		args["tokenID"] = tokenID
+	}
+	return tzkt.subscribe(MethodTokenTransfers, args)
+}
+
 func (tzkt *TzKT) subscribe(channel string, args ...interface{}) error {
 	tzkt.invokationID += 1
 	msg := signalr.NewInvocation(fmt.Sprintf("%d", tzkt.invokationID), channel, args...)
@@ -214,6 +229,10 @@ func parseData(channel string, data []byte) (interface{}, error) {
 		return head, err
 	case ChannelOperations:
 		return parseOperations(data)
+	case ChannelTransfers:
+		var transfer []Transfer
+		err := json.Unmarshal(data, &transfer)
+		return transfer, err
 	default:
 		return nil, errors.Errorf("unknown channel: %s", channel)
 	}