@quantnetwork/overledger-dlt-ethereum
Overledger SDK module for interaction with the Ethereum distributed ledger technology.
Installation
Install using npm:
npm install @quantnetwork/overledger-dlt-ethereum
Or, if you prefer using yarn:
yarn add @quantnetwork/overledger-dlt-ethereum
API Reference
Modules
Typedefs
-
CordaParam :
Object -
A description of an Corda smart contract function parameter.
overledger-dlt-corda
-
-
static
-
inner
-
-
overledger-dlt-corda.CordaTypeOptions
overledger-dlt-corda.default
Development package for Corda.
overledger-dlt-corda~Corda
new Corda(sdk)
| Param | Type | Description |
|---|---|---|
| sdk | any |
the sdk instance |
corda.name
Name of the DLT
corda.symbol
Symbol of the DLT
corda.createAccount()
Create an Corda account
Returns: Account - the new Corda account
corda.setAccount(accountInfo)
| Param | Type | Description |
|---|---|---|
| accountInfo | Account |
The standardised account information |
Set an account for this specific DLT
corda.buildTransaction()
Takes the Overledger definition of a transaction and converts it into a specific Corda transaction
corda.buildWorkflow(thisTransaction)
| Param | Type | Description |
|---|---|---|
| thisTransaction | WorkflowCorda |
details on the information to include in this workflow for the Corda distributed ledger node |
Takes the Overledger definition of a Corda workflow and converts it into a specific Corda Workflow
Returns: Workflow - the Corda transaction
corda.create_UUID()
Creates a new UUID
corda._transactionValidation()
validates an OVL transactionRequest according to Corda specific rules
corda.getTransactionQueryInfo()
Get the information required to query for a particular transaction hash
corda.workflowValidation(thisWorkflow)
| Param | Type | Description |
|---|---|---|
| thisWorkflow | WorkflowCorda |
The workflow details |
validates an OVL Corda workflow according to Corda specific rules
corda._sign(thisTransaction)
| Param | Type | Description |
|---|---|---|
| thisTransaction | TransactionRequest |
an instantiated overledger definition of an Corda transaction |
Takes in an overledger definition of a transaction for Corda, converts it into a form that the Corda distributed ledger will understand, and then signs the transaction
corda._smartContractQueryValidation()
validates an OVL smart contract query according to Corda specific rules
corda._buildSmartContractQuery()
Allows a user to build a smart contract query for the Corda distributed ledger
CordaParam
Properties
| Name | Type | Description |
|---|---|---|
| type | object |
information on the selectedType from the valid options. If an integer or byte type was chosen then further information is required on the exact number of bytes being used. If an integer is used, then selectedIntegerLength is required. If a byte is used then selectedBytesLength is required |
| value | object |
information on the parameter's value |
| name | string |
the parameter's name |
A description of an Corda smart contract function parameter.