Class Network

Hierarchy

Model<NetworkMethods>
- Network

Implements

Deployable

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Network(web3Connection: Web3Connection | Web3ConnectionOptions, contractAddress?: string): Network

Overrides Model.constructor
- Defined in src/models/network.ts:26
Parameters
- web3Connection: Web3Connection | Web3ConnectionOptions
- Optional contractAddress: string
Returns Network

Properties

Protected _contract

_contract: Web3Contract<NetworkMethods, any>

Private _settlerToken

_settlerToken: ERC20

Private _transactionToken

_transactionToken: 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>

settlerToken

get settlerToken(): ERC20

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

transactionToken

get transactionToken(): ERC20

- Defined in src/models/network.ts:23
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

COUNCIL_AMOUNT

COUNCIL_AMOUNT(): Promise<string>

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

approveSettlerERC20Token

approveSettlerERC20Token(amount?: string | number, address?: string): Promise<TransactionReceipt<any>>

- Defined in src/models/network.ts:162
Parameters
- Optional amount: string | number
- address: string = ...
Returns Promise<TransactionReceipt<any>>

approveTransactionalERC20Token

approveTransactionalERC20Token(amount?: string | number, address?: string): Promise<TransactionReceipt<any>>

- Defined in src/models/network.ts:169
Parameters
- Optional amount: string | number
- address: string = ...
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>

changeCouncilAmount

changeCouncilAmount(value: string): Promise<TransactionReceipt<any>>

- Defined in src/models/network.ts:123
Parameters
- value: string
Returns Promise<TransactionReceipt<any>>

changeDisputableTime

changeDisputableTime(amount: number): Promise<TransactionReceipt<any>>

- Defined in src/models/network.ts:132
Parameters
- amount: number
Returns Promise<TransactionReceipt<any>>

changeRedeemTime

changeRedeemTime(amount: number): Promise<TransactionReceipt<any>>

- Defined in src/models/network.ts:128
Parameters
- amount: number
Returns Promise<TransactionReceipt<any>>

closeIssue

closeIssue(id: number, mergeId: number): Promise<TransactionReceipt<any>>

- Defined in src/models/network.ts:229
Parameters
- id: number
- mergeId: number
Returns Promise<TransactionReceipt<any>>

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>

delegateOracles

delegateOracles(amount: string | number, delegateTo: string): Promise<TransactionReceipt<any>>

- Defined in src/models/network.ts:200
Parameters
- amount: string | number
- delegateTo: 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(settlerAddress: string, transactionalAddress: string, governanceAddress: string): Promise<TransactionReceipt<any>>

Implementation of Deployable.deployJsonAbi
- Defined in src/models/network.ts:269
Parameters
- settlerAddress: string
- transactionalAddress: string
- governanceAddress: string
Returns Promise<TransactionReceipt<any>>

disputableTime

disputableTime(): Promise<number>

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

disputeMerge

disputeMerge(id: number, mergeId: number): Promise<TransactionReceipt<any>>

- Defined in src/models/network.ts:233
Parameters
- id: number
- mergeId: number
Returns Promise<TransactionReceipt<any>>

disputesForMergeByAddress

disputesForMergeByAddress(issueId: number, proposalId: number, address: string): Promise<number>

- Defined in src/models/network.ts:95
Parameters
- issueId: number
- proposalId: number
- address: string
Returns Promise<number>

getAmountOfIssuesClosed

getAmountOfIssuesClosed(): Promise<number>

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

getAmountOfIssuesOpened

getAmountOfIssuesOpened(): Promise<number>

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

getBEPROStaked

getBEPROStaked(): Promise<string>

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

getCloseIssueEvents

getCloseIssueEvents(filter: PastEventOptions): Promise<XEvents<CloseIssueEvent>[]>

- Defined in src/models/network.ts:279
Parameters
- filter: PastEventOptions
Returns Promise<XEvents<CloseIssueEvent>[]>

getDisputeMergeEvents

getDisputeMergeEvents(filter: PastEventOptions): Promise<XEvents<DisputeMergeEvent>[]>

- Defined in src/models/network.ts:283
Parameters
- filter: PastEventOptions
Returns Promise<XEvents<DisputeMergeEvent>[]>

getGovernorTransferredEvents

getGovernorTransferredEvents(filter: PastEventOptions): Promise<XEvents<GovernorTransferredEvent>[]>

- Defined in src/models/network.ts:287
Parameters
- filter: PastEventOptions
Returns Promise<XEvents<GovernorTransferredEvent>[]>

getIssueByCID

getIssueByCID(cid: string): Promise<NetworkIssue>

- Defined in src/models/network.ts:148
Parameters
- cid: string
Returns Promise<NetworkIssue>

getIssueById

getIssueById(id: number): Promise<NetworkIssue>

- Defined in src/models/network.ts:152
Parameters
- id: number
Returns Promise<NetworkIssue>

