Connectors Reference

Ethereum Blockchain

Ethereum is a smart contract blockchain. With the Ethereum Blockchain connector, you can perform actions such as submitting transactions, reading contract state, and trigger flows on contract updates.

 

Status: Preview

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

TestConnection ()

Test connection

GetSmartContractProperties (string abi, string contractAddress)

Get smart contract state (all properties)

GetConstantSmartContractFunctionNames (string abi)

Get names of constant contract functions

GetMutableSmartFunctionNames (string abi)

Get names of mutable contract functions

GetSmartContractEvents (string abi)

Get list of smart contract events

GetSmartContractFunctionMetadata (string abi, string functionName)

Get smart contract function metadata

GetSmartContractConstructorMetadata (string abi)

Get smart contract constructor metadata

GetSmartContractPropertiesMetadata (string abi)

Get smart contract properties metadata

GetSmartContractEventMetadata (string abi, string eventName)

Get smart contract event metadata

GetSmartContractFunctionResultMetadata (string abi, string functionName)

Get query smart contract function result metadata

ExecuteSmartContractFunction (string abi, string contractAddress, string functionName, ExecuteSmartContractFunctionParameterParameters parameters)

Query smart contract function (incurring no gas cost)

DeployContract (string abi, DeployContractParameterParameters parameters, [advanced][Optional]string gasPrice, [advanced][Optional]string gasLimit, [advanced][Optional]string privateForKeyList)

Deploy smart contract

ExecuteContractFunction (string abi, string contractAddress, string functionName, ExecuteContractFunctionParameterParameters parameters, [advanced][Optional]string gasPrice, [advanced][Optional]string gasLimit, [advanced][Optional]string privateForKeyList)

Execute smart contract function (incurring gas cost)

 

Triggers:

Name

Summary

OnNewEvent ([Optional]string abi, [Optional]string contractAddress, [Optional]string eventName)

When a smart contract event occurs

 

Objects:

Name

Summary

DeployContractParameterParameters

 

DeploySmartContractResult

 

ExecuteContractFunctionParameterParameters

 

ExecuteSmartContractFunctionParameterParameters

 

ExecuteSmartContractFunctionResponse

 

ExecuteSmartContractFunctionResult

 

GetSmartContractPropertiesResponse

 

Object

 

OnNewEventResponse

 

SmartContractEvent

 

SmartContractEventMetadata

 

SmartContractFunction

 

SmartContractFunctionMetadata

 

SmartContractFunctionResultMetadata

 

SmartContractPropertiesMetadata

 

 

Actions:

TestConnection

Summary: Test connection

Description: Test the connection.

 

Syntax:

EthereumBlockchain.TestConnection ()

 

Returns:

 

GetSmartContractProperties

Summary: Get smart contract state (all properties)

Description: Get smart contract state (all properties).

 

Syntax:

EthereumBlockchain.GetSmartContractProperties (string abi, string contractAddress)

 

Parameters:

Name

Type

Summary

Required

Related Action

abi

string

(Contract ABI)

The smart contract ABI.

True

contractAddress

string

(Smart Contract Address)

The smart contract address.

True

 

Returns:

          Type:GetSmartContractPropertiesResponse

 

GetConstantSmartContractFunctionNames

Summary: Get names of constant contract functions

Description: Get names of constant contract functions.

 

Syntax:

EthereumBlockchain.GetConstantSmartContractFunctionNames (string abi)

 

Parameters:

Name

Type

Summary

Required

Related Action

abi

string

 

 

True

 

Returns:

          Type:array of (SmartContractFunction)

 

GetMutableSmartFunctionNames

Summary: Get names of mutable contract functions

Description: Get names of mutable contract functions.

 

Syntax:

EthereumBlockchain.GetMutableSmartFunctionNames (string abi)

 

Parameters:

Name

Type

Summary

Required

Related Action

abi

string

 

 

True

 

Returns:

          Type:array of (SmartContractFunction)

 

GetSmartContractEvents

Summary: Get list of smart contract events

