Class Model<Methods>

Type Parameters

Methods = any

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Model<Methods>(web3Connection: Web3Connection | Web3ConnectionOptions, abi: AbiItem[], contractAddress?: string): Model<Methods>

- Defined in src/base/model.ts:23
Type Parameters
- Methods = any
Parameters
- web3Connection: Web3Connection | Web3ConnectionOptions
- abi: AbiItem[]
- Optional contractAddress: string
Returns Model<Methods>

Properties

Protected _contract

_contract: Web3Contract<Methods, any>

Readonly abi

abi: AbiItem[]

Optional Readonly contractAddress

contractAddress?: string

Private Readonly web3Connection

web3Connection: Web3Connection

Accessors

account

get account(): Account

- Defined in src/base/model.ts:48
Returns the Account associated with this connection

Returns Account

Protected connection

get connection(): Web3Connection

- Defined in src/base/model.ts:38
Pointer to the Web3Connection assigned to this contract class

Returns Web3Connection

contract

get contract(): Web3Contract<Methods, any>

- Defined in src/base/model.ts:21
Returns the Web3Contract class representing this contract

Returns Web3Contract<Methods, any>

web3

get web3(): default

- Defined in src/base/model.ts:43
Returns the Web3 class assigned to this connection

Returns default

Methods

callTx

callTx<ReturnData>(method: ContractCallMethod<ReturnData>): Promise<ReturnData>

- Defined in src/base/model.ts:93
Return a property value from the contract

Type Parameters
- ReturnData = any
Parameters
- method: ContractCallMethod<ReturnData>
Returns Promise<ReturnData>

connect

connect(): Promise<boolean>

- Defined in src/base/model.ts:72
Alias for Web3Connection.connect(); Will load contract if success

Returns Promise<boolean>

Protected deploy

deploy(deployOptions: DeployOptions, account?: Account): Promise<TransactionReceipt<any>>

- Defined in src/base/model.ts:147
Deploy the loaded abi contract

Parameters
- deployOptions: DeployOptions
- Optional account: Account
Returns Promise<TransactionReceipt<any>>

loadAbi

loadAbi(): void

- Defined in src/base/model.ts:53
Permissive way of initializing the contract, used primarily for deploys. Prefer to use loadContract

Returns void

loadContract

loadContract(): void

- Defined in src/base/model.ts:61
Preferred way of initializing and loading a contract

throws
Errors.MissingContractAddress

Returns void

sendTx

sendTx(method: ContractSendMethod, value?: any): Promise<TransactionReceipt<any>>

- Defined in src/base/model.ts:100
Interact with, or change a value of, a property on the contract

Parameters
- method: ContractSendMethod
- Optional value: any
Returns Promise<TransactionReceipt<any>>

sendUnsignedTx

sendUnsignedTx(method: ContractSendMethod, value?: any, __namedParameters?: Partial<Web3ConnectionOptions>): Promise<TransactionReceipt<any>>

- Defined in src/base/model.ts:118
Send unsigned transaction

Parameters
- method: ContractSendMethod
- Optional value: any
- __namedParameters: Partial<Web3ConnectionOptions> = {}
Returns Promise<TransactionReceipt<any>>

start

start(): Promise<void>

- Defined in src/base/model.ts:85
Alias for Web3Connection.start(); Will load contract if success

Returns Promise<void>

Generated using TypeDoc