return governance schemas (#210)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orionprotocol/sdk",
-  "version": "0.20.20",
+  "version": "0.20.21-rc0",
   "description": "Orion Protocol SDK",
   "main": "./lib/index.cjs",
   "module": "./lib/index.js",

src/services/BlockchainService/index.ts

@@ -18,6 +18,12 @@ import { makePartial } from '../../utils';
 import type { networkCodes } from '../../constants/index.js';
 import { fetchWithValidation } from 'simple-typed-fetch';
 import type { BasicAuthCredentials } from '../../types.js';
+import {
+  governanceChainsInfoSchema,
+  governanceContractsSchema,
+  governancePoolSchema,
+  governancePoolsSchema
+} from './schemas';
 
 type IAdminAuthHeaders = {
   auth: string
@@ -62,6 +68,7 @@ type PlatformFees = {
   walletAddress?: string | undefined
   fromWidget?: string | undefined
 }
+
 class BlockchainService {
   private readonly apiUrl: string;
 
@@ -109,6 +116,10 @@ class BlockchainService {
     this.getBlockNumber = this.getBlockNumber.bind(this);
     this.getRedeemOrderBySecretHash = this.getRedeemOrderBySecretHash.bind(this);
     this.claimOrder = this.claimOrder.bind(this);
+    this.getGovernanceContracts = this.getGovernanceContracts.bind(this);
+    this.getGovernancePools = this.getGovernancePools.bind(this);
+    this.getGovernancePool = this.getGovernancePool.bind(this);
+    this.getGovernanceChainsInfo = this.getGovernanceChainsInfo.bind(this);
   }
 
   get basicAuthHeaders() {
@@ -222,8 +233,8 @@ class BlockchainService {
   );
 
   /**
-   * @deprecated In favor of getPlatformFees
-   */
+     * @deprecated In favor of getPlatformFees
+     */
   getTokensFee = () => fetchWithValidation(
     `${this.apiUrl}/api/tokensFee`,
     z.record(z.string()).transform(makePartial),
@@ -420,9 +431,9 @@ class BlockchainService {
   );
 
   /**
-   * Sender is user address in source BlockchainService instance \
-   * Receiver is user address in target BlockchainService instance
-   */
+     * Sender is user address in source BlockchainService instance \
+     * Receiver is user address in target BlockchainService instance
+     */
   getAtomicSwapHistory = (query: AtomicSwapHistorySourceQuery | AtomicSwapHistoryTargetQuery) => {
     const url = new URL(`${this.apiUrl}/api/atomic/history/`);
 
@@ -476,6 +487,30 @@ class BlockchainService {
       body: JSON.stringify(secretHashes),
     },
   );
+
+  getGovernanceContracts = () => fetchWithValidation(
+    `${this.apiUrl}/api/governance/info`,
+    governanceContractsSchema,
+    { headers: this.basicAuthHeaders },
+  );
+
+  getGovernancePools = () => fetchWithValidation(
+    `${this.apiUrl}/api/governance/pools`,
+    governancePoolsSchema,
+    { headers: this.basicAuthHeaders },
+  );
+
+  getGovernancePool = (address: string) => fetchWithValidation(
+    `${this.apiUrl}/api/governance/pools/${address}`,
+    governancePoolSchema,
+    { headers: this.basicAuthHeaders },
+  );
+
+  getGovernanceChainsInfo = () => fetchWithValidation(
+    `${this.apiUrl}/api/governance/chains-info`,
+    governanceChainsInfoSchema,
+    { headers: this.basicAuthHeaders },
+  );
 }
 
 export * as schemas from './schemas/index.js';

src/services/BlockchainService/schemas/governanceChainsInfoSchema.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+
+const governanceChainsInfoSchema = z.object({
+  isChainSupported: z.boolean(),
+});
+
+export default governanceChainsInfoSchema;

src/services/BlockchainService/schemas/governanceContractsSchema.ts

@@ -0,0 +1,19 @@
+import { z } from 'zod';
+
+const governanceContractsSchema = z.object({
+  controllerAddress: z.string(),
+  veTOKENAddress: z.string(),
+  veTOKENYieldDistributorV4Address: z.string(),
+  time_total: z.string(),
+  absolute_ve_token_in_voting: z.string(),
+  info: z.record(
+    z.string(),
+    z.object({
+      gaugeAddress: z.string(),
+      gaugeType: z.number(),
+      gaugeName: z.string(),
+    })
+  ),
+});
+
+export default governanceContractsSchema;

src/services/BlockchainService/schemas/governancePoolSchema.ts

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+
+const governancePoolSchema = z.object({
+  min_apr: z.string(),
+  max_apr: z.string(),
+  tvl: z.string(),
+  lp_supply: z.string(),
+  lp_staked: z.string(),
+  lp_staked_with_boost: z.string(),
+  lp_price_in_usd: z.string(),
+  reward_per_period: z.string(),
+  lock_time_for_max_multiplier: z.string(),
+  lock_max_multiplier: z.string(),
+  veorn_max_multiplier: z.string(),
+  veorn_boost_scale_factor: z.string(),
+});
+
+export default governancePoolSchema;

src/services/BlockchainService/schemas/governancePoolsSchema.ts

@@ -0,0 +1,28 @@
+import { z } from 'zod';
+
+const governancePoolsSchema = z.array(
+  z.object({
+    slug: z.string(),
+    identifier: z.string(),
+    chain: z.string(),
+    platform: z.string(),
+    logo: z.string(),
+    pair: z.string(),
+    lp_address: z.string(),
+    lp_staked: z.string(),
+    lp_staked_with_boost: z.string(),
+    lp_supply: z.string(),
+    lp_price_in_usd: z.string(),
+    farm_address: z.string(),
+    pool_tokens: z.tuple([z.string(), z.string()]),
+    pool_rewards: z.array(z.string()),
+    tvl: z.string(),
+    min_apr: z.string(),
+    max_apr: z.string(),
+    reward_per_period: z.array(z.string()),
+    weight: z.string(),
+    liquidity: z.string(),
+  })
+);
+
+export default governancePoolsSchema;

src/services/BlockchainService/schemas/index.ts

@@ -12,5 +12,9 @@ export { default as atomicSummarySchema } from './atomicSummarySchema.js';
 export { default as poolsLpAndStakedSchema } from './poolsLpAndStakedSchema.js';
 export { default as userVotesSchema } from './userVotesSchema.js';
 export { default as userEarnedSchema } from './userEarnedSchema.js';
+export { default as governanceContractsSchema } from './governanceContractsSchema.js';
+export { default as governancePoolsSchema } from './governancePoolsSchema.js';
+export { default as governancePoolSchema } from './governancePoolSchema.js';
+export { default as governanceChainsInfoSchema } from './governanceChainsInfoSchema.js';
 export { default as poolsV3InfoSchema } from './poolsV3InfoSchema.js';
 export { pricesWithQuoteAssetSchema } from './pricesWithQuoteAssetSchema.js';