vesper-metadata
v2.111.0
Published
Vesper metadata
Downloads
434
Readme
Vesper Metadata
This module contains deployment addresses and relevant information about all the Vesper pool contracts and the ERC-20 Vesper token (VSP).
Information in this repo is based on the contracts list at the vesperfi/doc
repo.
Installation
It is also available as a NPM module:
npm install vesper-metadata
Usage
const metadata = require('vesper-metadata')
metadata.pools
.filter(pool => pool.stage === 'prod')
.forEach(function (pool) {
// Do stuff with each pool...
})
Metadata contents
Everything is contained in a single JSON file: src/vesper-metadata.json
.
It has 3 main sections: controllers, pools and tokens. Each section contain information on the contracts, including:
name
: The common name of the contract.address
: The deployment address in EIP-55 checksum format.chainId
: The deployment chain.
Controllers
This section contains the main control contracts of the ecosystem: the Controller and the Collateral Manager.
Pools
This section contains all the pool contracts, past and present. On top of the basic contract information, each pool has the following properties:
asset
: The symbol of the collateral/deposit token.birthblock
: The block at which the contract was created.riskLevel
: The risk level of the contract in a scale from 1 (low) to 5 (high).stage
: The pool's maturity stage: prod, beta, alpha, experimental.
Tokens
This section contains information on the VSP token in a format compatible with Uniswap's default token list.
License
MIT