sablier 2.0.0-beta.8 → 2.0.0

package/CHANGELOG.md

@@ -0,0 +1,207 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Common Changelog](https://common-changelog.org/).
+
+> [!NOTE]
+>
+> Starting with v2.0.0, this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). In v1.x, it
+> did not always follow Semantic Versioning.
+
+[2.0.0]: https://github.com/sablier-labs/sdk/releases/tag/v2.0.0
+[1.8.0]: https://github.com/sablier-labs/sdk/releases/tag/v1.8.0
+[1.7.0]: https://github.com/sablier-labs/sdk/releases/tag/v1.7.0
+[1.6.1]: https://github.com/sablier-labs/sdk/releases/tag/v1.6.1
+[1.6.0]: https://github.com/sablier-labs/sdk/releases/tag/v1.6.0
+[1.5.0]: https://github.com/sablier-labs/sdk/releases/tag/v1.5.0
+[1.4.3]: https://github.com/sablier-labs/sdk/releases/tag/v1.4.3
+[1.4.2]: https://github.com/sablier-labs/sdk/releases/tag/v1.4.2
+[1.4.1]: https://github.com/sablier-labs/sdk/releases/tag/v1.4.1
+[1.4.0]: https://github.com/sablier-labs/sdk/releases/tag/v1.4.0
+[1.3.0]: https://github.com/sablier-labs/sdk/releases/tag/v1.3.0
+[1.2.2]: https://github.com/sablier-labs/sdk/releases/tag/v1.2.2
+[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] - 2026-01-23
+
+### Changed
+
+- **Breaking**: Adopt ESM-first packaging (`type: module`) with split outputs in `dist/esm`, `dist/cjs`, and
+  `dist/types`; update the export map with wildcard subpaths (`./evm/*`, `./solana/*`).
+- **Breaking**: Update `truncateAddress` to accept `{ start, end }` options instead of `chars` (use `truncate` as a
+  convenience alias).
+- **Breaking**:Move ABIs to top-level `abi/` and export them via `sablier/abi/*`.
+- Default Solana explorers to Orb (keep Solscan as secondary).
+- Update CLI command layout (`check-broadcasts` promoted to top-level); use `bunx tsx` as the runner.
+- Standardize shape identifiers and CSV template naming (aligned filenames, `DynamicDoubleUnlock` naming).
+
+### Added
+
+- Add top-level `shapes` module (airdrops/flow/lockup) with enums, helpers, types, and `isDeprecated` metadata.
+- Add CSV templates and JSON schemas for EVM and Solana (airdrops, flow, lockup duration/range) plus typed exports under
+  `sablier/evm/csv`, `sablier/solana/csv`, and raw assets via `sablier/csv/*`.
+- Add alias-based lookup APIs: `contracts.getByAlias`, `programs.getByAlias`, `resolveEvmContractByAlias`,
+  `resolveSolanaProgramByAlias`.
+- Add `getLatestByName` helper for contract lookups by name.
+- Add stream ID helpers (`resolveStreamId`, `resolveEvmStreamId`, `resolveSolanaStreamId`)
+- Add payability helper (`isReleasePayable`), which checks if a release allows `msg.value` on withdraw/claim operations.
+- Add compatibility helpers between Airdrops and Lockup releases for both EVM and Solana.
+- Add deployment broadcasts for additional EVM networks (IoTeX, Lightlink, Tangle, Superseed, and more) across
+  airdrops/flow/lockup/comptroller.
+- Export Solana chain ID constants (`CHAIN_ID_SOLANA_*`) and `SOLANA_CHAIN_IDS`.
+- Add wrapper contracts for native tokens (e.g., WETH) in `nativeCurrency.wrapperContract`.
+- Add `DOCS.md` with SDK usage, query surfaces, helpers, and data layouts.
+
+### Fixed
+
+- Normalize explorer URLs to avoid trailing slash issues.
+- Prevent runtime evaluation of type-only exports.
+
+### Removed
+
+- **Breaking**: Remove `sablier/dist/*` subpath export; use package exports instead.
+- **Breaking**: Remove `sortChains` and `getNestedValues` from public helpers (now internal).
+- Remove Monad testnet deployments/chain entry (`monad-testnet`).
+
+## [1.8.0] - 2026-01-16
+
+### Changed
+
+- Modularize comptroller into dedicated directory structure ([#134](https://github.com/sablier-labs/sdk/pull/134))
+
+### Added
+
+- Add SablierComptroller and ERC-1967 proxy ABIs ([#134](https://github.com/sablier-labs/sdk/pull/134))
+- Add comptroller manifest with contract names ([#134](https://github.com/sablier-labs/sdk/pull/134))
+- Export Comptroller queries via `sablier.comptroller` object ([#134](https://github.com/sablier-labs/sdk/pull/134))
+
+### Fixed
+
+- Checksum Comptroller address ([#134](https://github.com/sablier-labs/sdk/pull/134))
+- Fix pollution of default namespace by removing the comptroller exports
+  ([#134](https://github.com/sablier-labs/sdk/pull/134))
+
+## [1.7.0] - 2025-12-02
+
+### Changed
+
+- Extend comparison functions to support both EVM and Solana versions
+  ([#102](https://github.com/sablier-labs/sdk/pull/102))
+
+### Added
+
+- Add support for new EVM chain: Denergy ([#104](https://github.com/sablier-labs/sdk/pull/104))
+
+### Removed
+
+- Remove deprecated Morph Holesky testnet ([#103](https://github.com/sablier-labs/sdk/pull/103))
+
+## [1.6.1] - 2025-11-24
+
+### Fixed
+
+- Export ABIs ([#99](https://github.com/sablier-labs/sdk/pull/99))
+
+## [1.6.0] - 2025-11-19
+
+### Changed
+
+- Import Monad from viem
+
+### Added
+
+- Add utility for truncating addresses ([#91](https://github.com/sablier-labs/sdk/pull/91))
+
+## [1.5.0] - 2025-11-10
+
+### Changed
+
+- Move the EVM modules (abi, chains, contracts, releases, etc.) to the `evm` namespace
+
+### Added
+
+- Add Solana deployments ([#82](https://github.com/sablier-labs/sdk/pull/82),
+  [#83](https://github.com/sablier-labs/sdk/pull/83), [#84](https://github.com/sablier-labs/sdk/pull/84),
+  [#85](https://github.com/sablier-labs/sdk/pull/85), [#86](https://github.com/sablier-labs/sdk/pull/86),
+  [#88](https://github.com/sablier-labs/sdk/pull/88))
+- Add EVM and Solana types: `Sablier.EVM.*` and `Sablier.Solana.*` (note: `Sablier.*` is aliased to `Sablier.EVM.*`)
+- Add support for new EVM chain: Monad
+
+## [1.4.3] - 2025-11-09
+
+### Changed
+
+- Packages can be imported without `/dist` prefix
+
+### Fixed
+
+- Fix block number for Flow 2.0 on Linea
+- fix block number for Lockup 3.0 on Arbitrum Sepolia
+
+## [1.4.2] - 2025-10-22
+
+### Changed
+
+- Revert RouteMesh RPC provider to optional in chain type definitions
+
+## [1.4.1] - 2025-10-22
+
+### Changed
+
+- Make RouteMesh RPC provider non-optional in chain type definitions
+
+## [1.4.0] - 2025-10-22
+
+### Added
+
+- Version comparison utilities: `compareVersions`, `isVersionBefore`, and `isVersionAfter` helpers
+  ([#64](https://github.com/sablier-labs/sdk/pull/64))
+
+## [1.3.0] - 2025-10-21
+
+### Added
+
+- Add support for RouteMesh RPC provider ([#63](https://github.com/sablier-labs/sdk/pull/63))
+
+## [1.2.2] - 2025-10-21
+
+### Fixed
+
+- Update SEI CoinGecko ID to `sei-network`
+
+## [1.2.1] - 2025-10-17
+
+### Fixed
+
+- Include JSON ABIs in the package
+- Update POL CoinGecko ID to `polygon-ecosystem-token` ([#54](https://github.com/sablier-labs/sdk/pull/54))
+
+## [1.2.0] - 2025-10-15
+
+### Added
+
+- Airdrops v2.0 release ([#38](https://github.com/sablier-labs/sdk/pull/38))
+- Flow v2.0 release ([#43](https://github.com/sablier-labs/sdk/pull/43))
+- Lockup v3.0 release ([#41](https://github.com/sablier-labs/sdk/pull/41))
+- Query support for same address across releases ([#48](https://github.com/sablier-labs/sdk/pull/48))
+
+## [1.1.0] - 2025-08-21
+
+### Added
+
+- Add new EVM chain: Sonic ([#24](https://github.com/sablier-labs/sdk/pull/24))
+
+### Fixed
+
+- Correct start block for `SablierLockup` v2.0 contract on Mode chain
+  ([#22](https://github.com/sablier-labs/sdk/pull/22))
+
+## [1.0.0] - 2025-08-15
+
+### Added
+
+- Initial release

package/DOCS.md

@@ -0,0 +1,143 @@
+# Sablier SDK Documentation
+
+## Scope
+
+Use this SDK to read Sablier deployment data (addresses, releases, chains) for EVM and Solana. Pair it with viem or
+@solana/web3.js when you need RPC calls.
+
+## Installation
+
+```bash
+bun add sablier
+# or
+npm install sablier
+# or
+pnpm add sablier
+# or
+yarn add sablier
+```
+
+## Import patterns
+
+Use `sablier` for query APIs and `releases`/`chains`/`contracts` for raw data exports.
+
+```ts
+import { sablier, evm, solana, releases, contracts } from "sablier";
+import { chains as evmChains } from "sablier/evm/chains";
+import { chains as solanaChains } from "sablier/solana/chains";
+```
+
+Notes:
+
+- The root `sablier.chains`, `sablier.releases`, `sablier.contracts` are EVM queries. They are the same as
+  `sablier.evm.chains`, etc.
+- `sablier.evm` and `sablier.solana` scope the same query helpers by platform.
+- `evm` and `solana` are data modules (chains, releases, csv, helpers, enums).
+- `releases` and `contracts` are data exports, not queries. For queries, use `sablier.*`.
+
+## Usage
+
+### EVM
+
+Query chains, releases, contracts, and deployments:
+
+```ts
+import { sablier, chains } from "sablier";
+
+const mainnet = chains.mainnet;
+const latestLockup = sablier.releases.getLatest({ protocol: "lockup" });
+
+const lockup = sablier.contracts.get({
+  chainId: mainnet.id,
+  contractName: "SablierLockup",
+  release: latestLockup,
+});
+
+const byAlias = sablier.contracts.getByAlias({
+  alias: "LK2",
+  chainId: mainnet.id,
+  protocol: "lockup",
+});
+
+const deployment = sablier.deployments.get({
+  chainId: mainnet.id,
+  release: latestLockup,
+});
+```
+
+Query surface:
+
+- `sablier.chains.get|getAll|getBySlug|getMainnets|getTestnets|getOrThrow`
+- `sablier.releases.get|getAll|getFirst|getLatest`
+- `sablier.contracts.get|getAll|getByAlias|getLatestByName`
+- `sablier.deployments.get|getAll`
+- `sablier.comptroller.get|getAll` (governance proxy)
+
+### Solana
+
+Query chains, releases, programs, and deployments:
+
+```ts
+import { sablier } from "sablier";
+
+const mainnet = sablier.solana.chains.getBySlug("solana-mainnet-beta");
+const latestLockup = sablier.solana.releases.getLatest({ protocol: "lockup" });
+
+const program = sablier.solana.programs.get({
+  chainId: mainnet.id,
+  contractName: "SablierLockupLinear",
+  release: latestLockup,
+});
+
+const deployment = sablier.solana.deployments.get({
+  chainId: mainnet.id,
+  release: latestLockup,
+});
+```
+
+Query surface:
+
+- `sablier.solana.chains.get|getAll|getBySlug|getMainnets|getTestnets|getOrThrow`
+- `sablier.solana.releases.get|getAll|getFirst|getLatest`
+- `sablier.solana.programs.get|getAll|getByAlias|getLatestByName`
+- `sablier.solana.deployments.get|getAll`
+
+## Helpers
+
+Use shared helpers from the package root:
+
+- `truncateAddress` / `truncate` (EVM and Solana)
+- `resolveStreamId` (routes to EVM or Solana by chain ID)
+- `isReleasePayable` (EVM-only protocol fee check)
+- `compareVersions`, `isVersionBefore`, `isVersionAfter`
+
+Platform-specific helpers are also exported:
+
+- EVM: `getContractExplorerURL`, `resolveEvmContractByAlias`, `resolveEvmStreamId`, `truncateEvmAddress`
+- Solana: `resolveSolanaProgramByAlias`, `resolveSolanaStreamId`, `truncateSolanaAddress`
+
+## Data exports and assets
+
+- EVM releases: `releases` (e.g., `releases.lockup`, `releases.flow`)
+- Solana releases: `solana.releases`
+- EVM contract catalogs and names: `contracts.catalog`, `contracts.names`
+- Solana program catalogs and names: `solana.programs.catalog`, `solana.programs.names`
+- ABIs: `sablier/abi/*` (copied from `abi/` during build)
+- Solana IDL maps: `sablier/solana/releases/<protocol>/idl`
+- CSV templates: `evm.csv.*` and `solana.csv.*` types; raw CSV files live in `csv/`
+
+## Types
+
+Import SDK types from the `Sablier` namespace:
+
+```ts
+import type { Sablier } from "sablier";
+
+type EvmRelease = Sablier.EVM.Release;
+type SolanaProgram = Sablier.Solana.Program;
+```
+
+## Notes
+
+- `contracts.get` and `programs.get` require `release` when you query by name.
+- Address lookups can be ambiguous across releases; pass `protocol` or `release` to disambiguate.

package/README.md

@@ -9,17 +9,15 @@
 [twitter-badge]: https://img.shields.io/twitter/follow/Sablier
 [twitter]: https://x.com/Sablier
 
-Contract addresses, chain data, and deployment information for [Sablier](https://sablier.com), the token distribution
-protocol for Ethereum and EVM-compatible chains.
+Contract addresses, chain data, and deployment metadata for the Sablier Protocol across EVM and Solana.
 
 This package provides:
 
-- **Contract addresses** across all supported protocols and chains
-- **Release management** for multiple protocol versions
-- **Chain data** with RPC endpoints and explorer URLs
-- **TypeScript SDK** for accessing deployment data programmatically
+- Contract and program addresses with release metadata
+- Chain definitions with RPC and explorer data
+- TypeScript helpers for queries and identifiers
 
-## Installation 📦
+## Installation
 
 ```bash
 bun add sablier
@@ -31,140 +29,23 @@ pnpm add sablier
 yarn add sablier
 ```
 
-## Protocol Overview 🎯
+## Documentation
 
-- **💧 Sablier Airdrops** - Merkle-based airdrop distributions with an optional vesting module
-- **🔒 Sablier Lockup** - Time-locked token vesting with cliffs
-- **🔄 Sablier Flow** - Token streaming with continuous payments
-- **📟 Sablier Legacy** - Old release similar to Lockup, deployed between 2019-2021
+See [DOCS.md](./DOCS.md) for usage, query APIs, helpers, and data layouts.
 
-### Supported Chains
+## Contributing
 
-**Mainnets**: Ethereum, Arbitrum, Optimism, Polygon, Base, BSC, Avalanche, and 20+ more.
+See [CONTRIBUTING.md](./CONTRIBUTING.md).
 
-**Testnets**: Sepolia, Base Sepolia, Optimism Sepolia, and more.
+## Links
 
-### Addresses
+- Docs: https://docs.sablier.com
+- Sablier App: https://app.sablier.com
+- Smart Contracts
+  - Airdrops: https://github.com/sablier-labs/airdrops
+  - Flow: https://github.com/sablier-labs/flow
+  - Lockup: https://github.com/sablier-labs/lockup
 
-The addresses are provided in this package, but you can also view the deployment addresses on the
-[Sablier Docs](https://docs.sablier.com) website:
-
-- [Sablier Airdrops addresses](https://docs.sablier.com/guides/airdrops/deployments)
-- [Sablier Lockup addresses](https://docs.sablier.com/guides/lockup/deployments)
-- [Sablier Flow addresses](https://docs.sablier.com/guides/flow/deployments)
-
-## API Reference - EVM 📖
-
-### Chains
-
-Our chain types extend upon Viem's [Chain](https://viem.sh/docs/chains/introduction).
-
-```typescript
-import { chains, sablier } from "sablier";
-
-// Get by name
-const mainnet = chains.mainnet;
-
-// Get chain by ID
-const arbitrum = sablier.chains.get(42161);
-
-// Get chain by slug
-const polygon = sablier.chains.getBySlug("polygon");
-
-// Check if chain supports Sablier UI
-if (arbitrum?.isSupportedByUI) {
-  console.log("Arbitrum available on app.sablier.com");
-}
-```
-
-### Contracts
-
-```typescript
-import { releases, sablier } from "sablier";
-
-// Get contract by name, release, and chain
-const lockup = sablier.contracts.get({
-  contractName: "SablierLockup",
-  release: releases.lockup["v2.0"],
-  chainId: 1, // Ethereum mainnet
-});
-```
-
-### Releases
-
-```typescript
-import { releases, sablier } from "sablier";
-
-// Get specific releases
-const airdropsV1_3 = releases.airdrops["v1.3"];
-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" });
-```
-
-## API Reference - SOLANA 📖
-
-TODO
-
-## Data Structure 📊
-
-### Release Object
-
-See the [types](./src/types.ts) for more information.
-
-```typescript
-interface Release {
-  protocol: "flow" | "lockup" | "airdrops" | "legacy";
-  version: "v1.0" | "v1.1" | "v2.0" | ...;
-  isLatest: boolean;
-  contractNames: string[];
-  deployments: Deployment[];
-}
-```
-
-### Deployment Broadcasts
-
-The deployment broadcasts (generated with [Foundry](https://book.getfoundry.sh/reference/cheatcodes/broadcast/)) are
-located under the [`deployments`](./deployments) directory.
-
-Each deployment is stored as JSON with a structure like this, which is generated by Foundry:
-
-```jsonc
-{
-  "transactions": [...],      // Deployment transactions
-  "receipts": [...],          // Transaction receipts
-  "libraries": [...],         // Linked libraries
-  "returns": {                // Deployed contract addresses
-    "flow": "0x...",
-    "nftDescriptor": "0x..."
-  },
-  "timestamp": 1738015038,    // Deployment timestamp
-  "chain": 1,                 // Chain ID
-  "commit": "a0fa33d"         // Git commit hash
-}
-```
-
-## Contributing 🤝
-
-We welcome contributions!
-
-- 🐛 [Bug reports](https://github.com/sablier-labs/sdk/issues/new)
-- 💬 [Discussions](https://github.com/sablier-labs/sdk/discussions/new)
-- 💬 [Discord](https://discord.sablier.com)
-
-For guidance on how to make PRs, see the [CONTRIBUTING](./CONTRIBUTING.md) guide.
-
-## Links 📚
-
-- 📖 [Docs](https://docs.sablier.com)
-- ⏳ [Sablier App](https://app.sablier.com)
-- 🛠️ Smart Contracts
-  - [Airdrops](https://github.com/sablier-labs/airdrops)
-  - [Flow](https://github.com/sablier-labs/flow)
-  - [Lockup](https://github.com/sablier-labs/lockup)
-
-## License 📄
+## License
 
 This project is licensed under [GPL-3.0-or-later](./LICENSE.md).