1. Installation and Setup

Installation

To begin integrating the Chorus One SDK into your project, the first step is to add the library to the application. You can use your favorite package manager, including npm, yarn, pnpm or bun. For simplicity, we will use npm.

In the project's root directory, run the following command:

npm install @chorus-one/ethereum

Once the SDK is installed, the next step is to import it into your codebase and initialize it.

Here's how you can do this:

import { EthereumStaker } from '@chorus-one/ethereum'

const staker = new EthereumStaker({
  network: 'hoodi'
})

await staker.init()

In the above snippet, we import the EthereumStaker from the @chorus-one/ethereum package, and we create a new EthereumStaker instance for hoodi network. After that, we initialize the staker by calling the init method.

With these steps, the Chorus One SDK is successfully integrated and initialized in our project.

Using Vaults with Chorus One SDK

The Chorus One SDK offers two primary ways to engage with vaults for Ethereum staking:

1. Using predefined default vaults provided by Chorus One

2. Configuring your own custom vaults.

Below is a guide on how to leverage each option.

Option 1: Accessing Default Vault Address

The Chorus One SDK has a predefined list of default vault addresses for each supported network. These vaults are Chorus One nodes, optimized for immediate use without additional setup.

To access these default vault addresses, you can use the CHORUS_ONE_ETHEREUM_VALIDATORS constant. This is particularly useful if you do not have specific vault addresses or prefer a quick setup.

Vault Types

• MEV Max Vault (mevMaxVault): This vault employs Chorus One's proprietary MEV Research to maximize staking returns by optimizing transaction ordering.

• Obol Distributed Validator Technology (obolDvVault): This vault uses Obol's DVT to enhance resilience and decentralization of Ethereum staking by distributing validator duties across multiple nodes.

You can retrieve the default vault by running:

import { CHORUS_ONE_ETHEREUM_VALIDATORS } from '@chorus-one/ethereum'

const validatorAddress = CHORUS_ONE_ETHEREUM_VALIDATORS.ethereum.mevMaxVault

console.log(vaultAddress) // '0x95d0db03d59658e1af0d977ecfe142f178930ac5'

Option 2: Using Custom Vault Addresses

The Chorus One SDK supports this flexibility if you prefer to use custom vaults and have specific vault addresses for your project. You can configure these addresses as part of your setup, enabling you to work with vaults of your choice.

Integrating the wagmi Library

We will use wagmi and web3modal libraries to connect with Ethereum wallets, allowing users to interact with blockchain applications. This is an essential step, particularly because the Chorus One SDK does not provide wallet connection functionality.

The SDK relies on your application to manage an existing wallet connection. You can choose any library for this purpose, and the SDK will still function correctly.

For detailed instructions on installing and using wagmi and web3modal, please visit their respective websites: wagmi and web3modal.

Configuring wagmi in Your Application

To integrate wagmi into your project, we'll start by configuring it within your main application component. This involves wrapping your application in the WagmiProvider component, which is responsible for providing the necessary context for wagmi's functionality.

Here's how you can do this:

import { WagmiProvider } from 'wagmi'
// Import the default wagmi configuration
import { config } from './config/wagmi'
import { Main } from './components/Main'

function App() {
  return (
    <WagmiProvider config={config}>
      <Main />
    </WagmiProvider>
  )
}

export default App

In the above code, we import WagmiProvider and wrap your main application component (<Main />). This setup ensures that all components within <Main /> have access to wagmi's features.

In addition, we need to set up a WalletConnect project and use the projectId in the wagmi config. You can get your projectId by creating a new project on the WalletConnect website.

• This step is necessary for the configuration file.

Utilizing wagmi Hooks for Wallet Interactions

Wagmi provides a variety of hooks that make it simple to interact with user wallets and perform blockchain transactions. These hooks simplify the process of integrating web3 functionalities into your application.

Let's look at how we can use some of these hooks:

import { useAccount, useWalletClient, usePublicClient } from 'wagmi'

// Retrieve the user's wallet address
const { address } = useAccount()

// Obtain a client to query public blockchain data
const publicClient = usePublicClient()

// Use the walletClient hook to execute transactions
const { data: walletClient } = useWalletClient()

In this example, useAccount is used to obtain the user's wallet address; the usePublicClient hook provides a client for querying public blockchain data. Finally, the useWalletClient hook provides a client for executing transactions, enabling interactions with the blockchain.

Next Steps

In this section, we integrated the wagmi library into your project and configured it within your main application component.

To continue with the tutorial, let's move on to the next section: Fetching Vault Details, where we will learn how to fetch and display details about the vault using the Chorus One SDK.