Description: Get list of smart contract events.

 

Syntax:

EthereumBlockchain.GetSmartContractEvents (string abi)

 

Parameters:

Name

Type

Summary

Required

Related Action

abi

string

 

 

True

 

Returns:

          Type:array of (SmartContractEvent)

 

GetSmartContractFunctionMetadata

Summary: Get smart contract function metadata

Description: Get smart contract function metadata.

 

Syntax:

EthereumBlockchain.GetSmartContractFunctionMetadata (string abi, string functionName)

 

Parameters:

Name

Type

Summary

Required

Related Action

abi

string

 

 

True

functionName

string

(Smart Contract Function Name)

The function name.

True

 

Returns:

          Type:SmartContractFunctionMetadata

          Description: SmartContract Function Metadata

 

GetSmartContractConstructorMetadata

Summary: Get smart contract constructor metadata

Description: Get smart contract constructor metadata.

 

Syntax:

EthereumBlockchain.GetSmartContractConstructorMetadata (string abi)

 

Parameters:

Name

Type

Summary

Required

Related Action

abi

string

 

 

True

 

Returns:

          Type:SmartContractFunctionMetadata

          Description: SmartContract Function Metadata

 

GetSmartContractPropertiesMetadata

Summary: Get smart contract properties metadata

Description: Get smart contract properties metadata.

 

Syntax:

EthereumBlockchain.GetSmartContractPropertiesMetadata (string abi)

 

Parameters:

Name

Type

Summary

Required

Related Action

abi

string

 

 

True

 

Returns:

          Type:SmartContractPropertiesMetadata

          Description: SmartContract Properties Metadata

 

GetSmartContractEventMetadata

Summary: Get smart contract event metadata

Description: Get smart contract event metadata.

 

Syntax:

EthereumBlockchain.GetSmartContractEventMetadata (string abi, string eventName)

 

Parameters:

Name

Type

Summary

Required

Related Action

abi

string

 

 

True

eventName

string

(Event Name)

The name of the event.

True

 

Returns:

          Type:SmartContractEventMetadata

          Description: SmartContract Event Metadata

 

GetSmartContractFunctionResultMetadata

Summary: Get query smart contract function result metadata

Description: Get query smart contract function result metadata.

 

Syntax:

EthereumBlockchain.GetSmartContractFunctionResultMetadata (string abi, string functionName)

 

Parameters:

Name

Type

Summary

Required

Related Action

abi

string

 

 

True

functionName

string

(Smart Contract Function Name)

The name of the function.

True

 

Returns:

          Type:SmartContractFunctionResultMetadata

          Description: SmartContract function result metadata

 

ExecuteSmartContractFunction

Summary: Query smart contract function (incurring no gas cost)

Description: Query smart contract function (incurring no gas cost).

 

Syntax:

EthereumBlockchain.ExecuteSmartContractFunction (string abi, string contractAddress, string functionName, ExecuteSmartContractFunctionParameterParameters parameters)

 

Parameters:

Name

Type

Summary

Required

Related Action

abi

string

(Contract ABI)

The smart contract ABI.

True

contractAddress

string

(Smart Contract Address)

The smart contract address.

True

functionName

string

(Smart Contract Function Name)

The Function Name.

True

GetConstantSmartContractFunctionNames

parameters

ExecuteSmartContractFunctionParameterParameters

 

 

True

 

Returns:

          Type:ExecuteSmartContractFunctionResponse

 

DeployContract

Summary: Deploy smart contract

Description: Deploy smart contract.

 

Syntax:

EthereumBlockchain.DeployContract (string abi, DeployContractParameterParameters parameters, [advanced][Optional]string gasPrice, [advanced][Optional]string gasLimit, [advanced][Optional]string privateForKeyList)

 

Parameters:

Name

Type

Summary

Required

Related Action

abi

string

(Contract ABI)

The smart contract ABI.

True

parameters

DeployContractParameterParameters

 

 

True

gasPrice

string

(Gas Price in Wei)

Optional: gas price in wei in non-hex format.

False

gasLimit

string

(Gas Limit)

Optional: gas limit in non-hex format.

False

privateForKeyList

string

(Private For List)

[Quorum] Optional: list of public keys that are allowed to see this transaction (eg. Q2/x..., 2mN... ).

False

 

Returns:

          Type:DeploySmartContractResult

          Description: The deploy smart contract action result

 

ExecuteContractFunction

Summary: Execute smart contract function (incurring gas cost)

Description: Execute smart contract function (incurring gas cost).

 

Syntax:

EthereumBlockchain.ExecuteContractFunction (string abi, string contractAddress, string functionName, ExecuteContractFunctionParameterParameters parameters, [advanced][Optional]string gasPrice, [advanced][Optional]string gasLimit, [advanced][Optional]string privateForKeyList)

 

Parameters:

Name

Type

Summary

Required

Related Action

abi

string

(Contract ABI)

The smart contract ABI.

True

contractAddress

string

(Smart Contract Address)

The smart contract address.

True

functionName

string

(Smart Contract Function Name)

The name of the function to invoke.

True

GetMutableSmartFunctionNames

parameters

ExecuteContractFunctionParameterParameters

 

 

True

gasPrice

string

(Gas Price in Wei)

Optional: gas price in wei in non-hex format.

False

gasLimit

string

(Gas Limit)

Optional: gas limit in non-hex format.

False

privateForKeyList

string

(Private For List)

[Quorum] Optional: list of public keys that are allowed to see this transaction (eg. Q2/x..., 2mN... ).

False

 

Returns:

          Type:ExecuteSmartContractFunctionResult

          Description: The execute smart contract function action result

 

Triggers:

Trigger OnNewEvent

Summary: When a smart contract event occurs

Description: When a smart contract event occurs.

 

Syntax:

EthereumBlockchain.OnNewEvent ([Optional]string abi, [Optional]string contractAddress, [Optional]string eventName)

 

Parameters:

Name

Type

Summary

Required

Related Action

abi

string

(Contract ABI)

The smart contract ABI.

False

contractAddress

string

(Smart Contract Address)

The smart contract address.

False

eventName

string

(Event Name)

Event name.

False

GetSmartContractEvents

 

Returns:

          Type:OnNewEventResponse

 


 

DeployContractParameterParameters

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

DeploySmartContractResult

Summary:

Description: The deploy smart contract action result

 

          Properties:

Name

Type

Summary

ContractAddress

string

Smart Contract Address

The smart contract address

TransactionHash

string

Transaction Hash

The transaction hash


 

ExecuteContractFunctionParameterParameters

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

ExecuteSmartContractFunctionParameterParameters

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

ExecuteSmartContractFunctionResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

ExecuteSmartContractFunctionResult

Summary:

Description: The execute smart contract function action result

 

          Properties:

Name

Type

Summary

TransactionHash

string

Transaction Hash

The transaction hash


 

GetSmartContractPropertiesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

Object

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

OnNewEventResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

SmartContractEvent

Summary:

Description: Smart Contract Event

 

          Properties:

Name

Type

Summary

Name

string

Event Name

The Smart Contract Event Name


 

SmartContractEventMetadata

Summary:

Description: SmartContract Event Metadata

 

          Properties:

Name

Type

Summary

schema

Object

 

 


 

SmartContractFunction

Summary:

Description: Smart Contract Function and Parameters

 

          Properties:

Name

Type

Summary

Name

string

Smart Contract Function Name

The Smart Contract Function Name


 

SmartContractFunctionMetadata

Summary:

Description: SmartContract Function Metadata

 

          Properties:

Name

Type

Summary

name

string

 

Function name

title

string

 

Function title

schema

Object

 

 


 

SmartContractFunctionResultMetadata

Summary:

Description: SmartContract function result metadata

 

          Properties:

Name

Type

Summary

schema

Object

 

 


 

SmartContractPropertiesMetadata

Summary:

Description: SmartContract Properties Metadata

 

          Properties:

Name

Type

Summary

schema

Object