Interface Vault

interface to Collective Treasury

Hierarchy

Vault

Implemented by

Treasury

Index

Methods

approve approveMulti balance cancel deposit pay transferTo treasuryBalance

Methods

approve

approve(to, quantity): Promise<void>
approve a withdrawal from the treasury
Parameters
- to: string
  
  the recipient of the funds
- quantity: number
  
  the amount to approve
Returns Promise<void>
- Defined in treasury/vault.ts:51

approveMulti

approveMulti(to, quantity, scheduleTime, signature): Promise<void>
approve a withdrawal from the treasury and sign in a single transaction
Parameters
- to: string
  
  the recipient of the funds
- quantity: number
  
  the amount to approve
- scheduleTime: number
  
  the time to schedule the withdrawal
- signature: string[]
  
  the array of signatures
Returns Promise<void>
- Defined in treasury/vault.ts:62

balance

balance(from): Promise<number>
retrieve the approved balance for the specified account
Parameters
- from: string
  
  the account to query
Returns Promise<number>
- Defined in treasury/vault.ts:88

cancel

cancel(to): Promise<void>
cancel approval for the recipient
Parameters
- to: string
  
  the destination account for the funds
Returns Promise<void>
- Defined in treasury/vault.ts:81

deposit

deposit(quantity): Promise<void>
send a depsoit to the treasury
Parameters
- quantity: number
  
  the amount to deposit
Returns Promise<void>
- Defined in treasury/vault.ts:43

pay

pay(): Promise<void>
withdraw available funds from the treasury to your account

Returns Promise<void>
- Defined in treasury/vault.ts:67

transferTo

transferTo(to): Promise<void>
withdraw available funds from the treasury to the specified account
Parameters
- to: string
  
  the destination account for the funds
Returns Promise<void>
- Defined in treasury/vault.ts:74

treasuryBalance

treasuryBalance(): Promise<number>
retrieve the contract balance for the treasury

Returns Promise<number>
- Defined in treasury/vault.ts:93

Generated using TypeDoc