Initialization
Last updated
Last updated
Installation
To install the SDK, use npm or pnpm:
or
The SDK uses ethers.js v5.
Yelay has two types of vaults: test (on Base) and production (various chains)
Use test vaults on Base for testing transactions.
For real user funds, use production vaults only.
Test vaults are available on Base only, while production vaults are be deployed across multiple chains in addition to Base.
To retrieve actual vault addresses, use the getVaults()
method.
Alternatively, see up-to-date addresses of deployed vaults across all chains here:
To fetch pool IDs belonging to a vault, use the clientData()
method.
Both methods are described here: 🔗
To start using the SDK, initialize it with an Ethereum signer or provider and a chain ID.
For Test Use
Ensure you pass the third parameter as true
to initialize access to test vaults instead of production vaults.
For Production Use
Initialize the SDK with an Ethereum signer or provider and a chain ID: