@quickswap-defi/staking-list


Official QuickSwap staking list for multi-chain DeFi applications. Includes curated Syrup pools, LP farms, and Dual farms metadata for Polygon, Base, and other supported networks.

---

Migration Notice

Former package name: quickswap-default-staking-list-address (deprecated)
New package name: @quickswap-defi/staking-list

---

Installation

``bash
npm install @quickswap-defi/staking-list
`

Supported Chains

| Chain | chainId | Status |
|---------|---------|--------|
| Polygon | 137 | ✅ |
| Base | 8453 | ✅ |

Outputs

This package publishes unified JSON files per staking type:

`text
build/
syrups.json # All Syrup pools (all chains)
lpfarms.json # All LP farms (all chains)
dualfarms.json # All Dual farms (all chains)
`

Each file contains data for all supported chains:

`json
{
"name": "Quickswap Syrups",
"timestamp": "2025-01-15T...",
"version": { "major": 1, "minor": 0, "patch": 2 },
"chains": {
"137": {
"name": "Polygon",
"chainId": 137,
"active": [ ... ],
"closed": [ ... ]
},
"8453": {
"name": "Base",
"chainId": 8453,
"active": [ ... ],
"closed": [ ... ]
}
}
}
`

Usage

`javascript
// Import the unified staking list
const syrups = require('@quickswap-defi/staking-list/build/syrups.json');
const lpfarms = require('@quickswap-defi/staking-list/build/lpfarms.json');
const dualfarms = require('@quickswap-defi/staking-list/build/dualfarms.json');

// Access by chainId
const polygonSyrups = syrups.chains["137"];
const baseSyrups = syrups.chains["8453"];

console.log(Active syrups on Polygon: ${polygonSyrups.active.length});
console.log(Closed syrups on Polygon: ${polygonSyrups.closed.length});
console.log(Active syrups on Base: ${baseSyrups.active.length});

// Or iterate all chains
for (const [chainId, chainData] of Object.entries(syrups.chains)) {
console.log(${chainData.name}: ${chainData.active.length} active pools);
}
`

Adding New Staking Data

$3

All staking data is stored in unified JSON files keyed by chainId:

`text
src/data/
syrups.json # All Syrup pools (all chains)
lpfarms.json # All LP farms (all chains)
dualfarms.json # All Dual farms (all chains)
`

Data is organized by chainId for easy navigation:

`json
{
"137": [
{ "stakingRewardAddress": "0x...", "token": "0x...", ... },
{ "stakingRewardAddress": "0x...", "token": "0x...", ... }
],
"8453": [
{ "stakingRewardAddress": "0x...", "token": "0x...", ... }
]
}
`

$3

Each syrup entry requires these fields (placed under the appropriate chainId key):

`json
{
"token": "0x...", // Reward token address
"stakingRewardAddress": "0x...", // Staking contract address (unique per chain)
"name": "Stake QUICK - Earn USDC",
"stakingToken": "0x...", // Token users stake
"baseToken": "0x...", // Base token for price calculation
"rate": 0.000002, // Reward rate per second
"ending": 1764482107, // Unix timestamp when pool ends
"lp": "", // LP token address (if applicable)
"sponsored": false, // Whether pool is sponsored
"link": "" // External link (optional)
}
`

$3

#### Option 1: Sync from deployment file (recommended)

Import data directly from a deployment JSON file:

`bash
npm run sync -- --in --chain --type
`

Example: Import Base syrups from syrup-staking-contract:

`bash
npm run sync -- \
--in ../syrup-staking-contract/deployments/syrup-base.json \
--chain base \
--type syrups

npm test
npm run build
`

Arguments:

| Argument | Description |
|----------|-------------|
| --in | Path to input deployment JSON file |
| --chain | Target chain: polygon, base |
| --type | Staking type: syrups, lpfarms, dualfarms |
| --merge | Merge with existing data (default: true) |

Input file format (from deployment repos):

`json
{
"active": [ { ... } ],
"closed": [ { ... } ]
}
`

The sync script:
1. Merges into the unified data file (e.g., src/data/syrups.json)
2. Preserves items from other chains

#### Option 2: Edit source files directly

For manual additions:

`bash


Edit the unified data file

vim src/data/syrups.json

Add items under the appropriate chainId key

Validate and build

npm test
npm run build
`

#### Commit and publish

`bash
git add .
git commit -m "feat(base): add QUICK-USDC syrup pool"
git push
`

$3

Items are classified automatically at build time based on the ending timestamp:

| Condition | Classification |
|-----------|----------------|
| ending < now | closed |
| ending >= now | active |
| No ending field | active |

You never need to manually move items between active/closed — just set the ending timestamp correctly.

Adding a New Chain

To add support for a new chain:

1. Add the chain configuration to src/lib/constants.js:

`javascript
const CHAINS = {
polygon: { chainId: 137, name: 'Polygon', logoURI: '...' },
base: { chainId: 8453, name: 'Base', logoURI: '...' },
newchain: { chainId: 12345, name: 'NewChain', logoURI: '...' } // Add here
};
`

2. Add staking items under the new chainId key in the data files:

`json
{
"137": [...],
"8453": [...],
"12345": [...] // Add new chain data
}
`

3. Run npm test && npm run build to validate

Development

`bash


Install dependencies

npm install

Run tests

npm test

Build all lists

npm run build

Sync from deployment file

npm run sync -- --in --chain --type
``

Disclaimer

Note filing an issue does not guarantee addition to this default staking list.
We do not review syrup/LP farm/Dual farm addition requests in any particular order, and we do not
guarantee that we will review your request to add the syrup/LP farm/Dual farm to the default list.