getIssuesByAddress

getIssuesByAddress(address: string): Promise<number[]>

- Defined in src/models/network.ts:38
Parameters
- address: string
Returns Promise<number[]>

getMergeById

getMergeById(issueId: number, mergeId: number): Promise<any>

- Defined in src/models/network.ts:157
Parameters
- issueId: number
- mergeId: number
Returns Promise<any>

getMergeProposalCreatedEvents

getMergeProposalCreatedEvents(filter: PastEventOptions): Promise<XEvents<MergeProposalCreatedEvent>[]>

- Defined in src/models/network.ts:291
Parameters
- filter: PastEventOptions
Returns Promise<XEvents<MergeProposalCreatedEvent>[]>

getOpenIssueEvents

getOpenIssueEvents(filter: PastEventOptions): Promise<XEvents<OpenIssueEvent>[]>

- Defined in src/models/network.ts:295
Parameters
- filter: PastEventOptions
Returns Promise<XEvents<OpenIssueEvent>[]>

getOraclesByAddress

getOraclesByAddress(address: string): Promise<string>

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

getOraclesSummary

getOraclesSummary(address: string): Promise<OraclesSummary>

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

getPausedEvents

getPausedEvents(filter: PastEventOptions): Promise<XEvents<PausedEvent>[]>

- Defined in src/models/network.ts:299
Parameters
- filter: PastEventOptions
Returns Promise<XEvents<PausedEvent>[]>

getRecognizedAsFinishedEvents

getRecognizedAsFinishedEvents(filter: PastEventOptions): Promise<XEvents<RecognizedAsFinishedEvent>[]>

- Defined in src/models/network.ts:303
Parameters
- filter: PastEventOptions
Returns Promise<XEvents<RecognizedAsFinishedEvent>[]>

getRedeemIssueEvents

getRedeemIssueEvents(filter: PastEventOptions): Promise<XEvents<RedeemIssueEvent>[]>

- Defined in src/models/network.ts:307
Parameters
- filter: PastEventOptions
Returns Promise<XEvents<RedeemIssueEvent>[]>

getSettlerTokenAddress

getSettlerTokenAddress(): Promise<string>

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

getTokensStaked

getTokensStaked(): Promise<string>

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

getTransactionTokenAddress

getTransactionTokenAddress(): Promise<string>

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

getUnpausedEvents

getUnpausedEvents(filter: PastEventOptions): Promise<XEvents<UnpausedEvent>[]>

- Defined in src/models/network.ts:311
Parameters
- filter: PastEventOptions
Returns Promise<XEvents<UnpausedEvent>[]>

isApprovedSettlerToken

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

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

isApprovedTransactionalToken

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

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

isCouncil

isCouncil(address: string): Promise<boolean>

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

isIssueInDraft

isIssueInDraft(issueId: number): Promise<boolean>

- Defined in src/models/network.ts:136
Parameters
- issueId: number
Returns Promise<boolean>

isMergeDisputed

isMergeDisputed(issueId: number, mergeId: number): Promise<boolean>

- Defined in src/models/network.ts:140
Parameters
- issueId: number
- mergeId: number
Returns Promise<boolean>

isMergeInDraft

isMergeInDraft(id: number, mergeId: number): Promise<boolean>

- Defined in src/models/network.ts:144
Parameters
- id: number
- mergeId: number
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.ts:251
Preferred way of initializing and loading a contract

Returns Promise<void>

lock

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

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

mergeCreatorFeeShare

mergeCreatorFeeShare(): Promise<number>

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

openIssue

openIssue(cid: string, amount: string | number): Promise<TransactionReceipt<any>>

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

percentageNeededForDispute

percentageNeededForDispute(): Promise<number>

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

proposeIssueMerge

proposeIssueMerge(id: number, prAddresses: string[], prAmounts: number[]): Promise<TransactionReceipt<any>>

- Defined in src/models/network.ts:237
Parameters
- id: number
- prAddresses: string[]
- prAmounts: number[]
Returns Promise<TransactionReceipt<any>>

recognizeAsFinished

recognizeAsFinished(id: number): Promise<TransactionReceipt<any>>

- Defined in src/models/network.ts:221
Parameters
- id: number
Returns Promise<TransactionReceipt<any>>

redeemIssue

redeemIssue(id: number): Promise<TransactionReceipt<any>>

- Defined in src/models/network.ts:225
Parameters
- id: number
Returns Promise<TransactionReceipt<any>>

redeemTime

redeemTime(): Promise<number>

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

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.ts:246
Alias for Web3Connection.start(); Will load contract if success

Returns Promise<void>

unlock

unlock(amount: string | number, from: string): Promise<TransactionReceipt<any>>

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

updateIssue

updateIssue(id: number, amount: string | number): Promise<TransactionReceipt<any>>

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

Generated using TypeDoc