Class NetworkFactory

Hierarchy

Model<NetworkFactoryMethods>
- NetworkFactory

Implements

Deployable

Constructors

constructor

new NetworkFactory(web3Connection: Web3Connection, contractAddress?: string): NetworkFactory

Overrides Model.constructor
- Defined in src/models/network-factory.ts:16
Parameters
- web3Connection: Web3Connection
- Optional contractAddress: string
Returns NetworkFactory

Properties

Protected _contract

_contract: Web3Contract<NetworkFactoryMethods, any>

Private _erc20

_erc20: ERC20

Readonly abi

abi: AbiItem[]

Optional Readonly contractAddress

contractAddress?: string

Accessors

account

get account(): Account

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

Returns Account

Protected connection

get connection(): Web3Connection

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

Returns Web3Connection

contract

get contract(): Web3Contract<Methods, any>

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

Returns Web3Contract<Methods, any>

erc20

get erc20(): ERC20

- Defined in src/models/network-factory.ts:14
Returns ERC20

web3

get web3(): default

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

Returns default

Methods

OPERATOR_AMOUNT

OPERATOR_AMOUNT(): Promise<string>

- Defined in src/models/network-factory.ts:40
Returns Promise<string>

approveSettlerERC20Token

approveSettlerERC20Token(): Promise<TransactionReceipt<any>>

- Defined in src/models/network-factory.ts:48
Returns Promise<TransactionReceipt<any>>

callTx

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

Inherited from Model.callTx
- 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>

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

Returns Promise<boolean>

createNetwork

createNetwork(erc20: string, transactionalToken: string): Promise<TransactionReceipt<any>>

- Defined in src/models/network-factory.ts:71
Parameters
- erc20: string
- transactionalToken: string
Returns Promise<TransactionReceipt<any>>

Protected deploy

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

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

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

deployJsonAbi

deployJsonAbi(erc20ContractAddress: string): Promise<TransactionReceipt<any>>

Implementation of Deployable.deployJsonAbi
- Defined in src/models/network-factory.ts:88
Parameters
- erc20ContractAddress: string
Returns Promise<TransactionReceipt<any>>

getAmountOfNetworksForked

getAmountOfNetworksForked(): Promise<number>

- Defined in src/models/network-factory.ts:28
Returns Promise<number>

getBEPROLocked

getBEPROLocked(): Promise<string>

- Defined in src/models/network-factory.ts:32
Returns Promise<string>

getLockedStakedByAddress

getLockedStakedByAddress(address: string): Promise<string>

- Defined in src/models/network-factory.ts:36
Parameters
- address: string
Returns Promise<string>

getNetworkByAddress

getNetworkByAddress(address: string): Promise<string>

- Defined in src/models/network-factory.ts:20
Parameters
- address: string
Returns Promise<string>

getNetworkById

getNetworkById(id: number): Promise<string>

- Defined in src/models/network-factory.ts:24
Parameters
- id: number
Returns Promise<string>

getSettlerTokenAddress

getSettlerTokenAddress(): Promise<string>

- Defined in src/models/network-factory.ts:56
Returns Promise<string>

isApprovedSettlerToken

isApprovedSettlerToken(address?: string, amount: number): Promise<boolean>

- Defined in src/models/network-factory.ts:52
Parameters
- address: string = ...
- amount: number
Returns Promise<boolean>

isOperator

isOperator(address: string): Promise<boolean>

- Defined in src/models/network-factory.ts:44
Parameters
- address: string
Returns Promise<boolean>

loadAbi

loadAbi(): void

Inherited from Model.loadAbi
- 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(): Promise<void>

Overrides Model.loadContract
- Defined in src/models/network-factory.ts:80
Preferred way of initializing and loading a contract

Returns Promise<void>

lock

lock(amount: string | number): Promise<TransactionReceipt<any>>

- Defined in src/models/network-factory.ts:60
Parameters
- amount: string | number
Returns Promise<TransactionReceipt<any>>

sendTx

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

Inherited from Model.sendTx
- 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>>

Inherited from Model.sendUnsignedTx
- 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>

Overrides Model.start
- Defined in src/models/network-factory.ts:75
Alias for Web3Connection.start(); Will load contract if success

Returns Promise<void>

unlock

unlock(): Promise<TransactionReceipt<any>>

- Defined in src/models/network-factory.ts:67
Returns Promise<TransactionReceipt<any>>

Generated using TypeDoc