Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change default contracts to network version 2 #890

Merged
merged 9 commits into from
Jul 13, 2022
Merged

Change default contracts to network version 2 #890

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
76fdb2c
Change default contracts to network version 2
awrichar Jul 6, 2022
86bbbe8
Move ethereum/fabric ccache up to plugin
awrichar Jul 8, 2022
31b0a95
Cache GetNetworkVersion result to avoid back-to-back blockchain queries
awrichar Jul 6, 2022
655327f
Split pinBatch/networkAction as separate methods on FireFly contract
awrichar Jul 9, 2022
c9bfda2
Do not return errors from RemoveFireflySubscription
awrichar Jul 9, 2022
7bbd9a8
Fix bugs with processing contract termination
awrichar Jul 9, 2022
66e5c95
Ensure orchestrator is started before blockchain events begin
awrichar Jul 9, 2022
80f0a0b
Check type of GetNetworkVersion return
awrichar Jul 9, 2022
5d81c59
Merge remote-tracking branch 'origin/main' into v2
awrichar Jul 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 45 additions & 1 deletion internal/blockchain/ethereum/abi_definitions.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ package ethereum

import "github.com/hyperledger/firefly-signer/pkg/abi"

var batchPinMethodABI = &abi.Entry{
var batchPinMethodABIV1 = &abi.Entry{
Name: "pinBatch",
Type: "function",
Inputs: abi.ParameterArray{
Expand Down Expand Up @@ -50,6 +50,50 @@ var batchPinMethodABI = &abi.Entry{
},
}

var batchPinMethodABI = &abi.Entry{
Name: "pinBatch",
Type: "function",
Inputs: abi.ParameterArray{
{
InternalType: "bytes32",
Name: "uuids",
Type: "bytes32",
},
{
InternalType: "bytes32",
Name: "batchHash",
Type: "bytes32",
},
{
InternalType: "string",
Name: "payloadRef",
Type: "string",
},
{
InternalType: "bytes32[]",
Name: "contexts",
Type: "bytes32[]",
},
},
}

var networkActionMethodABI = &abi.Entry{
Name: "networkAction",
Type: "function",
Inputs: abi.ParameterArray{
{
InternalType: "string",
Name: "action",
Type: "string",
},
{
InternalType: "string",
Name: "payload",
Type: "string",
},
},
}

var batchPinEventABI = &abi.Entry{
Name: "BatchPin",
Type: "event",
Expand Down
122 changes: 93 additions & 29 deletions internal/blockchain/ethereum/ethereum.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import (
"regexp"
"strconv"
"strings"
"time"

"github.com/go-resty/resty/v2"
"github.com/hyperledger/firefly-common/pkg/config"
Expand All @@ -34,10 +35,12 @@ import (
"github.com/hyperledger/firefly-common/pkg/wsclient"
"github.com/hyperledger/firefly-signer/pkg/abi"
"github.com/hyperledger/firefly-signer/pkg/ffi2abi"
"github.com/hyperledger/firefly/internal/coreconfig"
"github.com/hyperledger/firefly/internal/coremsgs"
"github.com/hyperledger/firefly/internal/metrics"
"github.com/hyperledger/firefly/pkg/blockchain"
"github.com/hyperledger/firefly/pkg/core"
"github.com/karlseguin/ccache"
)

const (
Expand All @@ -61,6 +64,8 @@ type Ethereum struct {
metrics metrics.Manager
ethconnectConf config.Section
subs map[string]subscriptionInfo
cache *ccache.Cache
cacheTTL time.Duration
}

type subscriptionInfo struct {
Expand Down Expand Up @@ -173,11 +178,11 @@ func (e *Ethereum) VerifierType() core.VerifierType {
return core.VerifierTypeEthAddress
}

func (e *Ethereum) Init(ctx context.Context, config config.Section, metrics metrics.Manager) (err error) {
e.InitConfig(config)
func (e *Ethereum) Init(ctx context.Context, conf config.Section, metrics metrics.Manager) (err error) {
e.InitConfig(conf)
ethconnectConf := e.ethconnectConf
addressResolverConf := config.SubSection(AddressResolverConfigKey)
fftmConf := config.SubSection(FFTMConfigKey)
addressResolverConf := conf.SubSection(AddressResolverConfigKey)
fftmConf := conf.SubSection(FFTMConfigKey)

e.ctx = log.WithLogField(ctx, "proto", "ethereum")
e.metrics = metrics
Expand Down Expand Up @@ -216,7 +221,10 @@ func (e *Ethereum) Init(ctx context.Context, config config.Section, metrics metr
return err
}

e.streams = newStreamManager(e.client)
e.cacheTTL = config.GetDuration(coreconfig.CacheBlockchainTTL)
e.cache = ccache.New(ccache.Configure().MaxSize(config.GetByteSize(coreconfig.CacheBlockchainSize)))

e.streams = newStreamManager(e.client, e.cache, e.cacheTTL)
batchSize := ethconnectConf.GetUint(EthconnectConfigBatchSize)
batchTimeout := uint(ethconnectConf.GetDuration(EthconnectConfigBatchTimeout).Milliseconds())
stream, err := e.streams.ensureEventStream(e.ctx, e.topic, batchSize, batchTimeout)
Expand Down Expand Up @@ -283,16 +291,15 @@ func (e *Ethereum) AddFireflySubscription(ctx context.Context, namespace string,
return sub.ID, nil
}

func (e *Ethereum) RemoveFireflySubscription(ctx context.Context, subID string) error {
func (e *Ethereum) RemoveFireflySubscription(ctx context.Context, subID string) {
// Don't actually delete the subscription from ethconnect, as this may be called while processing
// events from the subscription (and handling that scenario cleanly could be difficult for ethconnect).
// TODO: can old subscriptions be somehow cleaned up later?
if _, ok := e.subs[subID]; ok {
delete(e.subs, subID)
return nil
} else {
log.L(ctx).Debugf("Invalid subscription ID: %s", subID)
}

return i18n.NewError(ctx, coremsgs.MsgSubscriptionIDInvalid, subID)
}

func (e *Ethereum) afterConnect(ctx context.Context, w wsclient.WSClient) error {
Expand Down Expand Up @@ -360,7 +367,10 @@ func (e *Ethereum) handleBatchPinEvent(ctx context.Context, location *fftypes.JS
}

authorAddress := event.Output.GetString("author")
nsOrAction := event.Output.GetString("namespace")
nsOrAction := event.Output.GetString("action")
if nsOrAction == "" {
nsOrAction = event.Output.GetString("namespace")
}
sUUIDs := event.Output.GetString("uuids")
sBatchHash := event.Output.GetString("batchHash")
sPayloadRef := event.Output.GetString("payloadRef")
Expand Down Expand Up @@ -681,42 +691,80 @@ func (e *Ethereum) queryContractMethod(ctx context.Context, address string, abi
}

func (e *Ethereum) SubmitBatchPin(ctx context.Context, nsOpID string, signingKey string, batch *blockchain.BatchPin, location *fftypes.JSONAny) error {
ethLocation, err := parseContractLocation(ctx, location)
if err != nil {
return err
}

ethHashes := make([]string, len(batch.Contexts))
for i, v := range batch.Contexts {
ethHashes[i] = ethHexFormatB32(v)
}
var uuids fftypes.Bytes32
copy(uuids[0:16], (*batch.TransactionID)[:])
copy(uuids[16:32], (*batch.BatchID)[:])
input := []interface{}{
batch.Namespace,
ethHexFormatB32(&uuids),
ethHexFormatB32(batch.BatchHash),
batch.BatchPayloadRef,
ethHashes,
}

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

return e.invokeContractMethod(ctx, ethLocation.Address, signingKey, batchPinMethodABI, nsOpID, input, nil)
var input []interface{}
var method *abi.Entry

if version == 1 {
method = batchPinMethodABIV1
input = []interface{}{
batch.Namespace,
ethHexFormatB32(&uuids),
ethHexFormatB32(batch.BatchHash),
batch.BatchPayloadRef,
ethHashes,
}
} else {
method = batchPinMethodABI
input = []interface{}{
ethHexFormatB32(&uuids),
ethHexFormatB32(batch.BatchHash),
batch.BatchPayloadRef,
ethHashes,
}
}
return e.invokeContractMethod(ctx, ethLocation.Address, signingKey, method, nsOpID, input, nil)
}

func (e *Ethereum) SubmitNetworkAction(ctx context.Context, nsOpID string, signingKey string, action core.NetworkActionType, location *fftypes.JSONAny) error {
input := []interface{}{
blockchain.FireFlyActionPrefix + action,
ethHexFormatB32(nil),
ethHexFormatB32(nil),
"",
[]string{},
}
ethLocation, err := parseContractLocation(ctx, location)
if err != nil {
return err
}
return e.invokeContractMethod(ctx, ethLocation.Address, signingKey, batchPinMethodABI, nsOpID, input, nil)

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

var input []interface{}
var method *abi.Entry

if version == 1 {
method = batchPinMethodABIV1
input = []interface{}{
blockchain.FireFlyActionPrefix + action,
ethHexFormatB32(nil),
ethHexFormatB32(nil),
"",
[]string{},
}
} else {
method = networkActionMethodABI
input = []interface{}{
blockchain.FireFlyActionPrefix + action,
"",
}
}

return e.invokeContractMethod(ctx, ethLocation.Address, signingKey, method, nsOpID, input, nil)
}

func (e *Ethereum) InvokeContract(ctx context.Context, nsOpID string, signingKey string, location *fftypes.JSONAny, method *fftypes.FFIMethod, input map[string]interface{}, options map[string]interface{}) error {
Expand Down Expand Up @@ -860,12 +908,18 @@ func (e *Ethereum) GenerateFFI(ctx context.Context, generationRequest *fftypes.F
return ffi2abi.ConvertABIToFFI(ctx, generationRequest.Namespace, generationRequest.Name, generationRequest.Version, generationRequest.Description, input.ABI)
}

func (e *Ethereum) GetNetworkVersion(ctx context.Context, location *fftypes.JSONAny) (int, error) {
func (e *Ethereum) GetNetworkVersion(ctx context.Context, location *fftypes.JSONAny) (version int, err error) {
ethLocation, err := parseContractLocation(ctx, location)
if err != nil {
return 0, err
}

cacheKey := "version:" + ethLocation.Address
if cached := e.cache.Get(cacheKey); cached != nil {
cached.Extend(e.cacheTTL)
return cached.Value().(int), nil
}

res, err := e.queryContractMethod(ctx, ethLocation.Address, networkVersionMethodABI, []interface{}{}, nil)
if err != nil || !res.IsSuccess() {
// "Call failed" is interpreted as "method does not exist, default to version 1"
Expand All @@ -878,7 +932,17 @@ func (e *Ethereum) GetNetworkVersion(ctx context.Context, location *fftypes.JSON
if err = json.Unmarshal(res.Body(), output); err != nil {
return 0, err
}
return strconv.Atoi(output.Output.(string))

switch result := output.Output.(type) {
case string:
version, err = strconv.Atoi(result)
if err == nil {
e.cache.Set(cacheKey, version, e.cacheTTL)
}
default:
err = i18n.NewError(ctx, coremsgs.MsgBadNetworkVersion, output.Output)
}
return version, err
}

func (e *Ethereum) GetAndConvertDeprecatedContractConfig(ctx context.Context) (location *fftypes.JSONAny, fromBlock string, err error) {
Expand Down
Loading