@mysten/sui 2.15.0 → 2.16.1

package/docs/zklogin.md

@@ -1,78 +0,0 @@
-# ZkLogin
-
-> Zero-knowledge authentication with OAuth providers on Sui
-
-Utilities for working with zkLogin. Currently contains functionality to create and parse zkLogin
-signatures and compute zkLogin addresses.
-
-To parse a serialized zkLogin signature
-
-```typescript
-const parsedSignature = await parseZkLoginSignature('BQNNMTY4NjAxMzAyO....');
-```
-
-Use `getZkLoginSignature` to serialize a zkLogin signature.
-
-```typescript
-const serializedSignature = await getZkLoginSignature({ inputs, maxEpoch, userSignature });
-```
-
-To compute the address for a given address seed and iss you can use `computeZkLoginAddressFromSeed`
-
-```typescript
-const address = computeZkLoginAddressFromSeed(0n, 'https://accounts.google.com');
-```
-
-To compute an address from jwt:
-
-```typescript
-const address = jwtToAddress(jwtAsString, salt);
-```
-
-To compute an address from a parsed jwt:
-
-```typescript
-const address = computeZkLoginAddress({
-	claimName,
-	claimValue,
-	iss,
-	aud,
-	userSalt: BigInt(salt),
-});
-```
-
-To use zkLogin inside a multisig, see the [Multisig Guide](../sui/cryptography/multisig) for more
-details.
-
-## Legacy addresses
-
-When zklogin was first introduced, there was an inconsistency in how the address seed was computed.
-For backwards compatibility reasons there are 2 valid addresses for a given set of inputs. Methods
-that produce zklogin addresses all accept a `legacyAddress` boolean flag, either as their last
-parameter, or in their options argument.
-
-```typescript
-
-	computeZkLoginAddress,
-	computeZkLoginAddressFromSeed,
-	jwtToAddress,
-	toZkLoginPublicIdentifier,
-	genAddressSeed,
-} from '@mysten/sui/zklogin';
-
-const address = jwtToAddress(jwtAsString, salt, true);
-const address = computeZkLoginAddressFromSeed(0n, 'https://accounts.google.com', true);
-const address = computeZkLoginAddress({
-	claimName,
-	claimValue,
-	iss,
-	aud,
-	userSalt: BigInt(salt),
-	legacyAddress: true,
-});
-const address = toZkLoginPublicIdentifier(
-	genAddressSeed(userSalt, claimName, claimValue, aud),
-	iss,
-	{ legacyAddress: true },
-).toSuiAddress();
-```

package/src/transactions/__tests__/Transaction.test.ts

@@ -1,184 +0,0 @@
-// Copyright (c) Mysten Labs, Inc.
-// SPDX-License-Identifier: Apache-2.0
-
-import { toBase58 } from '@mysten/bcs';
-import { describe, expect, it } from 'vitest';
-
-import { bcs } from '../../bcs/index.js';
-import { TransactionCommands, Transaction } from '../index.js';
-import { Inputs } from '../Inputs.js';
-
-it('can construct and serialize an empty tranaction', () => {
-	const tx = new Transaction();
-	expect(() => tx.serialize()).not.toThrow();
-});
-
-it('can construct a receiving transaction argument', () => {
-	const tx = new Transaction();
-	tx.object(Inputs.ReceivingRef(ref()));
-	expect(() => tx.serialize()).not.toThrow();
-});
-
-it('receiving transaction argument different from object argument', () => {
-	const oref = ref();
-	const rtx = new Transaction();
-	rtx.object(Inputs.ReceivingRef(oref));
-	const otx = new Transaction();
-	otx.object(Inputs.ObjectRef(oref));
-	expect(() => rtx.serialize()).not.toThrow();
-	expect(() => otx.serialize()).not.toThrow();
-	expect(otx.serialize()).not.toEqual(rtx.serialize());
-});
-
-it('can be serialized and deserialized to the same values', () => {
-	const tx = new Transaction();
-	tx.add(TransactionCommands.SplitCoins(tx.gas, [tx.pure.u64(100)]));
-	const serialized = tx.serialize();
-	const tx2 = Transaction.from(serialized);
-	expect(serialized).toEqual(tx2.serialize());
-});
-
-it('allows transfer with the result of split Commands', () => {
-	const tx = new Transaction();
-	const coin = tx.add(TransactionCommands.SplitCoins(tx.gas, [tx.pure.u64(100)]));
-	tx.add(TransactionCommands.TransferObjects([coin], tx.object('0x2')));
-});
-
-it('supports nested results through either array index or destructuring', () => {
-	const tx = new Transaction();
-	const registerResult = tx.add(
-		TransactionCommands.MoveCall({
-			target: '0x2::game::register',
-		}),
-	);
-
-	const [nft, account] = registerResult;
-
-	// NOTE: This might seem silly but destructuring works differently than property access.
-	expect(nft).toBe(registerResult[0]);
-	expect(account).toBe(registerResult[1]);
-});
-
-describe('offline build', () => {
-	it('builds an empty transaction offline when provided sufficient data', async () => {
-		const tx = setup();
-		await tx.build();
-	});
-
-	it('supports epoch expiration', async () => {
-		const tx = setup();
-		tx.setExpiration({ Epoch: 1 });
-		await tx.build();
-	});
-
-	it('builds a split transaction', async () => {
-		const tx = setup();
-		tx.add(TransactionCommands.SplitCoins(tx.gas, [tx.pure.u64(100)]));
-		await tx.build();
-	});
-
-	it('breaks reference equality', () => {
-		const tx = setup();
-		const tx2 = Transaction.from(tx);
-
-		tx.setGasBudget(999);
-
-		// Ensure that setting budget after a clone does not affect the original:
-		expect(tx2.getData()).not.toEqual(tx.getData());
-
-		// Ensure `getData()` always breaks reference equality:
-		expect(tx.getData()).not.toBe(tx.getData());
-		expect(tx.getData().gasData).not.toBe(tx.getData().gasData);
-		expect(tx.getData().commands).not.toBe(tx.getData().commands);
-		expect(tx.getData().inputs).not.toBe(tx.getData().inputs);
-	});
-
-	it('can determine the type of inputs for built-in Commands', async () => {
-		const tx = setup();
-		tx.splitCoins(tx.gas, [100]);
-		await tx.build();
-	});
-
-	it('supports pre-serialized inputs as Uint8Array', async () => {
-		const tx = setup();
-		const inputBytes = bcs.U64.serialize(100n).toBytes();
-		// Use bytes directly in pure value:
-		tx.add(TransactionCommands.SplitCoins(tx.gas, [tx.pure(inputBytes)]));
-		await tx.build();
-	});
-
-	it('builds a more complex interaction', async () => {
-		const tx = setup();
-		const coin = tx.splitCoins(tx.gas, [100]);
-		tx.add(TransactionCommands.MergeCoins(tx.gas, [coin, tx.object(Inputs.ObjectRef(ref()))]));
-		tx.add(
-			TransactionCommands.MoveCall({
-				target: '0x2::devnet_nft::mint',
-				typeArguments: [],
-				arguments: [tx.pure.string('foo'), tx.pure.string('bar'), tx.pure.string('baz')],
-			}),
-		);
-		await tx.build();
-	});
-
-	it('uses a receiving argument', async () => {
-		const tx = setup();
-		tx.object(Inputs.ObjectRef(ref()));
-		const coin = tx.splitCoins(tx.gas, [100]);
-		tx.add(TransactionCommands.MergeCoins(tx.gas, [coin, tx.object(Inputs.ObjectRef(ref()))]));
-		tx.add(
-			TransactionCommands.MoveCall({
-				target: '0x2::devnet_nft::mint',
-				typeArguments: [],
-				arguments: [tx.object(Inputs.ObjectRef(ref())), tx.object(Inputs.ReceivingRef(ref()))],
-			}),
-		);
-
-		const bytes = await tx.build();
-		const tx2 = Transaction.from(bytes);
-		const bytes2 = await tx2.build();
-
-		expect(bytes).toEqual(bytes2);
-	});
-
-	it('builds a more complex interaction', async () => {
-		const tx = setup();
-		const coin = tx.splitCoins(tx.gas, [100]);
-		tx.add(TransactionCommands.MergeCoins(tx.gas, [coin, tx.object(Inputs.ObjectRef(ref()))]));
-		tx.add(
-			TransactionCommands.MoveCall({
-				target: '0x2::devnet_nft::mint',
-				typeArguments: [],
-				arguments: [tx.pure.string('foo'), tx.pure.string('bar'), tx.pure.string('baz')],
-			}),
-		);
-
-		const bytes = await tx.build();
-		const tx2 = Transaction.from(bytes);
-		const bytes2 = await tx2.build();
-
-		expect(bytes).toEqual(bytes2);
-	});
-});
-
-function ref(): { objectId: string; version: string; digest: string } {
-	return {
-		objectId: (Math.random() * 100000).toFixed(0).padEnd(64, '0'),
-		version: String((Math.random() * 10000).toFixed(0)),
-		digest: toBase58(
-			new Uint8Array([
-				0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 1,
-				2,
-			]),
-		),
-	};
-}
-
-function setup() {
-	const tx = new Transaction();
-	tx.setSender('0x2');
-	tx.setGasPrice(5);
-	tx.setGasBudget(100);
-	tx.setGasPayment([ref()]);
-	return tx;
-}

package/src/transactions/__tests__/bcs.test.ts

@@ -1,205 +0,0 @@
-// Copyright (c) Mysten Labs, Inc.
-// SPDX-License-Identifier: Apache-2.0
-
-import { toBase58 } from '@mysten/bcs';
-import { expect, it } from 'vitest';
-
-import { bcs } from '../../bcs/index.js';
-import { normalizeStructTag, normalizeSuiAddress } from '../../utils/sui-types.js';
-
-// Oooh-weeee we nailed it!
-it('can serialize simplified programmable call struct', () => {
-	const moveCall = {
-		package: '0x2',
-		module: 'display',
-		function: 'new',
-		typeArguments: [normalizeStructTag('0x6::capy::Capy')],
-		arguments: [
-			{
-				$kind: 'GasCoin',
-				GasCoin: true,
-			},
-			{
-				$kind: 'NestedResult',
-				NestedResult: [0, 1],
-			},
-			{
-				$kind: 'Input',
-				Input: 3,
-			},
-			{
-				$kind: 'Result',
-				Result: 1,
-			},
-		],
-	} satisfies typeof bcs.ProgrammableMoveCall.$inferType;
-
-	const bytes = bcs.ProgrammableMoveCall.serialize(moveCall).toBytes();
-	const result = bcs.ProgrammableMoveCall.parse(bytes);
-
-	// since we normalize addresses when (de)serializing, the returned value differs
-	// only check the module and the function; ignore address comparison (it's not an issue
-	// with non-0x2 addresses).
-	expect(result.arguments).toEqual(moveCall.arguments);
-	expect(result.function).toEqual(moveCall.function);
-	expect(result.module).toEqual(moveCall.module);
-	expect(normalizeSuiAddress(result.package)).toEqual(normalizeSuiAddress(moveCall.package));
-	expect(result.typeArguments[0]).toEqual(moveCall.typeArguments[0]);
-});
-
-function ref(): { objectId: string; version: string; digest: string } {
-	return {
-		objectId: normalizeSuiAddress((Math.random() * 100000).toFixed(0).padEnd(64, '0')),
-		version: String((Math.random() * 10000).toFixed(0)),
-		digest: toBase58(
-			new Uint8Array([
-				0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 1,
-				2,
-			]),
-		),
-	};
-}
-
-it('can serialize transaction data with a programmable transaction', () => {
-	const sui = normalizeSuiAddress('0x2');
-	const txData = {
-		$kind: 'V1',
-		V1: {
-			sender: normalizeSuiAddress('0xBAD'),
-			expiration: { $kind: 'None', None: true },
-			gasData: {
-				payment: [ref()],
-				owner: sui,
-				price: '1',
-				budget: '1000000',
-			},
-			kind: {
-				$kind: 'ProgrammableTransaction',
-				ProgrammableTransaction: {
-					inputs: [
-						// first argument is the publisher object
-						{
-							$kind: 'Object',
-							Object: {
-								$kind: 'ImmOrOwnedObject',
-								ImmOrOwnedObject: ref(),
-							},
-						},
-						// second argument is a vector of names
-						{
-							$kind: 'Pure',
-							Pure: {
-								bytes: bcs
-									.vector(bcs.String)
-									.serialize(['name', 'description', 'img_url'])
-									.toBase64(),
-							},
-						},
-						// third argument is a vector of values
-						{
-							$kind: 'Pure',
-							Pure: {
-								bytes: bcs
-									.vector(bcs.String)
-									.serialize([
-										'Capy {name}',
-										'A cute little creature',
-										'https://api.capy.art/{id}/svg',
-									])
-									.toBase64(),
-							},
-						},
-						// 4th and last argument is the account address to send display to
-						{
-							$kind: 'Pure',
-							Pure: {
-								bytes: bcs.Address.serialize(ref().objectId).toBase64(),
-							},
-						},
-					],
-					commands: [
-						{
-							$kind: 'MoveCall',
-							MoveCall: {
-								package: sui,
-								module: 'display',
-								function: 'new',
-								typeArguments: [`${sui}::capy::Capy`],
-								arguments: [
-									// publisher object
-									{
-										$kind: 'Input',
-										Input: 0,
-									},
-								],
-							},
-						},
-						{
-							$kind: 'MoveCall',
-							MoveCall: {
-								package: sui,
-								module: 'display',
-								function: 'add_multiple',
-								typeArguments: [`${sui}::capy::Capy`],
-								arguments: [
-									// result of the first transaction
-									{
-										$kind: 'Result',
-										Result: 0,
-									},
-									// second argument - vector of names
-									{
-										$kind: 'Input',
-										Input: 1,
-									},
-									// third argument - vector of values
-									{
-										$kind: 'Input',
-										Input: 2,
-									},
-								],
-							},
-						},
-						{
-							$kind: 'MoveCall',
-							MoveCall: {
-								package: sui,
-								module: 'display',
-								function: 'update_version',
-								typeArguments: [`${sui}::capy::Capy`],
-								arguments: [
-									// result of the first transaction again
-									{
-										$kind: 'Result',
-										Result: 0,
-									},
-								],
-							},
-						},
-						{
-							$kind: 'TransferObjects',
-							TransferObjects: {
-								objects: [
-									// the display object
-									{
-										$kind: 'Result',
-										Result: 0,
-									},
-								],
-								// address is also an input
-								address: {
-									$kind: 'Input',
-									Input: 3,
-								},
-							},
-						},
-					],
-				},
-			},
-		},
-	} satisfies typeof bcs.TransactionData.$inferType;
-
-	const bytes = bcs.TransactionData.serialize(txData).toBytes();
-	const result = bcs.TransactionData.parse(bytes);
-	expect(result).toMatchObject(txData);
-});