# Class: RocketPool

RocketPool

# Constructors

# constructor

new RocketPool(web3, RocketStorage)

Create a new Rocket Pool instance.

# Parameters

Name Type Description
web3 default A Web3 instance
RocketStorage string | ContractArtifact a RocketStorage address as a string or ContractArtifact (JSON ABI file)

# Defined in

rocketpool/rocketpool.ts:87

# Properties

# contracts

Readonly contracts: Contracts

# Defined in

rocketpool/rocketpool.ts:33


# auction

Readonly auction: Auction

# Defined in

rocketpool/rocketpool.ts:34


# dao

Readonly dao: Object

# Type declaration

Name Type
node Object
node.trusted Object
node.trusted.actions DAONodeTrustedActions
node.trusted.node DAONodeTrusted
node.trusted.proposals DAONodeTrustedProposals
node.trusted.settings DAONodeTrustedSettings
proposals DAOProposal

# Defined in

rocketpool/rocketpool.ts:35


# deposit

Readonly deposit: Deposit

# Defined in

rocketpool/rocketpool.ts:46


# minipool

Readonly minipool: Minipool

# Defined in

rocketpool/rocketpool.ts:47


# network

Readonly network: Network

# Defined in

rocketpool/rocketpool.ts:48


# node

Readonly node: Node

# Defined in

rocketpool/rocketpool.ts:49


# settings

Readonly settings: Object

# Type declaration

Name Type
auction AuctionSettings
deposit DepositSettings
minipool MinipoolSettings
network NetworkSettings
node NodeSettings

# Defined in

rocketpool/rocketpool.ts:50


# tokens

Readonly tokens: Object

# Type declaration

Name Type
reth RETH
rpl RPL
legacyrpl LegacyRPL

# Defined in

rocketpool/rocketpool.ts:57


# rewards

Readonly rewards: Object

# Type declaration

Name Type
pool Pool
claimNode Rewards
claimDAO Rewards
claimTrustedNode Rewards

# Defined in

rocketpool/rocketpool.ts:58


# vault

Readonly vault: Vault

# Defined in

rocketpool/rocketpool.ts:64


# web3

Readonly web3: default


# RocketStorage

Readonly RocketStorage: string | ContractArtifact