Class EthereumHelpers

Ethereum Util class for Ethereum related Atomex helper functions

Hierarchy

Helpers
- EthereumHelpers

Index

Constructors

constructor

Methods

Constructors

constructor

new EthereumHelpers(web3: default, jsonInterface: AbiItem[], contractAddress: string, timeBetweenBlocks: number, gasLimit: number): EthereumHelpers

Overrides Helpers.constructor
- Defined in ethereum.ts:31
Parameters
- web3: default
- jsonInterface: AbiItem[]
- contractAddress: string
- timeBetweenBlocks: number
- gasLimit: number
Returns EthereumHelpers

Methods

buildActivateTransaction

buildActivateTransaction(secretHash: string): PartialTransactionBody

- Defined in ethereum.ts:160
Get the tx data for Atomex Contract Activate Swap call

Parameters
- secretHash: string
Returns PartialTransactionBody
contract address and tx data that can be used to make a contract call

buildAddTransaction

buildAddTransaction(secretHash: string, amount: number): PartialTransactionBody

Overrides Helpers.buildAddTransaction
- Defined in ethereum.ts:142
Get the tx data for Atomex Contract AdditionalFunds call

Parameters
- secretHash: string
- amount: number
Returns PartialTransactionBody

buildInitiateTransaction

buildInitiateTransaction(initiateParameters: InitiateParameters): PartialTransactionBody

Overrides Helpers.buildInitiateTransaction
- Defined in ethereum.ts:97
Get the tx data for Atomex Contract Initiate Swap call

Parameters
- initiateParameters: InitiateParameters
Returns PartialTransactionBody

buildRedeemTransaction

buildRedeemTransaction(secret: string, hashedSecret: string): PartialTransactionBody

Overrides Helpers.buildRedeemTransaction
- Defined in ethereum.ts:121
Get the tx data for Atomex Contract Redeem Swap call

Parameters
- secret: string
- hashedSecret: string
Returns PartialTransactionBody

buildRefundTransaction

buildRefundTransaction(secretHash: string): PartialTransactionBody

Overrides Helpers.buildRefundTransaction
- Defined in ethereum.ts:134
Get the tx data for Atomex Contract Refund Swap call

Parameters
- secretHash: string
Returns PartialTransactionBody

encodePublicKey

encodePublicKey(pubKey: string): string

Overrides Helpers.encodePublicKey
- Defined in ethereum.ts:307
Encodes Public Key in a form compliant with Atomex

Parameters
- pubKey: string
Returns string

encodeSignature

encodeSignature(signature: string): string

Overrides Helpers.encodeSignature
- Defined in ethereum.ts:314
Encodes Signature in a form compliant with Atomex

Parameters
- signature: string
Returns string

estimateInitiateFees

estimateInitiateFees(source: string): Promise<number>

Overrides Helpers.estimateInitiateFees
- Defined in ethereum.ts:319
Estimates Initiate fees for a Swap

Parameters
- source: string
Returns Promise<number>

estimateRedeemFees

estimateRedeemFees(recipient: string): Promise<RedeemFees>

Overrides Helpers.estimateRedeemFees
- Defined in ethereum.ts:340
Estimates Miner Fee and Reward for Redeem to be used in a Swap

Parameters
- recipient: string
Returns Promise<RedeemFees>

getAuthMessage

getAuthMessage(message: string, address?: string): AuthMessage

Overrides Helpers.getAuthMessage
- Defined in ethereum.ts:87
Get the details needed for getAuthToken request

remarks
the msgToSign value needs to be signed before being used for Auth

Parameters
- message: string
- Optional address: string
Returns AuthMessage

isValidAddress

isValidAddress(address: string): boolean

Overrides Helpers.isValidAddress
- Defined in ethereum.ts:349
Check validity of an account address

Parameters
- address: string
Returns boolean

parseInitiateParameters

parseInitiateParameters(transaction: Transaction): InitiateParameters

- Defined in ethereum.ts:170
Parameters
- transaction: Transaction
Returns InitiateParameters

recoverPublicKey

recoverPublicKey(msg: string, signature: string): string

- Defined in ethereum.ts:295
Recover Ethereum Account Public Key from RLC signature

Parameters
- msg: string
  
  original message, msgToSign parameter generated using getAuthMessage
- signature: string
  
  signed message
Returns string
ethereum public key

validateInitiateTransaction

validateInitiateTransaction(_blockHeight: number, txID: string, secretHash: string, receivingAddress: string, amount: number, payoff: number, minRefundTimestamp: number, minConfirmations?: number): Promise<SwapTransactionStatus>

Overrides Helpers.validateInitiateTransaction
- Defined in ethereum.ts:198
Validate the Swap Details on chain using the tx detail from Atomex [does not check tx status, use status provided by atomex]

Parameters
- _blockHeight: number
- txID: string
- secretHash: string
- receivingAddress: string
- amount: number
- payoff: number
- minRefundTimestamp: number
- minConfirmations: number = 2
Returns Promise<SwapTransactionStatus>

Static create

create(network: "testnet" | "mainnet", rpcUri?: string): Promise<EthereumHelpers>

- Defined in ethereum.ts:61
Connects to the supported ethereum chain

Parameters
- network: "testnet" | "mainnet"
- Optional rpcUri: string
Returns Promise<EthereumHelpers>
chain id of the connected chain

Generated using TypeDoc