Class: DepositSettings ​

Rocket Pool Deposit Settings Manager

Constructors ​

constructor ​

• new DepositSettings(web3, contracts)

Create a new Deposit Settings instance.

Parameters ​

Defined in ​

rocketpool/settings/deposit.ts:16

Accessors ​

rocketDAOProtocolSettingsDeposit ​

• Private get rocketDAOProtocolSettingsDeposit(): Promise<Contract>

Private accessor use to retrieve the related contract

Returns ​

Promise<Contract>

a Promise<Contract> with a web3.eth.contract instance of the rocketDAOProtocolSettingsDeposit contract

Defined in ​

rocketpool/settings/deposit.ts:22

Methods ​

getDepositEnabled ​

▸ getDepositEnabled(): Promise<boolean>

Check to see if deposits are enabled

example using Typescript

const enabled = rp.settings.deposit.getDepositsEnabled().then((val: boolean) => { val };

const enabled = rp.settings.deposit.getDepositsEnabled().then((val: boolean) => { val };

Returns ​

Promise<boolean>

a Promise<boolean> that resolves to a boolean representing if deposits are enabled

Defined in ​

rocketpool/settings/deposit.ts:35

getAssignDepositsEnabled ​

▸ getAssignDepositsEnabled(): Promise<boolean>

Check to see if deposit assignments are enabled

example using Typescript

const enabled = rp.settings.deposit.getAssignDepositsEnabled().then((val: boolean) => { val };

const enabled = rp.settings.deposit.getAssignDepositsEnabled().then((val: boolean) => { val };

Returns ​

Promise<boolean>

a Promise<boolean> that resolves to a boolean representing if deposit assignments are enabled

Defined in ​

rocketpool/settings/deposit.ts:50

getMinimumDeposit ​

▸ getMinimumDeposit(): Promise<string>

Return the minimum deposit amount setting in wei

example using Typescript

const minimumDeposit = rp.settings.deposit.getMinimumDeposit().then((val: string) => { val };

const minimumDeposit = rp.settings.deposit.getMinimumDeposit().then((val: string) => { val };

Returns ​

Promise<string>

a Promise<string> that resolves to a string representing the minimum deposit amount setting

Defined in ​

rocketpool/settings/deposit.ts:65

getMaximumDepositPoolSize ​

▸ getMaximumDepositPoolSize(): Promise<string>

Return the maximum deposit pool size setting in Wei

example using Typescript

const maximumDepositPoolSize = rp.settings.deposit.getMaximumDepositPoolSize().then((val: string) => { val };

const maximumDepositPoolSize = rp.settings.deposit.getMaximumDepositPoolSize().then((val: string) => { val };

Returns ​

Promise<string>

a Promise<string> that resolves to a string representing the maximum deposit pool size setting

Defined in ​

rocketpool/settings/deposit.ts:80

getMaximumDepositAssignments ​

▸ getMaximumDepositAssignments(): Promise<number>

Return the maximum number of deposit assignments to perform at once

example using Typescript

const maxDepositAssignments = rp.settings.deposit.getMaximumDepositAssignments().then((val: string) => { val };

const maxDepositAssignments = rp.settings.deposit.getMaximumDepositAssignments().then((val: string) => { val };

Returns ​

Promise<number>

a Promise<number> that resolves to a number representing the maximum number of deposit assignments to perform at once

Defined in ​

rocketpool/settings/deposit.ts:95