Class Network_Registry

Hierarchy

Model<Network_RegistryMethods>
- Network_Registry
  - NetworkRegistry

Implements

Deployable

Constructors

constructor

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

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

Properties

Private _DIVISOR

_DIVISOR: number

Private _bountyToken

_bountyToken: BountyToken

Protected _contract

_contract: Web3Contract<Network_RegistryMethods, any>

Private _governed

_governed: Governed

Private _token

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

bountyToken

get bountyToken(): BountyToken

- Defined in src/models/network-registry.ts:27
Returns BountyToken

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>

divisor

get divisor(): number

- Defined in src/models/network-registry.ts:28
Returns number

governed

get governed(): Governed

- Defined in src/models/network-registry.ts:26
Returns Governed

token

get token(): ERC20

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

addAllowedTokens

addAllowedTokens(addresses: string[], isTransactional: boolean): Promise<TransactionReceipt<any>>

- Defined in src/models/network-registry.ts:153
Parameters
- addresses: string[]
- isTransactional: boolean
Returns Promise<TransactionReceipt<any>>

amountOfNetworks

amountOfNetworks(): Promise<number>

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

bountyTokenAddress

bountyTokenAddress(): Promise<string>

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

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>

changeAmountForNetworkCreation

changeAmountForNetworkCreation(newAmount: string | number): Promise<TransactionReceipt<any>>

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

changeGlobalFees

changeGlobalFees(closeFee: number, cancelFee: number): Promise<TransactionReceipt<any>>

- Defined in src/models/network-registry.ts:149
Parameters
- closeFee: number
- cancelFee: number
Returns Promise<TransactionReceipt<any>>

changeNetworkCreationFee

changeNetworkCreationFee(newAmount: number): Promise<TransactionReceipt<any>>

- Defined in src/models/network-registry.ts:145
Parameters
- newAmount: 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>

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(_erc20: string, _lockAmountForNetworkCreation: number, treasury: string, lockFeePercentage: number, closeFee?: number, cancelFee?: number, bountyToken?: string): Promise<TransactionReceipt<any>>

Implementation of Deployable.deployJsonAbi
- Defined in src/models/network-registry.ts:56
Parameters
- _erc20: string
- _lockAmountForNetworkCreation: number
- treasury: string
- lockFeePercentage: number
- closeFee: number = 10000
- cancelFee: number = 20000
- bountyToken: string = nativeZeroAddress
Returns Promise<TransactionReceipt<any>>

erc20

erc20(): Promise<string>

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

getAllowedTokenLen

getAllowedTokenLen(): Promise<number[]>

- Defined in src/models/network-registry.ts:161
Returns Promise<number[]>

getAllowedTokens

getAllowedTokens(): Promise<{ reward: string[]; transactional: string[] }>

- Defined in src/models/network-registry.ts:168
Returns Promise<{ reward: string[]; transactional: string[] }>

getChangeAllowedTokensEvents

getChangeAllowedTokensEvents(filter: PastEventOptions): XPromiseEvent<ChangeAllowedTokensEvent>

- Defined in src/models/network-registry.ts:202
Parameters
- filter: PastEventOptions
Returns XPromiseEvent<ChangeAllowedTokensEvent>

getChangedFeeEvent

getChangedFeeEvent(filter: PastEventOptions): XPromiseEvent<ChangedFeeEvent>

- Defined in src/models/network-registry.ts:199
Parameters
- filter: PastEventOptions
Returns XPromiseEvent<ChangedFeeEvent>

getDivisor

getDivisor(): Promise<number>

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

getGovernorTransferredEvents

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

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

getLockFeeChangedEvents

getLockFeeChangedEvents(filter: PastEventOptions): XPromiseEvent<LockFeeChangedEvent>

- Defined in src/models/network-registry.ts:205
Parameters
- filter: PastEventOptions
Returns XPromiseEvent<LockFeeChangedEvent>

getMAX_LOCK_PERCENTAGE_FEE

getMAX_LOCK_PERCENTAGE_FEE(): Promise<number>

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

getNetworkClosedEvents

getNetworkClosedEvents(filter: PastEventOptions): Promise<XEvents<NetworkClosedEvent>[]>

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

getNetworkRegisteredEvents

getNetworkRegisteredEvents(filter: PastEventOptions): Promise<XEvents<NetworkRegisteredEvent>[]>

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

getUserLockedAmountChangedEvents

getUserLockedAmountChangedEvents(filter: PastEventOptions): XPromiseEvent<UserLockedAmountChangedEvent>

- Defined in src/models/network-registry.ts:196
Parameters
- filter: PastEventOptions
Returns XPromiseEvent<UserLockedAmountChangedEvent>

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-registry.ts:39
Preferred way of initializing and loading a contract

Returns Promise<void>

lock

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

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

lockAmountForNetworkCreation

lockAmountForNetworkCreation(): Promise<string>

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

lockedTokensOfAddress

lockedTokensOfAddress(v1: string): Promise<string>

- Defined in src/models/network-registry.ts:98
Parameters
- v1: string
Returns Promise<string>

networkCreationFeePercentage

networkCreationFeePercentage(): Promise<number>

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

networkOfAddress

networkOfAddress(v1: string): Promise<string>

- Defined in src/models/network-registry.ts:103
Parameters
- v1: string
Returns Promise<string>

networksArray

networksArray(v1: number): Promise<string>

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

registerNetwork

registerNetwork(networkAddress: string): Promise<TransactionReceipt<any>>

- Defined in src/models/network-registry.ts:136
Parameters
- networkAddress: string
Returns Promise<TransactionReceipt<any>>

removeAllowedTokens

removeAllowedTokens(addresses: string[], isTransactional: boolean): Promise<TransactionReceipt<any>>

- Defined in src/models/network-registry.ts:157
Parameters
- addresses: string[]
- isTransactional: boolean
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-registry.ts:34
Alias for Web3Connection.start(); Will load contract if success

Returns Promise<void>

totalLockedAmount

totalLockedAmount(): Promise<string>

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

treasury

treasury(): Promise<string>

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

unlock

unlock(): Promise<TransactionReceipt<any>>

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

Generated using TypeDoc