MigrationsMigrate to 2.0
@mysten/walrus
Breaking Changes
- Client required:
WalrusClientcan no longer be created with just an RPC URL. You must pass a Sui client. - Network from client: The
networkparameter has been removed fromwalrus(). The network is now inferred from the client. - Removed deprecated method:
WalrusClient.experimental_asClientExtension()has been removed. Use thewalrus()function instead.
Updated Usage
If you were creating WalrusClient directly:
- import { WalrusClient } from '@mysten/walrus';
+ import { SuiGrpcClient } from '@mysten/sui/grpc'; // or SuiJsonRpcClient, SuiGraphQLClient
+ import { walrus } from '@mysten/walrus';
- const walrusClient = new WalrusClient({
- suiRpcUrl: 'https://fullnode.testnet.sui.io:443',
- network: 'testnet',
- });
+ const client = new SuiGrpcClient({
+ baseUrl: 'https://fullnode.testnet.sui.io:443',
+ network: 'testnet',
+ }).$extend(walrus());
- await walrusClient.getBlob(blobId);
+ await client.walrus.getBlob(blobId);If you were passing network to walrus(), remove it:
- client.$extend(walrus({ network: 'testnet' }));
+ client.$extend(walrus());