refactor: extract evm specific data in separate directory

Author: gavriliumircea

CHANGELOG.md

@@ -5,11 +5,67 @@ All notable changes to this project will be documented in this file.
 The format is based on [Common Changelog](https://common-changelog.org/), and this project adheres to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+[2.0.0]: https://github.com/sablier-labs/sdk/releases/tag/v2.0.0
 [1.2.1]: https://github.com/sablier-labs/sdk/releases/tag/v1.2.1
 [1.2.0]: https://github.com/sablier-labs/sdk/releases/tag/v1.2.0
 [1.1.0]: https://github.com/sablier-labs/sdk/releases/tag/v1.1.0
 [1.0.0]: https://github.com/sablier-labs/sdk/releases/tag/v1.0.0
 
+## [2.0.0] - 2025-10-22
+
+### Breaking Changes
+
+This release prepares the SDK for multi-VM support by extracting all EVM-specific code into a dedicated namespace.
+
+#### Changed
+
+- **BREAKING**: Renamed `sablier.chains` → `sablier.evmChains`
+- **BREAKING**: Renamed `sablier.contracts` → `sablier.evmContracts`
+- **BREAKING**: Renamed `sablier.releases` → `sablier.evmReleases`
+- **BREAKING**: Renamed `sablier.deployments` → `sablier.evmDeployments`
+- **BREAKING**: All types moved to `Sablier.EVM.*` namespace:
+  - `Sablier.Address` → `Sablier.EVM.Address`
+  - `Sablier.Chain` → `Sablier.EVM.Chain`
+  - `Sablier.Contract` → `Sablier.EVM.Contract`
+  - `Sablier.Release` → `Sablier.EVM.Release`
+  - `Sablier.Deployment` → `Sablier.EVM.Deployment`
+  - `Sablier.Protocol` → `Sablier.EVM.Protocol`
+  - `Sablier.Version` → `Sablier.EVM.Version`
+- **BREAKING**: Package exports updated:
+  - `sablier/chains` → `sablier/evm/chains`
+  - `sablier/contracts` → `sablier/evm/contracts`
+  - `sablier/releases` → `sablier/evm/releases`
+
+#### Added
+
+- New export: `sablier/evm` for direct EVM-specific imports
+- Added package.json exports for EVM subpaths
+
+#### Moved
+
+- All EVM-specific code moved from `src/` to `src/evm/`:
+  - ABIs: `src/abi/` → `src/evm/abi/`
+  - Chains: `src/chains/` → `src/evm/chains/`
+  - Contracts: `src/contracts/` → `src/evm/contracts/`
+  - Releases: `src/releases/` → `src/evm/releases/`
+  - Enums: `src/enums.ts` → `src/evm/enums.ts`
+  - Comptroller: `src/comptroller.ts` → `src/evm/comptroller.ts`
+
+### Migration
+
+See [MIGRATION.md](./MIGRATION.md) for detailed migration instructions.
+
+**Quick migration**:
+
+```bash
+# Replace in your codebase
+sablier.chains → sablier.evmChains
+sablier.contracts → sablier.evmContracts
+sablier.releases → sablier.evmReleases
+Sablier.Chain → Sablier.EVM.Chain
+Sablier.Contract → Sablier.EVM.Contract
+```
+
 ## [1.2.1] - 2025-10-17
 
 ### Fixed

MIGRATION.md

@@ -0,0 +1,273 @@
+# Migration Guide
+
+## Migrating from v1.x to v2.0.0
+
+Version 2.0.0 introduces breaking changes to prepare the SDK for multi-VM support. All EVM-specific code has been
+namespaced under `evm` to allow future expansion to other VMs (like Solana).
+
+### Breaking Changes
+
+#### 1. Sablier API Renamed
+
+The `sablier` object properties have been renamed to include the `evm` prefix:
+
+**Before (v1.x)**:
+
+```typescript
+import { sablier } from "sablier";
+
+const chain = sablier.chains.get({ chainId: 1 });
+const contract = sablier.contracts.get({
+  name: "SablierLockup",
+  release: releases.lockup["v2.0"],
+  chainId: 1,
+});
+const releases = sablier.releases.getAll();
+const deployment = sablier.deployments.get({
+  chainId: 1,
+  release: releases.lockup["v2.0"],
+});
+```
+
+**After (v2.0.0)**:
+
+```typescript
+import { sablier } from "sablier";
+
+const chain = sablier.evmChains.get({ chainId: 1 });
+const contract = sablier.evmContracts.get({
+  name: "SablierLockup",
+  release: releases.lockup["v2.0"],
+  chainId: 1,
+});
+const releases = sablier.evmReleases.getAll();
+const deployment = sablier.evmDeployments.get({
+  chainId: 1,
+  release: releases.lockup["v2.0"],
+});
+```
+
+**Quick Replace**:
+
+- `sablier.chains` → `sablier.evmChains`
+- `sablier.contracts` → `sablier.evmContracts`
+- `sablier.releases` → `sablier.evmReleases`
+- `sablier.deployments` → `sablier.evmDeployments`
+
+#### 2. Import Paths Changed
+
+If you were using direct imports from subpaths, the paths have changed:
+
+**Before (v1.x)**:
+
+```typescript
+import { chains } from "sablier/chains";
+import { contracts } from "sablier/contracts";
+import { releases } from "sablier/releases";
+```
+
+**After (v2.0.0)**:
+
+```typescript
+// Option 1: Import from main entry point
+import { chains, contracts, releases } from "sablier";
+
+// Option 2: Import from EVM-specific paths
+import { chains } from "sablier/evm/chains";
+import { contracts } from "sablier/evm/contracts";
+import { releases } from "sablier/evm/releases";
+
+// Option 3: Import everything from evm
+import { chains, contracts, releases } from "sablier/evm";
+```
+
+**Recommendation**: Use Option 1 (main entry point) unless you need to optimize bundle size.
+
+#### 3. Type Namespace Updated
+
+All EVM-specific types are now under the `Sablier.EVM` namespace:
+
+**Before (v1.x)**:
+
+```typescript
+import type { Sablier } from "sablier";
+
+type Address = Sablier.Address;
+type Chain = Sablier.Chain;
+type Contract = Sablier.Contract;
+type Release = Sablier.Release;
+type Deployment = Sablier.Deployment;
+type Protocol = Sablier.Protocol;
+type Version = Sablier.Version;
+```
+
+**After (v2.0.0)**:
+
+```typescript
+import type { Sablier } from "sablier";
+
+type Address = Sablier.EVM.Address;
+type Chain = Sablier.EVM.Chain;
+type Contract = Sablier.EVM.Contract;
+type Release = Sablier.EVM.Release;
+type Deployment = Sablier.EVM.Deployment;
+type Protocol = Sablier.EVM.Protocol;
+type Version = Sablier.EVM.Version;
+```
+
+**Quick Replace in TypeScript files**:
+
+- `Sablier.Address` → `Sablier.EVM.Address`
+- `Sablier.Chain` → `Sablier.EVM.Chain`
+- `Sablier.Contract` → `Sablier.EVM.Contract`
+- `Sablier.Release` → `Sablier.EVM.Release`
+- `Sablier.Deployment` → `Sablier.EVM.Deployment`
+- `Sablier.Protocol` → `Sablier.EVM.Protocol`
+- `Sablier.Version` → `Sablier.EVM.Version`
+
+### Non-Breaking Changes
+
+The following imports continue to work without changes:
+
+```typescript
+// These still work exactly the same
+import { chains } from "sablier";
+import { contracts } from "sablier";
+import { releases } from "sablier";
+import { sablier } from "sablier";
+
+// Direct exports like these are unchanged
+import { mainnet, arbitrum, polygon } from "sablier";
+import { Protocol, Version } from "sablier";
+```
+
+### Migration Checklist
+
+Use this checklist to ensure you've updated everything:
+
+- [ ] Update all `sablier.chains.*` to `sablier.evmChains.*`
+- [ ] Update all `sablier.contracts.*` to `sablier.evmContracts.*`
+- [ ] Update all `sablier.releases.*` to `sablier.evmReleases.*`
+- [ ] Update all `sablier.deployments.*` to `sablier.evmDeployments.*`
+- [ ] Update all `Sablier.Address` type references to `Sablier.EVM.Address`
+- [ ] Update all `Sablier.Chain` type references to `Sablier.EVM.Chain`
+- [ ] Update all `Sablier.Contract` type references to `Sablier.EVM.Contract`
+- [ ] Update all `Sablier.Release` type references to `Sablier.EVM.Release`
+- [ ] Update all `Sablier.Deployment` type references to `Sablier.EVM.Deployment`
+- [ ] Update any direct import paths from `sablier/chains` to `sablier/evm/chains` (or use main entry)
+- [ ] Run TypeScript compiler to catch any remaining type errors
+- [ ] Test your application thoroughly
+
+### Automated Migration
+
+You can use find-and-replace to automate most of the migration:
+
+#### Runtime Code:
+
+```bash
+# Find and replace in your codebase
+sablier.chains → sablier.evmChains
+sablier.contracts → sablier.evmContracts
+sablier.releases → sablier.evmReleases
+sablier.deployments → sablier.evmDeployments
+```
+
+#### Type Definitions:
+
+```bash
+# Find and replace type references
+Sablier.Address → Sablier.EVM.Address
+Sablier.Chain → Sablier.EVM.Chain
+Sablier.Contract → Sablier.EVM.Contract
+Sablier.Release → Sablier.EVM.Release
+Sablier.Deployment → Sablier.EVM.Deployment
+Sablier.Protocol → Sablier.EVM.Protocol
+Sablier.Version → Sablier.EVM.Version
+```
+
+#### Import Paths:
+
+```bash
+# If you used direct imports (optional)
+"sablier/chains" → "sablier/evm/chains"
+"sablier/contracts" → "sablier/evm/contracts"
+"sablier/releases" → "sablier/evm/releases"
+```
+
+### Why This Change?
+
+This refactor prepares the SDK for multi-VM support. The EVM namespace makes it explicit which blockchain VM you're
+working with and allows us to add support for other VMs in the future:
+
+```typescript
+// Future (planned):
+sablier.evmChains; // Ethereum, Arbitrum, Polygon, etc.
+sablier.solanaChains; // Solana mainnet, devnet, testnet
+sablier.evmContracts; // EVM smart contracts
+sablier.solanaPrograms; // Solana programs
+```
+
+By namespacing everything under `evm`, we're making the codebase more maintainable and preparing for a multi-chain
+future.
+
+### Need Help?
+
+If you encounter any issues during migration:
+
+1. Check the [README](./README.md) for updated examples
+2. Review the [CHANGELOG](./CHANGELOG.md) for detailed changes
+3. Open a [discussion](https://github.com/sablier-labs/sdk/discussions) on GitHub
+4. Join our [Discord](https://discord.sablier.com) for community support
+
+### Example Migration
+
+Here's a complete before/after example:
+
+**Before (v1.x)**:
+
+```typescript
+import { sablier, releases, chains } from "sablier";
+import type { Sablier } from "sablier";
+
+function getContractInfo(chainId: number): {
+  chain: Sablier.Chain;
+  contract: Sablier.Contract;
+} {
+  const chain = sablier.chains.get({ chainId });
+  const contract = sablier.contracts.get({
+    name: "SablierLockup",
+    release: releases.lockup["v2.0"],
+    chainId,
+  });
+
+  return { chain, contract };
+}
+```
+
+**After (v2.0.0)**:
+
+```typescript
+import { sablier, releases, chains } from "sablier";
+import type { Sablier } from "sablier";
+
+function getContractInfo(chainId: number): {
+  chain: Sablier.EVM.Chain;
+  contract: Sablier.EVM.Contract;
+} {
+  const chain = sablier.evmChains.get({ chainId });
+  const contract = sablier.evmContracts.get({
+    name: "SablierLockup",
+    release: releases.lockup["v2.0"],
+    chainId,
+  });
+
+  return { chain, contract };
+}
+```
+
+Notice the changes:
+
+1. `sablier.chains` → `sablier.evmChains`
+2. `sablier.contracts` → `sablier.evmContracts`
+3. `Sablier.Chain` → `Sablier.EVM.Chain`
+4. `Sablier.Contract` → `Sablier.EVM.Contract`

README.md

@@ -66,13 +66,13 @@ import { chains, sablier } from "sablier";
 const mainnet = chains.mainnet;
 
 // Get chain by ID
-const arbitrum = sablier.chains.queries.get({ chainId: 42161 });
+const arbitrum = sablier.evmChains.get(42161);
 
 // Get chain by slug
-const polygon = sablier.chains.queries.get({ slug: "polygon" });
+const polygon = sablier.evmChains.getBySlug("polygon");
 
 // Check if chain supports Sablier UI
-if (arbitrum.isSupportedByUI) {
+if (arbitrum?.isSupportedByUI) {
   console.log("Arbitrum available on app.sablier.com");
 }
 ```
@@ -82,10 +82,11 @@ if (arbitrum.isSupportedByUI) {
 ```typescript
 import { releases, sablier } from "sablier";
 
-// Get contract by name and chain
-const lockup = sablier.contracts.get({
+// Get contract by name, release, and chain
+const lockup = sablier.evmContracts.get({
   name: "SablierLockup",
   release: releases.lockup["v2.0"],
+  chainId: 1, // Ethereum mainnet
 });
 ```
 
@@ -100,7 +101,7 @@ const lockupV2_0 = releases.lockup["v2.0"];
 const flowV1_1 = releases.flow["v1.1"];
 
 // Get all Lockup releases
-const allLockups = sablier.releases.getAll({ protocol: "lockup" });
+const allLockups = sablier.evmReleases.getAll({ protocol: "lockup" });
 ```
 
 ## Data Structure 📊

cli/commands/print/aliases.ts

@@ -12,7 +12,7 @@ type AliasRow = {
 async function printAliases(): Promise<void> {
   const rows: AliasRow[] = [];
 
-  for (const release of sablier.releases.getAll()) {
+  for (const release of sablier.evmReleases.getAll()) {
     const releaseName = `${_.capitalize(release.protocol)} ${release.version}`;
     if (!release.aliases) {
       logger.verbose(`Skipping ${releaseName} because it has no aliases`);