@mysten/deepbook-v3 0.28.2 → 1.0.0

package/CHANGELOG.md

@@ -1,5 +1,91 @@
 # @mysten/deepbook-v3
 
+## 1.0.0
+
+### Major Changes
+
+- e00788c: ### Breaking Changes
+
+  **Renamed `env` option to `network`**
+
+  The `env` option has been renamed to `network` throughout the SDK to align with the standard
+  `SuiClientTypes.Network` type used across other packages.
+
+  ```diff
+  const dbClient = new DeepBookClient({
+     address: '0x...',
+  -  env: 'mainnet',
+  +  network: 'mainnet',
+     client: suiClient,
+  });
+  ```
+
+  **Removed `Environment` type export**
+
+  The `Environment` type has been removed. Use `SuiClientTypes.Network` from `@mysten/sui/client`
+  instead:
+
+  ```diff
+  -import { Environment } from '@mysten/deepbook-v3';
+  +import type { SuiClientTypes } from '@mysten/sui/client';
+
+  -const env: Environment = 'mainnet';
+  +const network: SuiClientTypes.Network = 'mainnet';
+  ```
+
+  **Client extension auto-detects network**
+
+  The `deepbook()` client extension function no longer accepts a `network` option. The network is
+  automatically derived from the client:
+
+  ```diff
+  const client = new SuiGrpcClient({ network: 'mainnet', baseUrl: '...' }).$extend(
+     deepbook({
+       address: '0x...',
+  -    env: 'mainnet',  // No longer needed - auto-detected from client
+     }),
+  );
+  ```
+
+  **Network validation**
+
+  The SDK now throws an error if the network is not `'mainnet'` or `'testnet'`, as DeepBook only
+  supports these networks.
+
+### Minor Changes
+
+- e00788c: Update to use SuiJsonRpcClient instead of SuiClient
+
+  Updated all type signatures, internal usages, examples, and documentation to use
+  `SuiJsonRpcClient` from `@mysten/sui/jsonRpc` instead of the deprecated `SuiClient` from
+  `@mysten/sui/client`.
+
+### Patch Changes
+
+- Updated dependencies [e00788c]
+- Updated dependencies [e00788c]
+- Updated dependencies [e00788c]
+- Updated dependencies [e00788c]
+- Updated dependencies [e00788c]
+- Updated dependencies [e00788c]
+- Updated dependencies [e00788c]
+- Updated dependencies [e00788c]
+- Updated dependencies [e00788c]
+- Updated dependencies [e00788c]
+- Updated dependencies [e00788c]
+- Updated dependencies [e00788c]
+- Updated dependencies [e00788c]
+- Updated dependencies [e00788c]
+  - @mysten/sui@2.0.0
+  - @mysten/bcs@2.0.0
+
+## 0.28.3
+
+### Patch Changes
+
+- d381366: Margin manager permissionless withdrawal
+- d25237e: Use balance manager ID for withdrawPermissionless
+
 ## 0.28.2
 
 ### Patch Changes