Class TreasuryBuilder

Collective Treasury Builder

Hierarchy

ContractAbi
- TreasuryBuilder

Index

Constructors

Properties

contract contractAbi contractAddress gas gasPriceGwei logger web3

Methods

aTreasury build name withApprover withMinimumApprovalRequirement withTimeLockDelay

Constructors

constructor

new TreasuryBuilder(abiPath, contractAddress, web3, wallet, gas, gasPriceGwei): TreasuryBuilder
Parameters
- abiPath: string
- contractAddress: string
- web3: default
- wallet: Wallet
- gas: number
- gasPriceGwei: string
Returns TreasuryBuilder
Overrides ContractAbi.constructor
- Defined in treasury/treasurybuilder.ts:43

Properties

contract

contract: Contract

`Protected` `Readonly` contractAbi

contractAbi: any[]

`Readonly` contractAddress

contractAddress: string

`Protected` `Readonly` gas

gas: number

`Protected` `Readonly` gasPriceGwei

gasPriceGwei: string

`Protected` `Readonly` logger

logger: Logger = ...

`Protected` `Readonly` web3

web3: default

Methods

aTreasury

aTreasury(): Promise<TreasuryBuilder>
intialize and create a new treasury

Returns Promise<TreasuryBuilder>
TreasuryBuilder this treasury builder
- Defined in treasury/treasurybuilder.ts:63

build

build(): Promise<string>
build the treasury

Returns Promise<string>
string the address of the treasury
- Defined in treasury/treasurybuilder.ts:111

name

name(): Promise<string>
get the name of the contract

Returns Promise<string>
string the name of the contract
- Defined in treasury/treasurybuilder.ts:51

withApprover

withApprover(approver): Promise<TreasuryBuilder>
add an approver to the treasury
Parameters
- approver: string
  
  the approver to add
Returns Promise<TreasuryBuilder>
TreasuryBuilder this treasury builder
- Defined in treasury/treasurybuilder.ts:100

withMinimumApprovalRequirement

withMinimumApprovalRequirement(minimumApprovalRequirement): Promise<TreasuryBuilder>
set the number of approvals for the treasury
Parameters
- minimumApprovalRequirement: number
  
  the minumum number of approvals required to execute a transaction
Returns Promise<TreasuryBuilder>
TreasuryBuilder this treasury builder
- Defined in treasury/treasurybuilder.ts:76

withTimeLockDelay

withTimeLockDelay(timelockDelay): Promise<TreasuryBuilder>
set the timelock delay for the treasury
Parameters
- timelockDelay: number
  
  the timelock delay in seconds
Returns Promise<TreasuryBuilder>
TreasuryBuilder this treasury builder
- Defined in treasury/treasurybuilder.ts:88

Generated using TypeDoc