Network_v2 | @taikai/dappkit

Hierarchy

Model<Network_v2Methods>
- Network_v2

Implements

Deployable

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

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

Properties

Params

Params: { cancelableTime: number; councilAmount: number; disputableTime: number; draftTime: number; mergeCreatorFeeShare: number; oracleExchangeRate: number; percentageNeededForDispute: number; proposerFeeShare: number } = ...

Type declaration

cancelableTime: number
councilAmount: number
disputableTime: number
draftTime: number
mergeCreatorFeeShare: number
oracleExchangeRate: number
percentageNeededForDispute: number
proposerFeeShare: number

Private _DIVISOR

_DIVISOR: number

Protected _contract

_contract: Web3Contract<Network_v2Methods, any>

Private _governed

_governed: Governed

Private _networkToken

_networkToken: ERC20

Private _nftToken

_nftToken: BountyToken

Private _registry

_registry: NetworkRegistry

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>

divisor

get divisor(): number

- Defined in src/models/network-v2.ts:65
Returns number

governed

get governed(): Governed

- Defined in src/models/network-v2.ts:58
Access Governed contract functions through here

Returns Governed

networkToken

get networkToken(): ERC20

- Defined in src/models/network-v2.ts:53
Settler token is the token that originates oracles

Returns ERC20

nftToken

get nftToken(): BountyToken

- Defined in src/models/network-v2.ts:48
Returns BountyToken

registry

get registry(): NetworkRegistry

- Defined in src/models/network-v2.ts:63
Access registry for this network, in case one exists

Returns NetworkRegistry

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

bountiesIndex

bountiesIndex(): Promise<number>

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

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>

cancelBounty

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

- Defined in src/models/network-v2.ts:410
cancel a bounty

Parameters
- id: number
Returns Promise<TransactionReceipt<any>>

cancelFundRequest

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

- Defined in src/models/network-v2.ts:417
cancel funding

Parameters
- id: number
Returns Promise<TransactionReceipt<any>>

cancelPullRequest

cancelPullRequest(ofBounty: number, prId: number): Promise<TransactionReceipt<any>>

- Defined in src/models/network-v2.ts:478
Parameters
- ofBounty: number
- prId: number
Returns Promise<TransactionReceipt<any>>

cancelableTime

cancelableTime(): Promise<number>

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

canceledBounties

canceledBounties(): Promise<number>

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

changeCancelableTime

changeCancelableTime(value: number): Promise<TransactionReceipt<any>>

- Defined in src/models/network-v2.ts:290
Parameters
- value: number
  
  in seconds
Returns Promise<TransactionReceipt<any>>

changeCouncilAmount

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

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

changeDisputableTime

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

- Defined in src/models/network-v2.ts:251
Parameters
- disputableTime: number
  
  duration in seconds
Returns Promise<TransactionReceipt<any>>

changeDraftTime

changeDraftTime(_draftTime: number): Promise<TransactionReceipt<any>>

- Defined in src/models/network-v2.ts:244
Parameters
- _draftTime: number
  
  duration in seconds
Returns Promise<TransactionReceipt<any>>

changeMergeCreatorFeeShare

changeMergeCreatorFeeShare(mergeCreatorFeeShare: number): Promise<TransactionReceipt<any>>

- Defined in src/models/network-v2.ts:266
Parameters
- mergeCreatorFeeShare: number
  
  percentage is per 10,000; 3 = 0,0003
Returns Promise<TransactionReceipt<any>>

changeOracleExchangeRate

changeOracleExchangeRate(oracleExchangeRate: number): Promise<TransactionReceipt<any>>

- Defined in src/models/network-v2.ts:282
Parameters
- oracleExchangeRate: number
  
  percentage is per 10,000; 3 = 0,0003
Returns Promise<TransactionReceipt<any>>

changePercentageNeededForDispute

changePercentageNeededForDispute(percentageNeededForDispute: number): Promise<TransactionReceipt<any>>

- Defined in src/models/network-v2.ts:258
Parameters
- percentageNeededForDispute: number
  
  percentage is per 10,000; 3 = 0,0003
Returns Promise<TransactionReceipt<any>>

changeProposerFeeShare

changeProposerFeeShare(proposerFeeShare: number): Promise<TransactionReceipt<any>>

- Defined in src/models/network-v2.ts:274
Parameters
- proposerFeeShare: number
  
  percentage is per 10,000; 3 = 0,0003
Returns Promise<TransactionReceipt<any>>

cidBountyId

cidBountyId(cid: string): Promise<number>

- Defined in src/models/network-v2.ts:518
Parameters
- cid: string
Returns Promise<number>

closeBounty

closeBounty(id: number, proposalId: number, ipfsUri?: string): Promise<TransactionReceipt<any>>

- Defined in src/models/network-v2.ts:510
close bounty with the selected proposal id

Parameters
- id: number
- proposalId: number
- ipfsUri: string = ""
Returns Promise<TransactionReceipt<any>>

closedBounties

closedBounties(): Promise<number>

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

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>

councilAmount

councilAmount(): Promise<string>

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

createBountyProposal

createBountyProposal(id: number, prId: number, recipients: string[], percentages: number[]): Promise<TransactionReceipt<any>>

- Defined in src/models/network-v2.ts:492
create a proposal with a pull request for a bounty

Parameters
- id: number
- prId: number
- recipients: string[]
- percentages: number[]
Returns Promise<TransactionReceipt<any>>

createPullRequest

createPullRequest(forBountyId: number, originRepo: string, originBranch: string, originCID: string, userRepo: string, userBranch: string, cid: number): Promise<TransactionReceipt<any>>

- Defined in src/models/network-v2.ts:462
create pull request for bounty id

Parameters
- forBountyId: number
- originRepo: string
- originBranch: string
- originCID: string
- userRepo: string
- userBranch: string
- cid: number
Returns Promise<TransactionReceipt<any>>

delegateOracles

delegateOracles(tokenAmount: string | number, recipient: string): Promise<TransactionReceipt<any>>

- Defined in src/models/network-v2.ts:344
Gives oracles from msg.sender to recipient

Parameters
- tokenAmount: string | number
- recipient: 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(_oracleTokenAddress: string, _registryAddress?: string): Promise<TransactionReceipt<any>>

Implementation of Deployable.deployJsonAbi
- Defined in src/models/network-v2.ts:98
Parameters
- _oracleTokenAddress: string
- _registryAddress: string = nativeZeroAddress
Returns Promise<TransactionReceipt<any>>

disputableTime

disputableTime(): Promise<number>

- Defined in src/models/network-v2.ts:144
Returns Promise<number>
number duration in milliseconds

disputeBountyProposal

disputeBountyProposal(bountyId: number, proposalId: number): Promise<TransactionReceipt<any>>

- Defined in src/models/network-v2.ts:499
dispute a proposal for a bounty

Parameters
- bountyId: number
- proposalId: number
Returns Promise<TransactionReceipt<any>>

disputes

disputes(address: string, bountyId: string | number, proposalId: string | number): Promise<string>

- Defined in src/models/network-v2.ts:159
Parameters
- address: string
- bountyId: string | number
- proposalId: string | number
Returns Promise<string>

draftTime

draftTime(): Promise<number>

- Defined in src/models/network-v2.ts:151
Returns Promise<number>
number duration in milliseconds

fundBounty

fundBounty(id: number, fundingAmount: string | number, decimals?: number): Promise<TransactionReceipt<any>>

- Defined in src/models/network-v2.ts:447
enable users to fund a bounty

Parameters
- id: number
- fundingAmount: string | number
- decimals: number = 18
  
  decimals of the transactional for this bounty
Returns Promise<TransactionReceipt<any>>

getBountiesOfAddress

getBountiesOfAddress(_address: string): Promise<number[]>

- Defined in src/models/network-v2.ts:200
Parameters
- _address: string
Returns Promise<number[]>

getBounty

getBounty(id: number): Promise<Bounty>

- Defined in src/models/network-v2.ts:204
Parameters
- id: number
Returns Promise<Bounty>

getBountyAmountUpdatedEvents

getBountyAmountUpdatedEvents(filter: PastEventOptions): Promise<XEvents<BountyAmountUpdatedEvent>[]>

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

getBountyCanceledEvents

getBountyCanceledEvents(filter: PastEventOptions): Promise<XEvents<BountyCanceledEvent>[]>

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

getBountyClosedEvents

getBountyClosedEvents(filter: PastEventOptions): Promise<XEvents<BountyClosedEvent>[]>

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

getBountyCreatedEvents

getBountyCreatedEvents(filter: PastEventOptions): Promise<XEvents<BountyCreatedEvent>[]>

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

getBountyFundedEvents

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

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

getBountyProposalCreatedEvents

getBountyProposalCreatedEvents(filter: PastEventOptions): XPromiseEvent<BountyProposalCreatedEvent>

- Defined in src/models/network-v2.ts:540
Parameters
- filter: PastEventOptions
Returns XPromiseEvent<BountyProposalCreatedEvent>

getBountyProposalDisputedEvents

getBountyProposalDisputedEvents(filter: PastEventOptions): XPromiseEvent<BountyProposalDisputedEvent>

- Defined in src/models/network-v2.ts:544
Parameters
- filter: PastEventOptions
Returns XPromiseEvent<BountyProposalDisputedEvent>

getBountyProposalRefusedEvents

getBountyProposalRefusedEvents(filter: PastEventOptions): XPromiseEvent<BountyProposalRefusedEvent>

- Defined in src/models/network-v2.ts:548
Parameters
- filter: PastEventOptions
Returns XPromiseEvent<BountyProposalRefusedEvent>

getBountyPullRequestCanceledEvents

getBountyPullRequestCanceledEvents(filter: PastEventOptions): XPromiseEvent<BountyPullRequestCanceledEvent>

- Defined in src/models/network-v2.ts:553
Parameters
- filter: PastEventOptions
Returns XPromiseEvent<BountyPullRequestCanceledEvent>

getBountyPullRequestCreatedEvents

getBountyPullRequestCreatedEvents(filter: PastEventOptions): XPromiseEvent<BountyPullRequestCreatedEvent>

- Defined in src/models/network-v2.ts:557
Parameters
- filter: PastEventOptions
Returns XPromiseEvent<BountyPullRequestCreatedEvent>

getBountyPullRequestReadyForReviewEvents

getBountyPullRequestReadyForReviewEvents(filter: PastEventOptions): XPromiseEvent<BountyPullRequestReadyForReviewEvent>

- Defined in src/models/network-v2.ts:561
Parameters
- filter: PastEventOptions
Returns XPromiseEvent<BountyPullRequestReadyForReviewEvent>

getDelegationsOf

getDelegationsOf(address: string): Promise<Delegation[]>

- Defined in src/models/network-v2.ts:522
Parameters
- address: string
Returns Promise<Delegation[]>

getDivisor

getDivisor(): Promise<number>

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

getGovernorTransferredEvents

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

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

getOraclesChangedEvents

getOraclesChangedEvents(filter: PastEventOptions): Promise<XEvents<OraclesChangedEvent>[]>

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

getOraclesOf

getOraclesOf(_address: string): Promise<string>

- Defined in src/models/network-v2.ts:309
get total amount of oracles of an address

Parameters
- _address: string
Returns Promise<string>

getOraclesResume

getOraclesResume(address: string): Promise<OraclesResume>

- Defined in src/models/network-v2.ts:319
Get the resume of oracles locked, delegated by others and delegations

Parameters
- address: string
Returns Promise<OraclesResume>

getOraclesTransferEvents

getOraclesTransferEvents(filter: PastEventOptions): Promise<XEvents<OraclesTransferEvent>[]>

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

hardCancel

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

- Defined in src/models/network-v2.ts:426
cancels a bounty or a funding request if user is governor or owner and after cancelableTime has passed

Parameters
- id: number
  
  bounty or funding request id
Returns Promise<TransactionReceipt<any>>

isBountyInDraft

isBountyInDraft(bountyId: number): Promise<boolean>

- Defined in src/models/network-v2.ts:213
A bounty is in Draft when now is earlier than the creation date + draft time

Parameters
- bountyId: number
Returns Promise<boolean>
boolean

isProposalDisputed

isProposalDisputed(bountyId: number, proposalId: number): Promise<boolean>

- Defined in src/models/network-v2.ts:225
A proposal is disputed if its weight is greater than the percentage needed for dispute

Parameters
- bountyId: number
- proposalId: number
Returns Promise<boolean>
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-v2.ts:72
Preferred way of initializing and loading a contract

Returns Promise<void>

lock

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

- Defined in src/models/network-v2.ts:328
Lock given amount into the oracle mapping

Parameters
- tokenAmount: string | number
Returns Promise<TransactionReceipt<any>>

markPullRequestReadyForReview

markPullRequestReadyForReview(bountyId: number, pullRequestId: number): Promise<TransactionReceipt<any>>

- Defined in src/models/network-v2.ts:485
mark a PR ready for review

Parameters
- bountyId: number
- pullRequestId: number
Returns Promise<TransactionReceipt<any>>

mergeCreatorFeeShare

mergeCreatorFeeShare(): Promise<number>

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

networkTokenAddress

networkTokenAddress(): Promise<string>

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

nftTokenAddress

nftTokenAddress(): Promise<string>

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

openBounties

openBounties(): Promise<number>

- Defined in src/models/network-v2.ts:128
Returns the number of open bounties

Returns Promise<number>

openBounty

openBounty(tokenAmount?: string | number, transactional?: string, rewardToken?: string, rewardAmount?: string | number, fundingAmount?: string | number, cid: string, title: string, repoPath: string, branch: string, githubUser: string): Promise<TransactionReceipt<any>>

