Update walrus docs and examples (#172)

* Update walrus docs and examples

* ignore mainnet script

Author: hayes-mysten

.changeset/full-facts-rescue.md

@@ -0,0 +1,5 @@
+---
+'@mysten/walrus': patch
+---
+
+update readme

packages/docs/content/walrus/index.mdx

@@ -42,15 +42,6 @@ const walrusClient = new WalrusClient({
 });
 ```
 
-Walrus `testnet` nodes currently use self-signed certificates. Until all nodes are updated to use
-valid certificates, you may need to configure your environment to ignore certificate errors.
-
-In node this can be done though an environment variable:
-
-```ts
-process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
-```
-
 For some environments you may need to customize how data is fetched:
 
 ```ts

packages/walrus/.gitignore

@@ -0,0 +1 @@
+examples/mainnet.ts

packages/walrus/README.md

@@ -40,15 +40,6 @@ const walrusClient = new WalrusClient({
 });
 ```
 
-Walrus `testnet` nodes currently use self-signed certificates. Until all nodes are updated to use
-valid certificates, you may need to configure your environment to ignore certificate errors.
-
-In node this can be done though an environment variable:
-
-```ts
-process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
-```
-
 For some environments you may need to customize how data is fetched:
 
 ```ts

packages/walrus/examples/aggregator/index.ts

@@ -7,9 +7,6 @@ import { Hono } from 'hono';
 
 import { BlobBlockedError, BlobNotCertifiedError, WalrusClient } from '../../src/index.js';
 
-/** @ts-ignore */
-process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
-
 const app = new Hono();
 
 const suiClient = new SuiClient({

packages/walrus/examples/attributes/index.ts renamed to packages/walrus/examples/basics/attributes.ts

@@ -6,9 +6,6 @@ import { getFullnodeUrl, SuiClient } from '@mysten/sui/client';
 import { WalrusClient } from '../../src/client.js';
 import { getFundedKeypair } from '../funded-keypair.js';
 
-/** @ts-ignore */
-process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
-
 const suiClient = new SuiClient({
 	url: getFullnodeUrl('testnet'),
 });

packages/walrus/examples/basics/delete-blob.ts

@@ -0,0 +1,49 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import { getFullnodeUrl, SuiClient } from '@mysten/sui/client';
+import { Agent, setGlobalDispatcher } from 'undici';
+
+import { WalrusClient } from '../../src/client.js';
+import { getFundedKeypair } from '../funded-keypair.js';
+
+// Node connect timeout is 10 seconds, and walrus nodes can be slow to respond
+setGlobalDispatcher(
+	new Agent({
+		connectTimeout: 60_000,
+		connect: { timeout: 60_000 },
+	}),
+);
+
+const suiClient = new SuiClient({
+	url: getFullnodeUrl('testnet'),
+});
+
+const walrusClient = new WalrusClient({
+	network: 'testnet',
+	suiClient,
+	storageNodeClientOptions: {
+		timeout: 60_000,
+	},
+});
+
+async function uploadFile() {
+	const keypair = await getFundedKeypair();
+
+	const file = new TextEncoder().encode('Hello from the TS SDK!!!\n');
+
+	const { blobObject } = await walrusClient.writeBlob({
+		blob: file,
+		deletable: true,
+		epochs: 3,
+		signer: keypair,
+	});
+
+	console.log('created blob', blobObject.id.id);
+
+	await walrusClient.deleteBlob({ blobObjectId: blobObject.id.id });
+
+	console.log('deleted blob', blobObject.id.id);
+}
+
+uploadFile().catch(console.error);

packages/walrus/examples/basics/read-blob.ts

@@ -5,9 +5,6 @@ import { getFullnodeUrl, SuiClient } from '@mysten/sui/client';
 
 import { WalrusClient } from '../../src/client.js';
 
-/** @ts-ignore */
-process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
-
 const suiClient = new SuiClient({
 	url: getFullnodeUrl('testnet'),
 });

packages/walrus/examples/basics/write-blob.ts

@@ -15,9 +15,6 @@ setGlobalDispatcher(
 	}),
 );
 
-/** @ts-ignore */
-process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
-
 const suiClient = new SuiClient({
 	url: getFullnodeUrl('testnet'),
 });
@@ -37,7 +34,7 @@ async function uploadFile() {
 
 	const { blobId } = await walrusClient.writeBlob({
 		blob: file,
-		deletable: true,
+		deletable: false,
 		epochs: 3,
 		signer: keypair,
 	});

packages/walrus/examples/funded-keypair.ts

@@ -32,7 +32,7 @@ export async function getFundedKeypair() {
 
 	const walBalance = await suiClient.getBalance({
 		owner: keypair.toSuiAddress(),
-		coinType: `0x8190b041122eb492bf63cb464476bd68c6b7e570a4079645a8b28732b6197a82::wal::WAL`,
+		coinType: `0x8270feb7375eee355e64fdb69c50abb6b5f9393a722883c1cf45f8e26048810a::wal::WAL`,
 	});
 	console.log('wal balance:', walBalance.totalBalance);
 

packages/walrus/examples/publisher/index.ts

@@ -8,9 +8,6 @@ import { Hono } from 'hono';
 import { WalrusClient } from '../../src/index.js';
 import { getFundedKeypair } from '../funded-keypair.js';
 
-/** @ts-ignore */
-process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
-
 const suiClient = new SuiClient({
 	url: getFullnodeUrl('testnet'),
 });

packages/walrus/examples/write-from-wallet/index.tsx

@@ -51,8 +51,10 @@ export function FileUpload() {
 			throw new Error('Failed to register blob');
 		}
 
+		const blobType = await walrusClient.getBlobType();
+
 		const blobObject = objectChanges?.find(
-			(change) => change.type === 'created' && change.objectType === walrusClient.blobType,
+			(change) => change.type === 'created' && change.objectType === blobType,
 		);
 
 		if (!blobObject || blobObject.type !== 'created') {

packages/walrus/src/client.ts

@@ -158,7 +158,7 @@ export class WalrusClient {
 	});
 
 	/** The Move type for a Blob object */
-	#getBlobType = this.#memo.create('getBlobType', async () => {
+	getBlobType = this.#memo.create('getBlobType', async () => {
 		return `${await this.#getPackageId()}::blob::Blob`;
 	});
 
@@ -700,7 +700,7 @@ export class WalrusClient {
 			...options,
 			owner: options.transaction?.getData().sender ?? signer.toSuiAddress(),
 		});
-		const blobType = await this.#getBlobType();
+		const blobType = await this.getBlobType();
 
 		const { digest, effects } = await this.#executeTransaction(
 			transaction,
@@ -820,7 +820,7 @@ export class WalrusClient {
 			...options,
 			owner: options.owner ?? options.transaction?.getData().sender ?? signer.toSuiAddress(),
 		});
-		const blobType = await this.#getBlobType();
+		const blobType = await this.getBlobType();
 		const { digest, effects } = await this.#executeTransaction(
 			transaction,
 			signer,