Merge pull request #49 from stabilitydao/dev

0.18.3

README.md

@@ -103,6 +103,7 @@ Blockchains known to the platform and their integration statuses. Each chain has
 
 * `getSupportedChainNames(): ChainName[]`
 * `getChainsTotals(): {[status in ChainStatus]: number}`
+* `getChainByName(chainName: ChainName): Chain`
 
 ### 🌐 Integrations
 

package.json

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

src/chains.ts

@@ -573,3 +573,13 @@ export const getChainsTotals = (): { [status in ChainStatus]: number } => {
     [ChainStatus.NOT_SUPPORTED]: ids.filter(networkId => chains[networkId].status == ChainStatus.NOT_SUPPORTED).length,
   }
 }
+
+export const getChainByName = (chainName: ChainName): Chain => {
+  for (const chainId in chains) {
+    const chain = chains[chainId]
+    if (chain && chain.name === chainName) {
+      return chain
+    }
+  }
+  throw new Error(`Incorrect chain name ${chainName}`)
+}

src/contests.ts

@@ -7,9 +7,10 @@ export interface YieldContest {
   start: number,
   // end timestamp
   end: number,
-  minEarn: number,
+  // minimal USD income to pass contest
+  minEarn: number|"TBA",
   // contest rewards
-  rewards: Reward[],
+  rewards: Reward[]|"TBA",
   // integration of quest platform campaign
   integration?: {
     // Intract campaign id
@@ -144,4 +145,20 @@ export const contests: { [contestId: string]: YieldContest } = {
       },
     ],
   },
+  "y4": {
+    // 05 Dec 2024 - 18 Dec 2024
+    name: "Yield Contest #4",
+    start: 1733356800, // Thu, 05 Dec 2024 00:00:00 GMT
+    end: 1734566399,   // Wed, 18 Dec 2024 23:59:59 GMT
+    minEarn: "TBA",
+    rewards: "TBA",
+  },
+  "y5": {
+    // 19 Dec 2024 - 01 Jan 2025
+    name: "Yield Contest #5",
+    start: 1734566400, // Thu, 19 Dec 2024 00:00:00 GMT
+    end: 1735775999,   // Wed, 01 Jan 2025 23:59:59 GMT
+    minEarn: "TBA",
+    rewards: "TBA",
+  },
 }

src/index.ts

@@ -7,7 +7,8 @@ import {
   Chain,
   ChainStatusInfo,
   getSupportedChainNames,
-  getChainsTotals
+  getChainsTotals,
+  getChainByName
 } from "./chains";
 import {
   strategies,
@@ -71,6 +72,7 @@ export {
   getChainProtocols,
   getChainStrategies,
   getSupportedChainNames,
+  getChainByName,
   assets,
   Asset,
   getAsset,

tests/chains.test.ts

@@ -0,0 +1,19 @@
+import {ChainName, getChainByName, getChainsTotals, getSupportedChainNames} from "../src";
+
+describe('testing chains', () => {
+  test('get supported chain names', () => {
+      expect(getSupportedChainNames().length).toBeGreaterThan(1)
+  })
+  test('getChainsTotals', () => {
+    const s = getChainsTotals()
+    expect(s.SUPPORTED).toBeGreaterThan(1)
+  })
+  test('getChainByName', () => {
+    let s = getChainByName(ChainName.POLYGON)
+    expect(s.name).toEqual("Polygon")
+    const t = () => {
+      s = getChainByName('incorrect' as ChainName)
+    };
+    expect(t).toThrow(Error);
+  })
+})

tests/contests.test.ts

@@ -1,9 +1,13 @@
-import {contests} from "../src";
+import {contests, Reward, RewardType, YieldContest} from "../src";
 
 describe('testing contests', () => {
   test('check start less then end', () => {
     for (const contestId of Object.keys(contests)) {
       expect(contests[contestId].start).toBeLessThan(contests[contestId].end)
     }
   })
+  test('types', () => {
+    const c: YieldContest = contests["y1"]
+    expect((c.rewards[0] as Reward).type).toEqual(RewardType.POINTS)
+  })
 })

tools/create-contests.ts

@@ -20,6 +20,8 @@ for (let i = +(lastId.replace('y', '') || 0) + 1; i < +(lastId.replace('y', '')
   name: "${name}",
   start: ${start}, // ${new Date(start * 1000).toUTCString()}
   end: ${end},   // ${new Date(end * 1000).toUTCString()}
+  minEarn: "TBA",
+  rewards: "TBA",
 \},`)
   prevTs += PERIOD
 }