Skip to content

Commit

Permalink
Merge pull request #883 from kaleido-io/blockchain
Browse files Browse the repository at this point in the history 
Track blockchain callback handlers per namespace
  • Loading branch information
@awrichar
awrichar authored Jul 6, 2022
2 parents 3b19da1 + 51d6f63 commit bcc66bb
Show file tree
Hide file tree
Showing 26 changed files with 1,246 additions and 318 deletions.
144 changes: 96 additions & 48 deletions internal/blockchain/ethereum/ethereum.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,39 +68,56 @@ type Ethereum struct {
addressResolver *addressResolver
metrics metrics.Manager
ethconnectConf config.Section
subs map[string]string
subs map[string]subscriptionInfo
}

type subscriptionInfo struct {
namespace string
version int
}

type callbacks struct {
handlers []blockchain.Callbacks
handlers map[string]blockchain.Callbacks
}

func (cb *callbacks) BlockchainOpUpdate(plugin blockchain.Plugin, nsOpID string, txState blockchain.TransactionStatus, blockchainTXID, errorMessage string, opOutput fftypes.JSONObject) {
for _, cb := range cb.handlers {
cb.BlockchainOpUpdate(plugin, nsOpID, txState, blockchainTXID, errorMessage, opOutput)
func (cb *callbacks) BlockchainOpUpdate(ctx context.Context, plugin blockchain.Plugin, nsOpID string, txState blockchain.TransactionStatus, blockchainTXID, errorMessage string, opOutput fftypes.JSONObject) {
namespace, _, _ := core.ParseNamespacedOpID(ctx, nsOpID)
if handler, ok := cb.handlers[namespace]; ok {
handler.BlockchainOpUpdate(plugin, nsOpID, txState, blockchainTXID, errorMessage, opOutput)
return
}
log.L(ctx).Errorf("No handler found for blockchain operation '%s'", nsOpID)
}

func (cb *callbacks) BatchPinComplete(batch *blockchain.BatchPin, signingKey *core.VerifierRef) error {
for _, cb := range cb.handlers {
if err := cb.BatchPinComplete(batch, signingKey); err != nil {
return err
}
func (cb *callbacks) BatchPinComplete(ctx context.Context, batch *blockchain.BatchPin, signingKey *core.VerifierRef) error {
if handler, ok := cb.handlers[batch.Namespace]; ok {
return handler.BatchPinComplete(batch, signingKey)
}
log.L(ctx).Errorf("No handler found for blockchain batch pin on namespace '%s'", batch.Namespace)
return nil
}

func (cb *callbacks) BlockchainNetworkAction(action string, event *blockchain.Event, signingKey *core.VerifierRef) error {
for _, cb := range cb.handlers {
if err := cb.BlockchainNetworkAction(action, event, signingKey); err != nil {
return err
func (cb *callbacks) BlockchainNetworkAction(ctx context.Context, namespace, action string, location *fftypes.JSONAny, event *blockchain.Event, signingKey *core.VerifierRef) error {
if namespace == "" {
// V1 networks don't populate namespace, so deliver the event to every handler
for _, handler := range cb.handlers {
if err := handler.BlockchainNetworkAction(action, location, event, signingKey); err != nil {
return err
}
}
} else {
if handler, ok := cb.handlers[namespace]; ok {
return handler.BlockchainNetworkAction(action, location, event, signingKey)
}
log.L(ctx).Errorf("No handler found for blockchain network action on namespace '%s'", namespace)
}
return nil
}

func (cb *callbacks) BlockchainEvent(event *blockchain.EventWithSubscription) error {
for _, cb := range cb.handlers {
// Send the event to all handlers and let them match it to a contract listener
// TODO: can we push more listener/namespace knowledge down to this layer?
if err := cb.BlockchainEvent(event); err != nil {
return err
}
Expand Down Expand Up @@ -190,6 +207,7 @@ func (e *Ethereum) Init(ctx context.Context, config config.Section, metrics metr
e.ctx = log.WithLogField(ctx, "proto", "ethereum")
e.metrics = metrics
e.capabilities = &blockchain.Capabilities{}
e.callbacks.handlers = make(map[string]blockchain.Callbacks)

if addressResolverConf.GetString(AddressResolverURLTemplate) != "" {
if e.addressResolver, err = newAddressResolver(ctx, addressResolverConf); err != nil {
Expand Down Expand Up @@ -230,7 +248,7 @@ func (e *Ethereum) Init(ctx context.Context, config config.Section, metrics metr
return err
}
e.streamID = stream.ID
e.subs = make(map[string]string)
e.subs = make(map[string]subscriptionInfo)
log.L(e.ctx).Infof("Event stream: %s (topic=%s)", e.streamID, e.topic)

e.closed = make(chan struct{})
Expand All @@ -239,8 +257,8 @@ func (e *Ethereum) Init(ctx context.Context, config config.Section, metrics metr
return nil
}

func (e *Ethereum) SetHandler(handler blockchain.Callbacks) {
e.callbacks.handlers = append(e.callbacks.handlers, handler)
func (e *Ethereum) SetHandler(namespace string, handler blockchain.Callbacks) {
e.callbacks.handlers[namespace] = handler
}

func (e *Ethereum) Start() (err error) {
Expand All @@ -264,15 +282,24 @@ func (e *Ethereum) AddFireflySubscription(ctx context.Context, namespace string,
firstEvent = "latest"
}

sub, err := e.streams.ensureFireFlySubscription(ctx, namespace, ethLocation.Address, firstEvent, e.streamID, batchPinEventABI)
sub, subNS, err := e.streams.ensureFireFlySubscription(ctx, namespace, ethLocation.Address, firstEvent, e.streamID, batchPinEventABI)
if err != nil {
return "", err
}
// TODO: We will probably need to save the namespace AND network version here
// Ultimately there needs to be a logic branch in the event handling, where for "V1" we expect to receive a namespace in every
// BatchPin event, but for "V2" we infer the namespace based on which subscription ID produced it.
e.subs[sub.ID] = namespace

version, err := e.GetNetworkVersion(ctx, location)
if err != nil {
return "", err
}

if version > 1 && subNS == "" {
return "", i18n.NewError(ctx, coremsgs.MsgInvalidSubscriptionForNetwork, sub.Name, version)
}

e.subs[sub.ID] = subscriptionInfo{
namespace: subNS,
version: version,
}
return sub.ID, nil
}

Expand Down Expand Up @@ -346,7 +373,7 @@ func (e *Ethereum) parseBlockchainEvent(ctx context.Context, msgJSON fftypes.JSO
}
}

func (e *Ethereum) handleBatchPinEvent(ctx context.Context, msgJSON fftypes.JSONObject) (err error) {
func (e *Ethereum) handleBatchPinEvent(ctx context.Context, location *fftypes.JSONAny, subInfo *subscriptionInfo, msgJSON fftypes.JSONObject) (err error) {
event := e.parseBlockchainEvent(ctx, msgJSON)
if event == nil {
return nil // move on
Expand Down Expand Up @@ -377,7 +404,24 @@ func (e *Ethereum) handleBatchPinEvent(ctx context.Context, msgJSON fftypes.JSON
// Check if this is actually an operator action
if strings.HasPrefix(nsOrAction, blockchain.FireFlyActionPrefix) {
action := nsOrAction[len(blockchain.FireFlyActionPrefix):]
return e.callbacks.BlockchainNetworkAction(action, event, verifier)

// For V1 of the FireFly contract, action is sent to all namespaces
// For V2+, namespace is inferred from the subscription
var namespace string
if subInfo.version > 1 {
namespace = subInfo.namespace
}

return e.callbacks.BlockchainNetworkAction(ctx, namespace, action, location, event, verifier)
}

// For V1 of the FireFly contract, namespace is passed explicitly
// For V2+, namespace is inferred from the subscription
var namespace string
if subInfo.version == 1 {
namespace = nsOrAction
} else {
namespace = subInfo.namespace
}

hexUUIDs, err := hex.DecodeString(strings.TrimPrefix(sUUIDs, "0x"))
Expand Down Expand Up @@ -409,7 +453,7 @@ func (e *Ethereum) handleBatchPinEvent(ctx context.Context, msgJSON fftypes.JSON
}

batch := &blockchain.BatchPin{
Namespace: nsOrAction,
Namespace: namespace,
TransactionID: &txnID,
BatchID: &batchID,
BatchHash: &batchHash,
Expand All @@ -419,7 +463,7 @@ func (e *Ethereum) handleBatchPinEvent(ctx context.Context, msgJSON fftypes.JSON
}

// If there's an error dispatching the event, we must return the error and shutdown
return e.callbacks.BatchPinComplete(batch, verifier)
return e.callbacks.BatchPinComplete(ctx, batch, verifier)
}

func (e *Ethereum) handleContractEvent(ctx context.Context, msgJSON fftypes.JSONObject) (err error) {
Expand Down Expand Up @@ -450,7 +494,7 @@ func (e *Ethereum) handleReceipt(ctx context.Context, reply fftypes.JSONObject)
updateType = core.OpStatusFailed
}
l.Infof("Ethconnect '%s' reply: request=%s tx=%s message=%s", replyType, requestID, txHash, message)
e.callbacks.BlockchainOpUpdate(e, requestID, updateType, txHash, message, reply)
e.callbacks.BlockchainOpUpdate(ctx, e, requestID, updateType, txHash, message, reply)
}

func (e *Ethereum) buildEventLocationString(msgJSON fftypes.JSONObject) string {
Expand All @@ -476,10 +520,17 @@ func (e *Ethereum) handleMessageBatch(ctx context.Context, messages []interface{
l1.Tracef("Message: %+v", msgJSON)

// Matches one of the active FireFly BatchPin subscriptions
if _, ok := e.subs[sub]; ok {
if subInfo, ok := e.subs[sub]; ok {
location, err := encodeContractLocation(ctx, &Location{
Address: msgJSON.GetString("address"),
})
if err != nil {
return err
}

switch signature {
case broadcastBatchEventSignature:
if err := e.handleBatchPinEvent(ctx1, msgJSON); err != nil {
if err := e.handleBatchPinEvent(ctx1, location, &subInfo, msgJSON); err != nil {
return err
}
default:
Expand Down Expand Up @@ -719,15 +770,7 @@ func (e *Ethereum) NormalizeContractLocation(ctx context.Context, location *ffty
if err != nil {
return nil, err
}
parsed.Address, err = validateEthAddress(ctx, parsed.Address)
if err != nil {
return nil, err
}
normalized, err := json.Marshal(parsed)
if err == nil {
result = fftypes.JSONAnyPtrBytes(normalized)
}
return result, err
return encodeContractLocation(ctx, parsed)
}

func parseContractLocation(ctx context.Context, location *fftypes.JSONAny) (*Location, error) {
Expand All @@ -741,6 +784,18 @@ func parseContractLocation(ctx context.Context, location *fftypes.JSONAny) (*Loc
return &ethLocation, nil
}

func encodeContractLocation(ctx context.Context, location *Location) (result *fftypes.JSONAny, err error) {
location.Address, err = validateEthAddress(ctx, location.Address)
if err != nil {
return nil, err
}
normalized, err := json.Marshal(location)
if err == nil {
result = fftypes.JSONAnyPtrBytes(normalized)
}
return result, err
}

func (e *Ethereum) AddContractListener(ctx context.Context, listener *core.ContractListenerInput) error {
location, err := parseContractLocation(ctx, listener.Location)
if err != nil {
Expand Down Expand Up @@ -1157,16 +1212,9 @@ func (e *Ethereum) GetAndConvertDeprecatedContractConfig(ctx context.Context) (l
} else if strings.HasPrefix(address, "/instances/") {
address = strings.Replace(address, "/instances/", "", 1)
}
address, err = validateEthAddress(ctx, address)
if err != nil {
return nil, "", err
}

ethLocation := &Location{
location, err = encodeContractLocation(ctx, &Location{
Address: address,
}
normalized, _ := json.Marshal(ethLocation)
location = fftypes.JSONAnyPtrBytes(normalized)

return location, fromBlock, nil
})
return location, fromBlock, err
}
Loading

0 comments on commit bcc66bb

Please sign in to comment.