- Defined in src/models/network-v2.ts:371
Creates a bounty on the network You can open a funding-request-bounty by providing rewardToken, rewardAmount, and fundingAmount

Parameters
- tokenAmount: string | number = ...
- transactional: string = nativeZeroAddress
- rewardToken: string = nativeZeroAddress
- rewardAmount: string | number = ...
- fundingAmount: string | number = ...
- cid: string
  
  custom id of this bounty
- title: string
  
  title for this bounty
- repoPath: string
  
  repository path for this bounty
- branch: string
  
  branch inside the provided repo path
- githubUser: string
Returns Promise<TransactionReceipt<any>>

oracleExchangeRate

oracleExchangeRate(): Promise<number>

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

oraclesDistributed

oraclesDistributed(): Promise<string>

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

percentageNeededForDispute

percentageNeededForDispute(): Promise<number>

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

proposerFeeShare

proposerFeeShare(): Promise<number>

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

refuseBountyProposal

refuseBountyProposal(bountyId: number, proposalId: number): Promise<TransactionReceipt<any>>

- Defined in src/models/network-v2.ts:503
Parameters
- bountyId: number
- proposalId: number
Returns Promise<TransactionReceipt<any>>

registryAddress

registryAddress(): Promise<string>

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

retractFunds

retractFunds(id: number, fundingId: number): Promise<TransactionReceipt<any>>

- Defined in src/models/network-v2.ts:455
enable users to retract their funding

Parameters
- id: number
- fundingId: 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-v2.ts:67
Alias for Web3Connection.start(); Will load contract if success

Returns Promise<void>

takeBackOracles

takeBackOracles(entryId: number): Promise<TransactionReceipt<any>>

- Defined in src/models/network-v2.ts:352
Takes back oracles from the entryId related to msg.sender

Parameters
- entryId: number
Returns Promise<TransactionReceipt<any>>

totalNetworkToken

totalNetworkToken(): Promise<string>

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

treasuryInfo

treasuryInfo(): Promise<{ cancelFee: number; closeFee: number; treasury: string }>

- Defined in src/models/network-v2.ts:121
Returns Promise<{ cancelFee: number; closeFee: number; treasury: string }>

unlock

unlock(tokenAmount: string | number): Promise<TransactionReceipt<any>>

- Defined in src/models/network-v2.ts:336
Unlock from the oracle mapping

Parameters
- tokenAmount: string | number
Returns Promise<TransactionReceipt<any>>

updateBountyAmount

updateBountyAmount(id: number, newTokenAmount: string | number, decimals?: number): Promise<TransactionReceipt<any>>

- Defined in src/models/network-v2.ts:436
update the value of a bounty with a new amount

Parameters
- id: number
- newTokenAmount: string | number
- decimals: number = 18
  
  decimals of the transactional for this bounty
Returns Promise<TransactionReceipt<any>>

updateTresuryAddress

updateTresuryAddress(_address: string): Promise<TransactionReceipt<any>>

- Defined in src/models/network-v2.ts:302
update the treasury address

Parameters
- _address: string
Returns Promise<TransactionReceipt<any>>

withdrawFundingReward

withdrawFundingReward(id: number, fundingId: number): Promise<TransactionReceipt<any>>

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

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

web3Connection: Web3Connection | Web3ConnectionOptions

Optional contractAddress: string

Returns Network_v2

Properties

Params

Type declaration

cancelableTime: number

councilAmount: number

disputableTime: number

draftTime: number

mergeCreatorFeeShare: number

oracleExchangeRate: number

percentageNeededForDispute: number

proposerFeeShare: number

Private _DIVISOR

Protected _contract

Private _governed

Private _networkToken

Private _nftToken

Private _registry

Readonly abi

Optional Readonly contractAddress

Accessors

account

Returns Account

Protected connection

Returns Web3Connection

contract

Returns Web3Contract<Methods, any>

divisor

Returns number

governed

Returns Governed

networkToken

Returns ERC20

nftToken

Returns BountyToken

registry

Returns NetworkRegistry

web3

Returns default

Methods

bountiesIndex

Returns Promise<number>

callTx

Type Parameters

ReturnData = any

Parameters

method: ContractCallMethod<ReturnData>

Returns Promise<ReturnData>

cancelBounty

Parameters

id: number

Returns Promise<TransactionReceipt<any>>

cancelFundRequest

Parameters

id: number

Returns Promise<TransactionReceipt<any>>

cancelPullRequest

Parameters

ofBounty: number

prId: number

Returns Promise<TransactionReceipt<any>>

cancelableTime

Returns Promise<number>

canceledBounties

Returns Promise<number>

changeCancelableTime

Parameters

value: number