feat: add solana chains

Author: gavriliumircea

package.json

@@ -64,6 +64,10 @@
       "types": "./dist/evm/releases/index.d.ts",
       "default": "./dist/evm/releases/index.js"
     },
+    "./solana": {
+      "types": "./dist/solana/index.d.ts",
+      "default": "./dist/solana/index.js"
+    },
     "./package.json": "./package.json",
     "./dist/*": "./dist/*"
   },

src/index.ts

@@ -1,4 +1,3 @@
-export * from "./evm";
 export * from "./helpers";
 export * from "./sablier";
 export * from "./types";

src/sablier.ts

@@ -1,6 +1,6 @@
 /**
  * @file This file exports the Sablier object, singleton that contains the queries for the
- * chains, contracts, and releases.
+ * chains, contracts, and releases for both evm and solana compatible chains.
  *
  * @example
  * ```typescript
@@ -27,6 +27,7 @@ import _ from "lodash";
 import { chainsQueries as evmChainsQueries } from "./evm/chains/queries";
 import { contractsQueries as evmContractsQueries } from "./evm/contracts/queries";
 import { releasesQueries as evmReleasesQueries } from "./evm/releases/queries";
+import { chainsQueries as solanaChainsQueries } from "./solana/chains/queries";
 
 /**
  * Has to be defined here to avoid circular dependencies.
@@ -53,7 +54,12 @@ const evm = {
   releases: evmReleasesQueries,
 };
 
+const solana = {
+  chains: solanaChainsQueries,
+};
+
 export const sablier = {
   ...evm, // re-exporting for backward compatibility
   evm,
+  solana,
 };

src/solana/chains/data.ts

@@ -0,0 +1,81 @@
+import type { Sablier } from "@src/types";
+
+const CHAIN_ID_SOLANA_MAINNET_BETA = 900000010;
+const CHAIN_ID_SOLANA_DEVNET = 900000020;
+
+export const solana_devnet: Sablier.Solana.Chain = {
+  blockExplorers: {
+    default: { name: "Explorer", url: "https://solscan.io?cluster=devnet" },
+    solanaFm: {
+      name: "Solana FM",
+      url: "https://solana.fm?cluster=devnet-alpha",
+    },
+  },
+  chainlink: {
+    feed: "99B2bTijsU6f1GCT73HmdR7HCFFjGMBcPZY6jZ96ynrR",
+    program: "HEvSKofvBgfaexv23kMabbYqxasxU3mQ4ibBMEmJWHny",
+  },
+  contracts: {},
+  definition: {
+    chainCode: "SOLDEV",
+    chainId: CHAIN_ID_SOLANA_DEVNET,
+    cluster: "devnet",
+  },
+  id: CHAIN_ID_SOLANA_DEVNET,
+  isSupportedByUI: true,
+  isTestnet: true,
+  name: "Devnet",
+  nativeCurrency: {
+    coinGeckoId: "solana",
+    decimals: 9,
+    name: "Solana",
+    symbol: "SOL",
+  },
+  rpc: {
+    defaults: ["https://api.devnet-beta.solana.com/"],
+    helius: (key) => `https://devnet.helius-rpc.com/?api-key=${key}`,
+  },
+  rpcUrls: {
+    default: {
+      http: ["https://api.devnet-beta.solana.com/"],
+    },
+  },
+  slug: "solana-devnet",
+} as const;
+
+export const solana_mainnetBeta: Sablier.Solana.Chain = {
+  blockExplorers: {
+    default: { name: "Explorer", url: "https://solscan.io" },
+    solanaFm: { name: "Solana FM", url: "https://solana.fm" },
+  },
+  chainlink: {
+    feed: "99B2bTijsU6f1GCT73HmdR7HCFFjGMBcPZY6jZ96ynrR",
+    program: "HEvSKofvBgfaexv23kMabbYqxasxU3mQ4ibBMEmJWHny",
+  },
+  contracts: {},
+  definition: {
+    chainCode: "SOL",
+    chainId: CHAIN_ID_SOLANA_MAINNET_BETA,
+    cluster: "mainnet-beta",
+  },
+  id: CHAIN_ID_SOLANA_MAINNET_BETA,
+  isSupportedByUI: true,
+  isTestnet: false,
+  name: "Solana",
+  nativeCurrency: {
+    coinGeckoId: "solana",
+    decimals: 9,
+    name: "Solana",
+    symbol: "SOL",
+  },
+  rpc: {
+    defaults: ["https://api.mainnet-beta.solana.com/"],
+    helius: (key) => `https://mainnet.helius-rpc.com/?api-key=${key}`,
+  },
+  rpcUrls: {
+    default: {
+      http: ["https://api.mainnet-beta.solana.com/"],
+    },
+  },
+  slug: "solana-mainnet-beta",
+} as const;

src/solana/chains/index.ts

@@ -0,0 +1,2 @@
+export * as chains from "./data";
+export * from "./data";

src/solana/chains/queries.ts

@@ -0,0 +1,29 @@
+import { sortChains } from "@src/helpers";
+import type { Sablier } from "@src/types";
+import _ from "lodash";
+import * as chains from "./data";
+
+export const chainsQueries = {
+  get: (chainId: number): Sablier.Solana.Chain | undefined => {
+    return _.find(chains, (c) => c.id === chainId);
+  },
+  getAll: (): Sablier.Solana.Chain[] => {
+    return sortChains(_.values(chains));
+  },
+  getBySlug: (slug: string): Sablier.Solana.Chain | undefined => {
+    return _.find(chains, (c) => c.slug === slug);
+  },
+  getMainnets: (): Sablier.Solana.Chain[] => {
+    return sortChains(_.filter(_.values(chains), (c) => !c.isTestnet));
+  },
+  getOrThrow: (chainId: number): Sablier.Solana.Chain => {
+    const chain = _.find(chains, (c) => c.id === chainId);
+    if (!chain) {
+      throw new Error(`Sablier SDK: Chain with ID ${chainId} not found`);
+    }
+    return chain;
+  },
+  getTestnets: (): Sablier.Solana.Chain[] => {
+    return sortChains(_.filter(_.values(chains), (c) => c.isTestnet));
+  },
+};

src/solana/index.ts

@@ -1 +1,2 @@
+export { chains } from "./chains";
 export * from "./idl";

src/solana/types.ts

@@ -0,0 +1,49 @@
+import type { Chain as ViemChain } from "viem";
+
+/**
+ * @see https://github.com/wevm/viem/discussions/3678
+ */
+type ChainBlockExplorer = {
+  name: string;
+  url: string;
+  apiUrl?: string | undefined;
+};
+
+export namespace Solana {
+  export type Address = string;
+  export type ChainCode = "SOL" | "SOLDEV" | "SOLTEST";
+  export type Cluster = "mainnet-beta" | "devnet" | "testnet";
+
+  export type Chain = ViemChain & {
+    blockExplorers: {
+      [key: string]: ChainBlockExplorer;
+      default: ChainBlockExplorer;
+    };
+    /** Whether this chain is supported by the Sablier Interface at https://app.sablier.com. */
+    isSupportedByUI: boolean;
+    /** Whether this is a testnet network. */
+    isTestnet: boolean;
+    /** Whether this is a zkEVM like zkSync. */
+    nativeCurrency: ViemChain["nativeCurrency"] & {
+      coinGeckoId: string;
+    };
+    slug: string;
+
+    rpc: {
+      /** Helius RPC URL generator. */
+      helius?: (apiKey: string) => string;
+      /** Default RPC URL. */
+      defaults: string[];
+    };
+    /** Used in deployment files to identify the chain, e.g., arbitrum-sepolia. */
+    chainlink: {
+      program: Address; // Chainlink program used to retrieve on-chain price feeds
+      feed: Address; // Account providing the SOL/USD price feed data.
+    };
+    definition: {
+      chainCode: ChainCode;
+      chainId: number;
+      cluster: Cluster;
+    };
+  };
+}

src/types.ts

@@ -1,7 +1,9 @@
 import * as EVMTypes from "./evm/types";
+import * as SolanaTypes from "./solana/types";
 
 export namespace Sablier {
   export import EVM = EVMTypes.EVM;
+  export import Solana = SolanaTypes.Solana;
 
   /* -------------------------------------------------------------------------- */
   /*                           BACKWARD COMPATIBILITY                           */

tests/helpers/missing.ts

@@ -53,7 +53,7 @@ const MISSING_CONTRACTS: ProtocolMap = {
   lockup: MISSING_LOCKUP,
 };
 
-// Chains for which we completely lack broadcasts.
+// chains for which we completely lack broadcasts.
 export const MISSING_CHAINS: number[] = [chains.iotex.id, chains.ronin.id, chains.tangle.id];
 
 export function isKnownMissing(release: Sablier.EVM.Release, chain: Sablier.EVM.Chain, contractName: string): boolean {