Merge pull request #7 from stabilitydao/dev

0.6.2

Author: a17

README.md

@@ -1,10 +1,16 @@
 # Stability Integration Library
 
-[![GitHub version](https://badge.fury.io/gh/stabilitydao%2Fstability.svg)](https://badge.fury.io/gh/stabilitydao%2Fstability)
-[![npm version](https://badge.fury.io/js/@stabilitydao%2Fstability.svg)](https://badge.fury.io/js/@stabilitydao%2Fstability)
+![GitHub package.json version](https://img.shields.io/github/package-json/v/stabilitydao/stability)
+![NPM Version](https://img.shields.io/npm/v/%40stabilitydao%2Fstability?label=NPM%20version)
+![GitHub Tag](https://img.shields.io/github/v/tag/stabilitydao/stability)
+
+![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/stabilitydao/stability?label=code%20size)
+![npm bundle size](https://img.shields.io/bundlephobia/min/%40stabilitydao%2Fstability?label=NPM%20bundle%20size)
+![NPM Unpacked Size](https://img.shields.io/npm/unpacked-size/%40stabilitydao%2Fstability?label=NPM%20unpacked%20size)
+
 [![codecov](https://codecov.io/github/stabilitydao/stability/graph/badge.svg?token=V0JV1WOGMM)](https://codecov.io/github/stabilitydao/stability)
 
-This is library for integrating the platform into Node.js applications.
+This is library for integrating Stability Platform into Node.js applications.
 
 ## Usage
 
@@ -46,7 +52,9 @@ DeFi organizations, protocols, their integration statuses, usage and other infor
 
 ### Tokenlist
 
-`stability.tokenlist.json`
+```typescript
+import {tokenlist} from '@stabilitydao/stability'
+```
 
 ### API types
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stabilitydao/stability",
-  "version": "0.6.1",
+  "version": "0.6.2",
   "description": "Stability Integration Library",
   "main": "out/index.js",
   "types": "out/index.d.ts",

src/index.ts

@@ -1,5 +1,5 @@
 import {deployments, CoreContracts} from "./deployments";
-import {networks, NetworkId, Network} from "./networks";
+import {networks, NetworkId, Network, getSupportedNetworkIds} from "./networks";
 import {
   strategies,
   StrategyShortId,
@@ -42,4 +42,5 @@ export {
   getMerklStrategies,
   getStrategyShortId,
   getIntegrationStatus,
+  getSupportedNetworkIds,
 }

src/integrations.ts

@@ -1,6 +1,5 @@
 import {strategies, StrategyShortId, StrategyState} from "./strategies";
-import {NetworkId, networks} from "./networks";
-import {deployments} from "./deployments";
+import {getSupportedNetworkIds, NetworkId} from "./networks";
 
 export type DeFiOrganization = {
   name: string
@@ -170,7 +169,7 @@ export const integrations: { [org: string]: DeFiOrganization } = {
           NetworkId.BLAST,
         ],
         adapters: ['UniswapV3Adapter'],
-        strategies: [StrategyShortId.CUMF,StrategyShortId.GUMF,]
+        strategies: [StrategyShortId.CUMF, StrategyShortId.GUMF,]
       },
     },
     defiLlama: 'uniswap',
@@ -281,6 +280,20 @@ export const integrations: { [org: string]: DeFiOrganization } = {
     },
     defiLlama: 'baseswap',
   },
+  agni: {
+    name: 'Agni',
+    website: 'https://agni.finance/',
+    protocols: {
+      agni: {
+        name: 'Agni',
+        category: DefiCategory.AMM,
+        networks: [NetworkId.MANTLE,],
+        adapters: ['UniswapV3Adapter',],
+      },
+    },
+    defiLlama: 'agni-finance',
+    github: 'agni-protocol',
+  },
   // ALM
   gamma: {
     name: 'Gamma',
@@ -443,6 +456,32 @@ export const integrations: { [org: string]: DeFiOrganization } = {
     defiLlama: 'a51-finance',
     github: 'a51finance',
   },
+  skatefi: {
+    name: 'SkateFi',
+    website: 'https://www.rangeprotocol.com',
+    protocols: {
+      range: {
+        name: 'Range',
+        category: DefiCategory.ALM,
+        networks: [
+          NetworkId.ETHEREUM,
+          NetworkId.BSC,
+          NetworkId.ARBITRUM,
+          NetworkId.POLYGON,
+          NetworkId.MANTLE,
+          NetworkId.BASE,
+          NetworkId.MANTA,
+          NetworkId.SCROLL,
+          NetworkId.BLAST,
+          NetworkId.ZETA,
+          NetworkId.ZKFAIR,
+          NetworkId.MERLIN,
+        ],
+      },
+    },
+    defiLlama: 'skate-fi',
+    github: 'Range-Protocol',
+  },
   // Lending
   compound: {
     name: 'Compound',
@@ -609,11 +648,13 @@ export const integrations: { [org: string]: DeFiOrganization } = {
 };
 
 export const getIntegrationStatus = (p: DeFiProtocol): IntegrationStatus => {
+  const supportedNetWorkIds = getSupportedNetworkIds()
+  const isSupportedNetwork = p.networks.some(r => supportedNetWorkIds.includes(r))
   if (p.coreContracts && p.coreContracts.length > 0) {
-    return IntegrationStatus.LIVE
+    return isSupportedNetwork ? IntegrationStatus.LIVE : IntegrationStatus.PROPOSED
   }
   if (p.adapters && p.adapters.length > 0) {
-    return IntegrationStatus.LIVE
+    return isSupportedNetwork ? IntegrationStatus.LIVE : IntegrationStatus.PROPOSED
   }
   if (p.strategies) {
     for (const strategy of p.strategies) {
@@ -647,11 +688,6 @@ export const getIntegrationStatus = (p: DeFiProtocol): IntegrationStatus => {
       }
     }
   }
-  const supportedNetWorkIds = Object.keys(deployments).map(chainIdString => networks[chainIdString].id)
-  for (const protocolNetworkId of p.networks) {
-    if (supportedNetWorkIds.includes(protocolNetworkId as NetworkId)) {
-      return IntegrationStatus.POSSIBLE
-    }
-  }
-  return IntegrationStatus.PROPOSED
+
+  return isSupportedNetwork ? IntegrationStatus.POSSIBLE : IntegrationStatus.PROPOSED
 }

src/networks.ts

@@ -1,8 +1,9 @@
 import {IntegrationStatus} from "./integrations";
+import {deployments} from "./deployments";
 
 export type Network = {
   id: NetworkId,
-  chainId: number|string,
+  chainId: number | string,
   status: IntegrationStatus,
 }
 
@@ -24,6 +25,7 @@ export const enum NetworkId {
   POLYGON_ZKEVM = 'Polygon zkEVM',
   IMMUTABLE_ZKEVM = 'Immutable zkEVM',
   ASTAR_ZKEVM = 'Astar zkEVM',
+  ZKFAIR = 'ZKFair',
   SCROLL = 'Scroll',
   ZKSYNC = 'zkSync',
   BLAST = 'Blast',
@@ -40,9 +42,11 @@ export const enum NetworkId {
   ROLLUX = 'Rollux',
   EVMOS = 'Evmos',
   TELOS = 'Telos EVM',
+  ZETA = 'ZetaChain',
+  MERLIN = 'Merlin',
 }
 
-export const networks: {[chainId: string]: Network} = {
+export const networks: { [chainId: string]: Network } = {
   "1": {
     id: NetworkId.ETHEREUM,
     chainId: 1,
@@ -113,11 +117,6 @@ export const networks: {[chainId: string]: Network} = {
     chainId: 570,
     status: IntegrationStatus.PROPOSED,
   },
-  "3776": {
-    id: NetworkId.ASTAR_ZKEVM,
-    chainId: 3776,
-    status: IntegrationStatus.PROPOSED,
-  },
   "1088": {
     id: NetworkId.METIS,
     chainId: 1088,
@@ -148,11 +147,26 @@ export const networks: {[chainId: string]: Network} = {
     chainId: 2222,
     status: IntegrationStatus.PROPOSED,
   },
+  "3776": {
+    id: NetworkId.ASTAR_ZKEVM,
+    chainId: 3776,
+    status: IntegrationStatus.PROPOSED,
+  },
+  "4200": {
+    id: NetworkId.MERLIN,
+    chainId: 4200,
+    status: IntegrationStatus.PROPOSED,
+  },
   "5000": {
     id: NetworkId.MANTLE,
     chainId: 5000,
     status: IntegrationStatus.PROPOSED,
   },
+  "7000": {
+    id: NetworkId.ZETA,
+    chainId: 7000,
+    status: IntegrationStatus.PROPOSED,
+  },
   "8217": {
     id: NetworkId.KLAYTN,
     chainId: 8217,
@@ -188,6 +202,11 @@ export const networks: {[chainId: string]: Network} = {
     chainId: 42220,
     status: IntegrationStatus.PROPOSED,
   },
+  "42766": {
+    id: NetworkId.ZKFAIR,
+    chainId: 42766,
+    status: IntegrationStatus.PROPOSED,
+  },
   "43114": {
     id: NetworkId.AVALANCHE,
     chainId: 43114,
@@ -209,3 +228,5 @@ export const networks: {[chainId: string]: Network} = {
     status: IntegrationStatus.PROPOSED,
   },
 }
+
+export const getSupportedNetworkIds = () => Object.keys(deployments).map(chainId => networks[chainId].id)

src/strategies.ts

@@ -162,7 +162,7 @@ export const strategies: {[shortId in StrategyShortId]:Strategy} = {
   [StrategyShortId.GUMF]: {
     id: 'Gamma UniswapV3 Merkl Farm',
     shortId: StrategyShortId.GUMF,
-    state: StrategyState.PROPOSED,
+    state: StrategyState.LIVE,
     contractGithubId: 145,
     color: "#ff0000",
     bgColor: "#000000",

tests/integrations.test.ts

@@ -16,7 +16,14 @@ describe('testing integrations', () => {
     protocol.coreContracts = undefined
     protocol.adapters = ['TestAdapter',]
     expect(getIntegrationStatus(protocol)).toBe(IntegrationStatus.LIVE)
+
+    protocol.networks = [NetworkId.EVMOS,]
+    expect(getIntegrationStatus(protocol)).toBe(IntegrationStatus.PROPOSED)
     protocol.adapters = undefined
+    protocol.coreContracts = ['PriceReader',]
+    expect(getIntegrationStatus(protocol)).toBe(IntegrationStatus.PROPOSED)
+    protocol.coreContracts = undefined
+
     protocol.strategies = [StrategyShortId.IQMF,]
     expect(getIntegrationStatus(protocol)).toBe(IntegrationStatus.LIVE)
     strategies[StrategyShortId.IQMF].state = StrategyState.AWAITING_DEPLOYMENT

tests/networks.test.ts

@@ -0,0 +1,7 @@
+import {getSupportedNetworkIds} from "../src";
+
+describe('testing networks', () => {
+  test('get supported network IDs', () => {
+      expect(getSupportedNetworkIds().length).toBeGreaterThan(1)
+  })
+})

tools/overview-full.ts

@@ -16,6 +16,14 @@ console.log(bold`=== Networks: ${Object.keys(networks).length} ===`)
 console.log(`${Object.keys(networks).map(n => `${networks[n].id} [${n}]`).join(', ')}`)
 console.log('')
 // @ts-ignore
+console.log(bold`=== Tokenlist ${tokenlist.version.major}.${tokenlist.version.minor}.${tokenlist.version.patch}: ${tokenlist.tokens.length} tokens for ${tokenlist.tokens.map(t => t.chainId).filter((value, index, array) => array.indexOf(value) === index).length} networks ===`)
+console.log(`${tokenlist.tokens.map(t => `[${t.chainId}] ${t.symbol}`).join(', ')}`)
+console.log('')
+// @ts-ignore
+console.log(bold`=== Subgraph endpoints: ${Object.keys(subgraphs).length} ===`)
+console.log(`${Object.keys(subgraphs).map(chainId => `[${chainId}] ${subgraphs[chainId]}`).join("\n")}`)
+console.log('')
+// @ts-ignore
 console.log(bold`=== Strategies: ${Object.keys(strategies).length} ===`)
 for (const strategyShortId of Object.keys(strategies)) {
   // @ts-ignore
@@ -67,13 +75,3 @@ for (const defiOrgCode of Object.keys(integrations)) {
 console.log(bold`=== DeFi protocols: ${protocolsTotal} ===`)
 table.printTable();
 console.log('')
-
-// @ts-ignore
-console.log(bold`=== Tokenlist ${tokenlist.version.major}.${tokenlist.version.minor}.${tokenlist.version.patch}: ${tokenlist.tokens.length} tokens for ${tokenlist.tokens.map(t => t.chainId).filter((value, index, array) => array.indexOf(value) === index).length} networks ===`)
-console.log(`${tokenlist.tokens.map(t => `[${t.chainId}] ${t.symbol}`).join(', ')}`)
-console.log('')
-
-// @ts-ignore
-console.log(bold`=== Subgraph endpoints: ${Object.keys(subgraphs).length} ===`)
-console.log(`${Object.keys(subgraphs).map(chainId => `[${chainId}] ${subgraphs[chainId]}`).join("\n")}`)
-console.log('')

tools/overview.ts

@@ -4,12 +4,12 @@ import tokenlist from '../src/stability.tokenlist.json'
 
 console.log(`== Stability Integration Library v${version} ==`)
 console.log(`Deployments: ${Object.keys(deployments).length}`)
-console.log(`Strategies: ${Object.keys(strategies).length}`)
 console.log(`Networks: ${Object.keys(networks).length}`)
+console.log(`Tokenlist ${tokenlist.version.major}.${tokenlist.version.minor}.${tokenlist.version.patch}: ${tokenlist.tokens.length} tokens for ${tokenlist.tokens.map(t => t.chainId).filter((value, index, array) => array.indexOf(value) === index).length} networks.`)
+console.log(`Subgraph endpoints: ${Object.keys(subgraphs).length}`)
+console.log(`Strategies: ${Object.keys(strategies).length}`)
 let protocolsTotal = 0
 for (const defiOrgCode of Object.keys(integrations)) {
   protocolsTotal += Object.keys(integrations[defiOrgCode].protocols).length
 }
 console.log(`DeFi protocols: ${protocolsTotal}`)
-console.log(`Tokenlist ${tokenlist.version.major}.${tokenlist.version.minor}.${tokenlist.version.patch}: ${tokenlist.tokens.length} tokens for ${tokenlist.tokens.map(t => t.chainId).filter((value, index, array) => array.indexOf(value) === index).length} networks.`)
-console.log(`Subgraph endpoints: ${Object.keys(subgraphs).length}`)