ethereum

package
v1.1.0-rc.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 9, 2022 License: Apache-2.0 Imports: 25 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// EthconnectConfigKey is a sub-key in the config to contain all the ethconnect specific config
	EthconnectConfigKey = "ethconnect"
	// EthconnectConfigTopic is the websocket listen topic that the node should register on, which is important if there are multiple
	// nodes using a single ethconnect
	EthconnectConfigTopic = "topic"
	// EthconnectConfigBatchSize is the batch size to configure on event streams, when auto-defining them
	EthconnectConfigBatchSize = "batchSize"
	// EthconnectConfigBatchTimeout is the batch timeout to configure on event streams, when auto-defining them
	EthconnectConfigBatchTimeout = "batchTimeout"
	// EthconnectPrefixShort is used in the query string in requests to ethconnect
	EthconnectPrefixShort = "prefixShort"
	// EthconnectPrefixLong is used in HTTP headers in requests to ethconnect
	EthconnectPrefixLong = "prefixLong"
	// EthconnectConfigInstanceDeprecated is the ethereum address of the FireFly contract
	EthconnectConfigInstanceDeprecated = "instance"
	// EthconnectConfigFromBlockDeprecated is the configuration of the first block to listen to when creating the listener for the FireFly contract
	EthconnectConfigFromBlockDeprecated = "fromBlock"

	// AddressResolverConfigKey is a sub-key in the config to contain an address resolver config.
	AddressResolverConfigKey = "addressResolver"
	// AddressResolverRetainOriginal when true the original pre-resolved string is retained after the lookup, and passed down to Ethconnect as the from address
	AddressResolverRetainOriginal = "retainOriginal"
	// AddressResolverMethod the HTTP method to use to call the address resolver (default GET)
	AddressResolverMethod = "method"
	// AddressResolverURLTemplate the URL go template string to use when calling the address resolver
	AddressResolverURLTemplate = "urlTemplate"
	// AddressResolverBodyTemplate the body go template string to use when calling the address resolver
	AddressResolverBodyTemplate = "bodyTemplate"
	// AddressResolverResponseField the name of a JSON field that is provided in the response, that contains the ethereum address (default "address")
	AddressResolverResponseField = "responseField"

	// FFTMConfigKey is a sub-key in the config that optionally contains FireFly transaction connection information
	FFTMConfigKey = "fftm"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type EthconnectMessageHeaders added in v0.13.0

type EthconnectMessageHeaders struct {
	Type string `json:"type,omitempty"`
	ID   string `json:"id,omitempty"`
}

type EthconnectMessageRequest added in v0.13.0

type EthconnectMessageRequest struct {
	Headers EthconnectMessageHeaders `json:"headers,omitempty"`
	To      string                   `json:"to"`
	From    string                   `json:"from,omitempty"`
	Method  *abi.Entry               `json:"method"`
	Params  []interface{}            `json:"params"`
}

type Ethereum

type Ethereum struct {
	// contains filtered or unexported fields
}

func (*Ethereum) AddContractListener added in v0.14.0

func (e *Ethereum) AddContractListener(ctx context.Context, listener *core.ContractListenerInput) error

func (*Ethereum) AddFireflySubscription added in v1.1.0

func (e *Ethereum) AddFireflySubscription(ctx context.Context, namespace *core.Namespace, location *fftypes.JSONAny, firstEvent string) (string, error)

func (*Ethereum) Capabilities

func (e *Ethereum) Capabilities() *blockchain.Capabilities

func (*Ethereum) DeleteContractListener added in v0.14.0

func (e *Ethereum) DeleteContractListener(ctx context.Context, subscription *core.ContractListener) error

func (*Ethereum) GenerateEventSignature added in v1.0.0

func (e *Ethereum) GenerateEventSignature(ctx context.Context, event *fftypes.FFIEventDefinition) string

func (*Ethereum) GenerateFFI added in v0.13.1

func (e *Ethereum) GenerateFFI(ctx context.Context, generationRequest *fftypes.FFIGenerationRequest) (*fftypes.FFI, error)

func (*Ethereum) GetAndConvertDeprecatedContractConfig added in v1.1.0

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

func (*Ethereum) GetContractListenerStatus added in v1.1.0

func (e *Ethereum) GetContractListenerStatus(ctx context.Context, subID string) (status interface{}, err error)

func (*Ethereum) GetFFIParamValidator added in v0.12.0

func (e *Ethereum) GetFFIParamValidator(ctx context.Context) (fftypes.FFIParamValidator, error)

func (*Ethereum) GetNetworkVersion added in v1.1.0

func (e *Ethereum) GetNetworkVersion(ctx context.Context, location *fftypes.JSONAny) (version int, err error)

func (*Ethereum) Init

func (e *Ethereum) Init(ctx context.Context, cancelCtx context.CancelFunc, conf config.Section, metrics metrics.Manager, cacheManager cache.Manager) (err error)

func (*Ethereum) InitConfig added in v1.1.0

func (e *Ethereum) InitConfig(config config.Section)

func (*Ethereum) InvokeContract added in v0.12.0

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

func (*Ethereum) Name

func (e *Ethereum) Name() string

func (*Ethereum) NormalizeContractLocation added in v1.0.0

func (e *Ethereum) NormalizeContractLocation(ctx context.Context, location *fftypes.JSONAny) (result *fftypes.JSONAny, err error)

func (*Ethereum) NormalizeSigningKey added in v0.14.0

func (e *Ethereum) NormalizeSigningKey(ctx context.Context, key string) (string, error)

func (*Ethereum) QueryContract added in v0.12.0

func (e *Ethereum) QueryContract(ctx context.Context, location *fftypes.JSONAny, method *fftypes.FFIMethod, input map[string]interface{}, options map[string]interface{}) (interface{}, error)

func (*Ethereum) RemoveFireflySubscription added in v1.1.0

func (e *Ethereum) RemoveFireflySubscription(ctx context.Context, subID string)

func (*Ethereum) SetHandler added in v1.1.0

func (e *Ethereum) SetHandler(namespace string, handler blockchain.Callbacks)

func (*Ethereum) SetOperationHandler added in v1.1.0

func (e *Ethereum) SetOperationHandler(namespace string, handler core.OperationCallbacks)

func (*Ethereum) Start

func (e *Ethereum) Start() (err error)

func (*Ethereum) SubmitBatchPin

func (e *Ethereum) SubmitBatchPin(ctx context.Context, nsOpID, networkNamespace, signingKey string, batch *blockchain.BatchPin, location *fftypes.JSONAny) error

func (*Ethereum) SubmitNetworkAction added in v1.1.0

func (e *Ethereum) SubmitNetworkAction(ctx context.Context, nsOpID string, signingKey string, action core.NetworkActionType, location *fftypes.JSONAny) error

func (*Ethereum) VerifierType added in v0.14.0

func (e *Ethereum) VerifierType() core.VerifierType

type FFIGenerationInput added in v0.14.0

type FFIGenerationInput struct {
	ABI *abi.ABI `json:"abi,omitempty"`
}

type ListenerCheckpoint added in v1.1.0

type ListenerCheckpoint struct {
	Block            int64 `json:"block"`
	TransactionIndex int64 `json:"transactionIndex"`
	LogIndex         int64 `json:"logIndex"`
}

type ListenerStatus added in v1.1.0

type ListenerStatus struct {
	Checkpoint ListenerCheckpoint `json:"checkpoint"`
	Catchup    bool               `json:"catchup"`
}

type Location added in v0.12.0

type Location struct {
	Address string `json:"address"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL