fix some todos

Author: hayes-mysten

packages/enoki/README.md

@@ -1 +1,76 @@
 # `@mysten/enoki`
+
+zkLogin authentication and sponsored transactions. Enable users to sign in with Google, Twitch, Facebook, and other OAuth providers, and execute transactions without gas fees.
+
+## Features
+
+- **zkLogin**: Authenticate users with OAuth providers (Google, Twitch, Facebook)
+- **Sponsored Transactions**: Execute transactions without requiring users to hold gas
+- **Wallet Integration**: Register Enoki wallets with dApp Kit
+- **Subname Management**: Create and manage SuiNS subnames
+
+## Installation
+
+```sh
+npm install @mysten/enoki
+```
+
+## Quick Start
+
+### Register Enoki wallets
+
+```ts
+import { registerEnokiWallets } from '@mysten/enoki';
+
+registerEnokiWallets({
+  apiKey: 'your-enoki-api-key',
+  providers: ['google', 'twitch', 'facebook'],
+});
+```
+
+### Use with React and dApp Kit
+
+```tsx
+import { registerEnokiWallets } from '@mysten/enoki';
+import { useEnokiFlow } from '@mysten/enoki/react';
+
+// In your app setup
+registerEnokiWallets({
+  apiKey: 'your-enoki-api-key',
+  providers: ['google'],
+});
+
+// In your component
+function LoginButton() {
+  const { login } = useEnokiFlow();
+
+  return <button onClick={() => login('google')}>Sign in with Google</button>;
+}
+```
+
+### Low-level client usage
+
+```ts
+import { EnokiClient } from '@mysten/enoki';
+
+const client = new EnokiClient({
+  apiKey: 'your-enoki-api-key',
+});
+
+// Create a sponsored transaction
+const sponsored = await client.createSponsoredTransaction({
+  network: 'mainnet',
+  sender: '0x...',
+  transactionKindBytes: '...',
+});
+
+// Execute it
+await client.executeSponsoredTransaction({
+  digest: sponsored.digest,
+  signature: '...',
+});
+```
+
+## Documentation
+
+See the [Enoki documentation](https://docs.enoki.mystenlabs.com) for detailed setup and usage.

packages/enoki/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@mysten/enoki",
 	"version": "0.13.0",
-	"description": "TODO: Description",
+	"description": "zkLogin authentication and sponsored transactions",
 	"license": "Apache-2.0",
 	"author": "Mysten Labs <[email protected]>",
 	"type": "module",

packages/walrus/src/utils/index.ts

@@ -22,7 +22,6 @@ export const MAX_SYMBOL_SIZE_BY_ENCODING_TYPE = {
 	RedStuff: 2 ** 16 - 1,
 };
 
-// TODO: this name is kinda bad
 export function encodedBlobLength(
 	unencodedLength: number,
 	nShards: number,

packages/zksend/README.md

@@ -1 +1,224 @@
 # `@mysten/zksend`
+
+Create claimable links for transferring coins and NFTs. Recipients can claim assets via URL without needing a wallet set up beforehand.
+
+## Installation
+
+```sh
+npm install @mysten/zksend
+```
+
+## Limitations
+
+- zkSend only supports Mainnet and Testnet at this time.
+- Objects within links must be publicly transferrable.
+
+## Create a link
+
+You can start creating your own zkSend link using the `ZkSendLinkBuilder` class. This class
+constructor takes an object with the following options:
+
+- **`sender`** (required) - The address of the sender / creator of the link.
+- **`client`** (optional) - The `@mysten/sui` client used to fetch data to construct the link. If not provided, a default client will be used.
+- **`network`** (optional) - The network that the link will be created for. Defaults to `mainnet`.
+
+```ts
+import { ZkSendLinkBuilder } from '@mysten/zksend';
+
+const link = new ZkSendLinkBuilder({
+	sender: '0x...',
+});
+```
+
+### Adding SUI to the link
+
+You can add SUI to the link by calling `link.addClaimableMist()`. This method takes the following params:
+
+- **`amount`** (required) - The amount of MIST (the base unit of SUI) to add to the link.
+
+### Adding non-SUI coins to the link
+
+You can add non-SUI coins to the link by calling `link.addClaimableBalance()`. This method takes the following params:
+
+- **`coinType`** (required) - The coin type of the coin to add to the link (e.g. `0x2::sui::SUI`).
+- **`amount`** (required) - The amount of the coin to add to the link. Represented in the base unit of the coin.
+
+The SDK will automatically perform the necessary coin management logic to transfer the defined amount, such as merging and splitting coin objects.
+
+### Adding objects to the link
+
+You can add a publicly-transferrable object to the link by calling `link.addClaimableObject()`. This method takes the following params:
+
+- **`id`** (required) - The ID of the object. This must be owned by the `sender` you configured when creating the link.
+
+### Adding objects created in the same transaction
+
+You can create objects to add to links in the same transaction the link is created in by using `link.addClaimableObjectRef()`:
+
+- **`ref`** (required) - The reference to the object you want to add to the link.
+- **`type`** (required) - The move type of the object you are adding
+
+```ts
+const tx = new Transaction();
+
+const link = new ZkSendLinkBuilder({
+	sender: '0x...',
+});
+
+const newObject = tx.moveCall({
+	target: `${PACKAGE_ID}::your_module::mint`,
+});
+
+link.addClaimableObjectRef({
+	ref: newObject,
+	type: `${PACKAGE_ID}::your_module::YourType`,
+});
+
+// Adds the link creation transactions to the transaction
+link.createSendTransaction({
+	transaction: tx,
+});
+```
+
+### Getting the link URL
+
+At any time, you can get the URL for the link by calling `link.getLink()`.
+
+## Submitting the link transaction
+
+Once you have built your zkSend link, you need to execute a transaction to transfer assets and make the link claimable.
+
+You can call the `link.createSendTransaction()` method, which returns a `Transaction` object that you can sign and submit.
+
+```ts
+const tx = await link.createSendTransaction();
+
+const { bytes, signature } = tx.sign({ client, signer: keypair });
+
+const result = await client.executeTransactionBlock({
+	transactionBlock: bytes,
+	signature,
+});
+```
+
+If you have a keypair you would like to send the transaction with, you can use the `create` method as shorthand for creating the send transaction, signing it, and submitting it:
+
+```ts
+await link.create({
+	signer: yourKeypair,
+	// Wait until the new link is ready to be indexed so it is claimable
+	waitForTransaction: true,
+});
+```
+
+## Claiming a link
+
+To claim a link via the SDK you can use the `ZkSendLink` class:
+
+```ts
+import { ZkSendLink } from '@mysten/zksend';
+
+// create a link instance from a URL
+const link = await ZkSendLink.fromUrl('https://zksend.com/claim#$abc...');
+
+// list what claimable assets the link has
+const { nfts, balances } = link.assets;
+
+// claim all the assets from the link
+await link.claimAssets(addressOfClaimer);
+```
+
+## Listing links you have created
+
+To list the links created by a specific address, you can use the `listCreatedLinks` function:
+
+```ts
+import { listCreatedLinks } from '@mysten/zksend';
+
+const { links, hasNextPage, cursor } = await listCreatedLinks({
+	address: addressOfCreator,
+});
+
+// get the claimable assets for this link (will be empty if the link has been claimed)
+const { nfts, balances } = await links[0].assets;
+```
+
+## Listing transactions and the links they created
+
+`getSentTransactionsWithLinks` will return a list of transactions sent by the provided address. Each result will include the transaction that was sent, along with an array containing any links that were created or regenerated by that transaction.
+
+```ts
+import { getSentTransactionsWithLinks } from '@mysten/zksend';
+
+const { data, hasNextPage, nextCursor } = await getSentTransactionsWithLinks({
+	address: addressOfCreator,
+});
+
+for (const { transaction, links } of data) {
+	// get the claimable assets for this link (will be empty if the link has been claimed)
+	const firstLink = links[0];
+
+	// link is claimed
+	firstLink.claimed;
+	const { nfts, balances } = firstLink.assets;
+
+	// claim link
+	await firstLink.link.claimAssets(addressOfClaimer);
+}
+```
+
+By default `getSentTransactionsWithLinks` will not load the assets for claimed links. This can be changed by passing `loadClaimedAssets: true` to the function.
+
+## Regenerating links
+
+If you lose a link you've created, you can re-generate the link (this can only done from the address that originally created the link):
+
+```ts
+import { listCreatedLinks } from '@mysten/zksend';
+
+const { links, hasNextPage, cursor } = await listCreatedLinks({
+	address: addressOfCreator,
+});
+
+// url will be the new link url
+const { url, transaction } = await links[0].link.createRegenerateTransaction(addressOfLinkCreator);
+
+// Execute the transaction to regenerate the link
+const result = await client.signAndExecuteTransaction({
+	transaction,
+	signer: keypair,
+});
+```
+
+## Bulk link creation
+
+To create multiple links in a single transaction, you can use `ZkSendLinkBuilder.createLinks`:
+
+```ts
+const links = [];
+
+for (let i = 0; i < 10; i++) {
+	const link = new ZkSendLinkBuilder({
+		client,
+		sender: keypair.toSuiAddress(),
+	});
+
+	link.addClaimableMist(100n);
+	links.push(link);
+}
+
+const urls = links.map((link) => link.getLink());
+
+const tx = await ZkSendLinkBuilder.createLinks({
+	links,
+});
+
+const result = await client.signAndExecuteTransaction({
+	transaction: tx,
+	signer: keypair,
+});
+```
+
+## Documentation
+
+See the [zkSend SDK documentation](https://sdk.mystenlabs.com/zksend) for more details.

packages/zksend/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@mysten/zksend",
 	"version": "0.14.12",
-	"description": "TODO: Write Description",
+	"description": "Create claimable links for transferring coins and NFTs",
 	"license": "Apache-2.0",
 	"author": "Mysten Labs <[email protected]>",
 	"type": "module",