fix(staking-sdk): fix staking-sdk build

cprussin · cprussin · commit b0d68f775a1c · 2025-04-06T14:17:31.000-07:00
This commit makes the following related changes: - Fix `@pythnetwork/staking-sdk` build -- the prior build process created an unusable package due to producing invalid references in `package.json`. - Clean up `@pythnetwork/staking-sdk` typescript configs, using nodenext for the target and module resolution strategy - Fix import statements in `@pythnetwork/staking-sdk` to properly work with nodenext resolution - Distribute `@pythnetwork/staking-sdk` as esm-only -- nowadays supporting cjs is making less sense and in particular some of the underlying solana libs are distributed as esm-only, so it really doesn't make sense for us to distribute cjs - Stop using nextjs's `transpilePackages` for apps that depend on monorepo packages -- this makes less sense nowadays with [turbo watch](https://turbo.build/docs/reference/watch) and it has some major downsides, in particular it doesn't work if you have different tsconfig settings between apps and the packages they depend on.
diff --git a/apps/api-reference/next.config.js b/apps/api-reference/next.config.js
@@ -29,8 +29,6 @@ export default {
     return config;
   },
 
-  transpilePackages: ["@pythnetwork/*"],
-
   headers: () => [
     {
       source: "/:path*",
diff --git a/apps/insights/next.config.js b/apps/insights/next.config.js
@@ -22,8 +22,6 @@ const config = {
     return config;
   },
 
-  transpilePackages: ["@pythnetwork/*"],
-
   headers: async () => [
     {
       source: "/:path*",
diff --git a/apps/insights/turbo.json b/apps/insights/turbo.json
@@ -14,13 +14,6 @@
         "DISABLE_ACCESSIBILITY_REPORTING"
       ]
     },
-    "start:dev": {
-      "dependsOn": [
-        "//#install:modules",
-        "pull:env",
-        "@pythnetwork/solana-utils#build"
-      ]
-    },
     "fix:lint": {
       "dependsOn": [
         "//#install:modules",
diff --git a/apps/staking/next.config.js b/apps/staking/next.config.js
@@ -22,8 +22,6 @@ export default {
     return config;
   },
 
-  transpilePackages: ["@pythnetwork/*"],
-
   headers: () => [
     {
       source: "/:path*",
diff --git a/apps/staking/turbo.json b/apps/staking/turbo.json
@@ -14,14 +14,6 @@
         "AMPLITUDE_API_KEY",
         "GOOGLE_ANALYTICS_ID"
       ]
-    },
-    "start:dev": {
-      "dependsOn": [
-        "//#install:modules",
-        "pull:env",
-        "@pythnetwork/hermes-client#build",
-        "@pythnetwork/solana-utils#build"
-      ]
     }
   }
 }
diff --git a/governance/pyth_staking_sdk/package.json b/governance/pyth_staking_sdk/package.json
@@ -1,10 +1,14 @@
 {
   "name": "@pythnetwork/staking-sdk",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Pyth staking SDK",
-  "main": "src/index.ts",
-  "types": "src/index.d.ts",
   "type": "module",
+  "exports": {
+    "import": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
   "files": [
     "dist/**/*"
   ],
@@ -15,10 +19,9 @@
     "access": "public"
   },
   "scripts": {
-    "build": "tsc",
+    "build": "tsc --noEmit false --incremental false --declaration true --outDir ./dist",
     "fix:format": "prettier --write .",
     "fix:lint": "eslint --fix . --max-warnings 0",
-    "prepublishOnly": "node scripts/update-package-json.mjs",
     "test:format": "prettier --check .",
     "test:lint": "eslint . --max-warnings 0",
     "test:types": "tsc"
diff --git a/governance/pyth_staking_sdk/scripts/update-package-json.mjs b/governance/pyth_staking_sdk/scripts/update-package-json.mjs
diff --git a/governance/pyth_staking_sdk/src/idl/integrity-pool.json b/governance/pyth_staking_sdk/src/idl/integrity-pool.json
diff --git a/governance/pyth_staking_sdk/src/idl/publisher-caps.json b/governance/pyth_staking_sdk/src/idl/publisher-caps.json
diff --git a/governance/pyth_staking_sdk/src/idl/stake-caps-parameters.json b/governance/pyth_staking_sdk/src/idl/stake-caps-parameters.json
diff --git a/governance/pyth_staking_sdk/src/idl/staking.json b/governance/pyth_staking_sdk/src/idl/staking.json
diff --git a/governance/pyth_staking_sdk/src/index.ts b/governance/pyth_staking_sdk/src/index.ts
@@ -1,9 +1,9 @@
-export * from "./pdas";
-export * from "./pyth-staking-client";
-export * from "./pythnet-client";
-export * from "./types";
-export * from "./utils/apy";
-export * from "./utils/clock";
-export * from "./utils/pool";
-export * from "./utils/position";
-export * from "./utils/vesting";
+export * from "./pdas.js";
+export * from "./pyth-staking-client.js";
+export * from "./pythnet-client.js";
+export * from "./types.js";
+export * from "./utils/apy.js";
+export * from "./utils/clock.js";
+export * from "./utils/pool.js";
+export * from "./utils/position.js";
+export * from "./utils/vesting.js";
diff --git a/governance/pyth_staking_sdk/src/pdas.ts b/governance/pyth_staking_sdk/src/pdas.ts
@@ -4,7 +4,7 @@ import {
   INTEGRITY_POOL_PROGRAM_ADDRESS,
   STAKE_CAPS_PARAMETERS_PROGRAM_ADDRESS,
   STAKING_PROGRAM_ADDRESS,
-} from "./constants";
+} from "./constants.js";
 
 export const getConfigAddress = () => {
   return PublicKey.findProgramAddressSync(
diff --git a/governance/pyth_staking_sdk/src/pyth-staking-client.ts b/governance/pyth_staking_sdk/src/pyth-staking-client.ts
@@ -30,15 +30,21 @@ import {
   FRACTION_PRECISION_N,
   ONE_YEAR_IN_SECONDS,
   POSITIONS_ACCOUNT_SIZE,
-} from "./constants";
+} from "./constants.js";
+import IntegrityPoolIdl from "./idl/integrity-pool.json" with { type: "json" };
+import PublisherCapsIdl from "./idl/publisher-caps.json" with { type: "json" };
+import StakingIdl from "./idl/staking.json" with { type: "json" };
 import {
   getConfigAddress,
   getDelegationRecordAddress,
   getPoolConfigAddress,
   getStakeAccountCustodyAddress,
   getStakeAccountMetadataAddress,
   getTargetAccountAddress,
-} from "./pdas";
+} from "./pdas.js";
+import type { IntegrityPool } from "./types/integrity-pool.js";
+import type { PublisherCaps } from "./types/publisher-caps.js";
+import type { Staking } from "./types/staking.js";
 import type {
   GlobalConfig,
   PoolConfig,
@@ -47,27 +53,21 @@ import type {
   TargetAccount,
   VoterWeightAction,
   VestingSchedule,
-} from "./types";
-import { PositionState } from "./types";
-import type { Staking } from "../types/staking";
-import { bigintMax, bigintMin } from "./utils/bigint";
-import { convertBigIntToBN, convertBNToBigInt } from "./utils/bn";
-import { epochToDate, getCurrentEpoch } from "./utils/clock";
-import { extractPublisherData } from "./utils/pool";
+} from "./types.js";
+import { PositionState } from "./types.js";
+import { bigintMax, bigintMin } from "./utils/bigint.js";
+import { convertBigIntToBN, convertBNToBigInt } from "./utils/bn.js";
+import { epochToDate, getCurrentEpoch } from "./utils/clock.js";
+import { extractPublisherData } from "./utils/pool.js";
 import {
   deserializeStakeAccountPositions,
   getPositionState,
   getVotingTokenAmount,
-} from "./utils/position";
-import { sendTransaction } from "./utils/transaction";
-import { getUnlockSchedule } from "./utils/vesting";
-import type { PythStakingWallet } from "./utils/wallet";
-import { DummyWallet } from "./utils/wallet";
-import * as IntegrityPoolIdl from "../idl/integrity-pool.json";
-import * as PublisherCapsIdl from "../idl/publisher-caps.json";
-import * as StakingIdl from "../idl/staking.json";
-import type { IntegrityPool } from "../types/integrity-pool";
-import type { PublisherCaps } from "../types/publisher-caps";
+} from "./utils/position.js";
+import { sendTransaction } from "./utils/transaction.js";
+import { getUnlockSchedule } from "./utils/vesting.js";
+import type { PythStakingWallet } from "./utils/wallet.js";
+import { DummyWallet } from "./utils/wallet.js";
 
 export type PythStakingClientConfig = {
   connection: Connection;
diff --git a/governance/pyth_staking_sdk/src/pythnet-client.ts b/governance/pyth_staking_sdk/src/pythnet-client.ts
@@ -7,11 +7,11 @@ import {
 } from "@pythnetwork/client";
 import { Connection } from "@solana/web3.js";
 
-import { getStakeCapsParametersAddress } from "./pdas";
-import { convertBNToBigInt } from "./utils/bn";
-import { DummyWallet } from "./utils/wallet";
-import * as StakeCapsParametersIdl from "../idl/stake-caps-parameters.json";
-import type { StakeCapsParameters } from "../types/stake-caps-parameters";
+import StakeCapsParametersIdl from "./idl/stake-caps-parameters.json" with { type: "json" };
+import { getStakeCapsParametersAddress } from "./pdas.js";
+import type { StakeCapsParameters } from "./types/stake-caps-parameters.js";
+import { convertBNToBigInt } from "./utils/bn.js";
+import { DummyWallet } from "./utils/wallet.js";
 export class PythnetClient {
   connection: Connection;
   provider: AnchorProvider;
diff --git a/governance/pyth_staking_sdk/src/types.ts b/governance/pyth_staking_sdk/src/types.ts
@@ -1,8 +1,8 @@
 import type { BN, IdlAccounts, IdlTypes } from "@coral-xyz/anchor";
 import { PublicKey } from "@solana/web3.js";
 
-import type { IntegrityPool } from "../types/integrity-pool";
-import type { Staking } from "../types/staking";
+import type { IntegrityPool } from "./types/integrity-pool.js";
+import type { Staking } from "./types/staking.js";
 
 // This type converts all From types to To types in a given object.
 export type Convert<T, From, To> = T extends From
diff --git a/governance/pyth_staking_sdk/src/types/integrity-pool.ts b/governance/pyth_staking_sdk/src/types/integrity-pool.ts
diff --git a/governance/pyth_staking_sdk/src/types/publisher-caps.ts b/governance/pyth_staking_sdk/src/types/publisher-caps.ts
diff --git a/governance/pyth_staking_sdk/src/types/stake-caps-parameters.ts b/governance/pyth_staking_sdk/src/types/stake-caps-parameters.ts
diff --git a/governance/pyth_staking_sdk/src/types/staking.ts b/governance/pyth_staking_sdk/src/types/staking.ts
diff --git a/governance/pyth_staking_sdk/src/utils/apy.ts b/governance/pyth_staking_sdk/src/utils/apy.ts
@@ -1,4 +1,4 @@
-import { FRACTION_PRECISION } from "../constants";
+import { FRACTION_PRECISION } from "../constants.js";
 
 export const convertEpochYieldToApy = (epochYield: bigint) => {
   return (Number(epochYield) * 52 * 100) / FRACTION_PRECISION;
diff --git a/governance/pyth_staking_sdk/src/utils/bn.ts b/governance/pyth_staking_sdk/src/utils/bn.ts
@@ -3,7 +3,7 @@
 /* eslint-disable @typescript-eslint/no-unsafe-return */
 import { BN } from "@coral-xyz/anchor";
 
-import type { ConvertBigIntToBN, ConvertBNToBigInt } from "../types";
+import type { ConvertBigIntToBN, ConvertBNToBigInt } from "../types.js";
 
 export const convertBNToBigInt = <T>(obj: T): ConvertBNToBigInt<T> => {
   if (obj instanceof BN) {
diff --git a/governance/pyth_staking_sdk/src/utils/clock.ts b/governance/pyth_staking_sdk/src/utils/clock.ts
@@ -1,6 +1,6 @@
 import { Connection } from "@solana/web3.js";
 
-import { EPOCH_DURATION } from "../constants";
+import { EPOCH_DURATION } from "../constants.js";
 
 export const getCurrentSolanaTimestamp = async (connection: Connection) => {
   const slot = await connection.getSlot("finalized");
diff --git a/governance/pyth_staking_sdk/src/utils/pool.ts b/governance/pyth_staking_sdk/src/utils/pool.ts
@@ -3,9 +3,9 @@ import { PublicKey } from "@solana/web3.js";
 import {
   computeDelegatorRewardPercentage,
   convertEpochYieldToApy,
-} from "./apy";
-import { FRACTION_PRECISION_N } from "../constants";
-import type { PoolDataAccount, PublisherData } from "../types";
+} from "./apy.js";
+import { FRACTION_PRECISION_N } from "../constants.js";
+import type { PoolDataAccount, PublisherData } from "../types.js";
 
 export const extractPublisherData = (
   poolData: PoolDataAccount,
diff --git a/governance/pyth_staking_sdk/src/utils/position.ts b/governance/pyth_staking_sdk/src/utils/position.ts
@@ -1,19 +1,19 @@
 import { BorshCoder } from "@coral-xyz/anchor";
 import { PublicKey } from "@solana/web3.js";
 
-import { convertBNToBigInt } from "./bn";
-import type { Staking } from "../../types/staking";
+import { convertBNToBigInt } from "./bn.js";
 import {
   POSITION_BUFFER_SIZE,
   POSITIONS_ACCOUNT_HEADER_SIZE,
-} from "../constants";
+} from "../constants.js";
+import type { Staking } from "../types/staking.js";
 import type {
   Position,
   PositionAnchor,
   StakeAccountPositions,
   TargetWithParameters,
-} from "../types";
-import { PositionState } from "../types";
+} from "../types.js";
+import { PositionState } from "../types.js";
 
 export const getPositionState = (
   position: Position,
diff --git a/governance/pyth_staking_sdk/src/utils/transaction.ts b/governance/pyth_staking_sdk/src/utils/transaction.ts
@@ -1,7 +1,7 @@
 import { TransactionBuilder } from "@pythnetwork/solana-utils";
 import { Connection, TransactionInstruction } from "@solana/web3.js";
 
-import type { PythStakingWallet } from "./wallet";
+import type { PythStakingWallet } from "./wallet.js";
 
 export const sendTransaction = async (
   instructions: TransactionInstruction[],
diff --git a/governance/pyth_staking_sdk/src/utils/vesting.ts b/governance/pyth_staking_sdk/src/utils/vesting.ts
@@ -1,4 +1,4 @@
-import type { UnlockSchedule, VestingSchedule } from "../types";
+import type { UnlockSchedule, VestingSchedule } from "../types.js";
 
 export const getUnlockSchedule = (options: {
   pythTokenListTime: bigint;
diff --git a/governance/pyth_staking_sdk/tsconfig.json b/governance/pyth_staking_sdk/tsconfig.json
@@ -1,18 +1,4 @@
 {
   "extends": "@cprussin/tsconfig/base.json",
-  "include": ["**/*.ts", "**/*.json"],
-  "exclude": ["node_modules", "dist"],
-  "compilerOptions": {
-    "outDir": "./dist",
-    "baseUrl": "./",
-    "noEmit": false,
-    "target": "ESNext",
-    "module": "CommonJS",
-    "moduleResolution": "Node",
-    "declaration": true,
-    "composite": true,
-    "declarationMap": true,
-    "esModuleInterop": true,
-    "verbatimModuleSyntax": false
-  }
+  "exclude": ["node_modules", "dist"]
 }
diff --git a/governance/xc_admin/packages/xc_admin_frontend/turbo.json b/governance/xc_admin/packages/xc_admin_frontend/turbo.json
@@ -8,9 +8,6 @@
         "NEXT_PUBLIC_MAINNET_RPC",
         "NEXT_PUBLIC_WALLETCONNECT_PROJECT_ID"
       ]
-    },
-    "start:dev": {
-      "dependsOn": ["//#install:modules", "pull:env", "^build"]
     }
   }
 }
diff --git a/turbo.json b/turbo.json
@@ -133,7 +133,7 @@
       "cache": false
     },
     "start:dev": {
-      "dependsOn": ["//#install:modules", "pull:env"],
+      "dependsOn": ["//#install:modules", "pull:env", "^build"],
       "persistent": true,
       "cache": false
     },

Original file line number	Diff line number	Diff line change
`@@ -29,8 +29,6 @@ export default {`
`29`	`29`	`return config;`
`30`	`30`	`},`
`31`	`31`
`32`		`- transpilePackages: ["@pythnetwork/*"],`
`33`		`-`
`34`	`32`	`headers: () => [`
`35`	`33`	`{`
`36`	`34`	`source: "/:path*",`
Original file line number	Diff line number	Diff line change
`@@ -22,8 +22,6 @@ const config = {`
`22`	`22`	`return config;`
`23`	`23`	`},`
`24`	`24`
`25`		`- transpilePackages: ["@pythnetwork/*"],`
`26`		`-`
`27`	`25`	`headers: async () => [`
`28`	`26`	`{`
`29`	`27`	`source: "/:path*",`
Original file line number	Diff line number	Diff line change
`@@ -22,8 +22,6 @@ export default {`
`22`	`22`	`return config;`
`23`	`23`	`},`
`24`	`24`
`25`		`- transpilePackages: ["@pythnetwork/*"],`
`26`		`-`
`27`	`25`	`headers: () => [`
`28`	`26`	`{`
`29`	`27`	`source: "/:path*",`
Original file line number	Diff line number	Diff line change
`@@ -14,14 +14,6 @@`
`14`	`14`	`"AMPLITUDE_API_KEY",`
`15`	`15`	`"GOOGLE_ANALYTICS_ID"`
`16`	`16`	`]`
`17`		`- },`
`18`		`- "start:dev": {`
`19`		`- "dependsOn": [`
`20`		`- "//#install:modules",`
`21`		`- "pull:env",`
`22`		`- "@pythnetwork/hermes-client#build",`
`23`		`- "@pythnetwork/solana-utils#build"`
`24`		`- ]`
`25`	`17`	`}`
`26`	`18`	`}`
`27`	`19`	`}`