Class Web3Contract<Methods, Events>

Type Parameters

Methods = any
Events = any

Hierarchy

Web3Contract

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Web3Contract<Methods, Events>(web3: default, abi: AbiItem[], address?: string, options?: Web3ContractOptions): Web3Contract<Methods, Events>

- Defined in src/base/web3-contract.ts:55
Type Parameters
- Methods = any
- Events = any
Parameters
- web3: default
- abi: AbiItem[]
- Optional address: string
- options: Web3ContractOptions = ...
Returns Web3Contract<Methods, Events>

Properties

Readonly abi

abi: AbiItem[]

Optional Readonly address

address?: string

Readonly options

options: Web3ContractOptions = ...

Transaction options that will be used on each transaction. While this object is readonly, is values are not and can be changed.

example: myWeb3Connection.options.gas = 10000;
default: {auto: true}

Readonly self

self: Contract

Readonly web3

web3: default

Accessors

events

get events(): Events

- Defined in src/base/web3-contract.ts:65
Returns Events

methods

get methods(): Methods

- Defined in src/base/web3-contract.ts:64
Returns Methods

Methods

deploy

deploy(abi: AbiItem[], deployOptions: DeployOptions, account?: Account): Promise<TransactionReceipt<any>>

- Defined in src/base/web3-contract.ts:126
Deploys the new AbiItem and returns its transaction receipt

Parameters
- abi: AbiItem[]
- deployOptions: DeployOptions
- Optional account: Account
Returns Promise<TransactionReceipt<any>>

parseReceiptLogs

parseReceiptLogs<T>(receipt: TransactionReceipt<any>): TransactionReceipt<T>

- Defined in src/base/web3-contract.ts:97
Parses the logs of a transaction receipt using its abi events

Type Parameters
- T = any
Parameters
- receipt: TransactionReceipt<any>
Returns TransactionReceipt<T>

sendSignedTx

sendSignedTx(account: Account, data: string, value?: string, txOptions: Partial<TransactionConfig>, __namedParameters?: Partial<Web3ConnectionOptions>): Promise<TransactionReceipt<any>>

- Defined in src/base/web3-contract.ts:166
Sends a signed transaction with the provided account

Parameters
- account: Account
- data: string
- value: string = ...
- txOptions: Partial<TransactionConfig>
- __namedParameters: Partial<Web3ConnectionOptions> = {}
Returns Promise<TransactionReceipt<any>>

txOptions

txOptions(method: ContractSendMethod, value?: string, from?: string): Promise<{ gas: undefined | number; gasPrice: undefined | string }>

- Defined in src/base/web3-contract.ts:68
Parameters
- method: ContractSendMethod
- Optional value: string
- Optional from: string
Returns Promise<{ gas: undefined | number; gasPrice: undefined | string }>

Generated using TypeDoc