@mysten/sui/src/transactions/object.ts

Sui TypeScript API

// Copyright (c) Mysten Labs, Inc.
// SPDX-License-Identifier: Apache-2.0

import type { Transaction, TransactionObjectInput } from './Transaction.js';
import { Inputs } from './Inputs.js';
import {
	MOVE_STDLIB_ADDRESS,
	SUI_CLOCK_OBJECT_ID,
	SUI_DENY_LIST_OBJECT_ID,
	SUI_RANDOM_OBJECT_ID,
	SUI_SYSTEM_STATE_OBJECT_ID,
} from '../utils/index.js';

export function createObjectMethods<T>(makeObject: (value: TransactionObjectInput) => T) {
	function object(value: TransactionObjectInput) {
		return makeObject(value);
	}

	object.system = (options?: { mutable?: boolean }) => {
		const mutable = options?.mutable;

		if (mutable !== undefined) {
			return object(
				Inputs.SharedObjectRef({
					objectId: SUI_SYSTEM_STATE_OBJECT_ID,
					initialSharedVersion: 1,
					mutable,
				}),
			);
		}

		return object({
			$kind: 'UnresolvedObject',
			UnresolvedObject: {
				objectId: SUI_SYSTEM_STATE_OBJECT_ID,
				initialSharedVersion: 1,
			},
		});
	};
	object.clock = () =>
		object(
			Inputs.SharedObjectRef({
				objectId: SUI_CLOCK_OBJECT_ID,
				initialSharedVersion: 1,
				mutable: false,
			}),
		);
	object.random = () =>
		object({
			$kind: 'UnresolvedObject',
			UnresolvedObject: {
				objectId: SUI_RANDOM_OBJECT_ID,
				mutable: false,
			},
		});
	object.denyList = (options?: { mutable?: boolean }) => {
		return object({
			$kind: 'UnresolvedObject',
			UnresolvedObject: {
				objectId: SUI_DENY_LIST_OBJECT_ID,
				mutable: options?.mutable,
			},
		});
	};
	object.option =
		({ type, value }: { type: string; value: TransactionObjectInput | null }) =>
		(tx: Transaction) =>
			tx.moveCall({
				typeArguments: [type],
				target: `${MOVE_STDLIB_ADDRESS}::option::${value === null ? 'none' : 'some'}`,
				arguments: value === null ? [] : [tx.object(value)],
			});

	return object;
}