@mysten/pas 0.0.1

package/src/contracts/pas/templates.ts

@@ -0,0 +1,101 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+/**
+ * Template stores all the Command templates for PAS.
+ *
+ * This is the lookup point for PTB resolution on the client-side! There's no
+ * versioning enforcement here, as this is purely an off-chain used endpoint.
+ */
+
+import { MoveStruct, normalizeMoveArguments, type RawTransactionArgument } from '../utils/index.js';
+import { bcs } from '@mysten/sui/bcs';
+import { type Transaction } from '@mysten/sui/transactions';
+const $moduleName = '@mysten/pas::templates';
+export const PAS = new MoveStruct({
+	name: `${$moduleName}::PAS`,
+	fields: {
+		dummy_field: bcs.bool(),
+	},
+});
+export const Templates = new MoveStruct({
+	name: `${$moduleName}::Templates`,
+	fields: {
+		id: bcs.Address,
+	},
+});
+export interface SetupArguments {
+	namespace: RawTransactionArgument<string>;
+}
+export interface SetupOptions {
+	package?: string;
+	arguments: SetupArguments | [namespace: RawTransactionArgument<string>];
+}
+/** Create the templates registry */
+export function setup(options: SetupOptions) {
+	const packageAddress = options.package ?? '@mysten/pas';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['namespace'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'templates',
+			function: 'setup',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface SetTemplateCommandArguments {
+	templates: RawTransactionArgument<string>;
+	_: RawTransactionArgument<string>;
+	command: RawTransactionArgument<string>;
+}
+export interface SetTemplateCommandOptions {
+	package?: string;
+	arguments:
+		| SetTemplateCommandArguments
+		| [
+				templates: RawTransactionArgument<string>,
+				_: RawTransactionArgument<string>,
+				command: RawTransactionArgument<string>,
+		  ];
+	typeArguments: [string];
+}
+/** Sets the PTB template for a given Action. */
+export function setTemplateCommand(options: SetTemplateCommandOptions) {
+	const packageAddress = options.package ?? '@mysten/pas';
+	const argumentsTypes = [null, null, null] satisfies (string | null)[];
+	const parameterNames = ['templates', '_', 'command'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'templates',
+			function: 'set_template_command',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+			typeArguments: options.typeArguments,
+		});
+}
+export interface UnsetTemplateCommandArguments {
+	templates: RawTransactionArgument<string>;
+	_: RawTransactionArgument<string>;
+}
+export interface UnsetTemplateCommandOptions {
+	package?: string;
+	arguments:
+		| UnsetTemplateCommandArguments
+		| [templates: RawTransactionArgument<string>, _: RawTransactionArgument<string>];
+	typeArguments: [string];
+}
+export function unsetTemplateCommand(options: UnsetTemplateCommandOptions) {
+	const packageAddress = options.package ?? '@mysten/pas';
+	const argumentsTypes = [null, null] satisfies (string | null)[];
+	const parameterNames = ['templates', '_'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'templates',
+			function: 'unset_template_command',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+			typeArguments: options.typeArguments,
+		});
+}

package/src/contracts/pas/unlock_funds.ts

@@ -0,0 +1,155 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+import { type BcsType, bcs } from '@mysten/sui/bcs';
+import { MoveStruct, normalizeMoveArguments, type RawTransactionArgument } from '../utils/index.js';
+import { type Transaction } from '@mysten/sui/transactions';
+const $moduleName = '@mysten/pas::unlock_funds';
+/**
+ * An unlock funds request that is generated once a Permissioned Funds Transfer is
+ * initiated.
+ *
+ * This can be resolved in two ways:
+ *
+ * 1.  If the asset is `permissioned` (there's a `Policy<T>` for that asset), it
+ *     can only be resolved by the creator by calling
+ *     `policy::resolve_unlock_funds`
+ * 2.  If the asset is not permissioned, it can be resolved by any address by
+ *     calling `unlock_funds::resolve_unrestricted_balance`
+ */
+export function UnlockFunds<T extends BcsType<any>>(...typeParameters: [T]) {
+	return new MoveStruct({
+		name: `${$moduleName}::UnlockFunds<${typeParameters[0].name as T['name']}>`,
+		fields: {
+			/** `owner` is the wallet OR object address, NOT the account address */
+			owner: bcs.Address,
+			/** The ID of the account the funds are coming from */
+			account_id: bcs.Address,
+			/** The actual balance being transferred */
+			funds: typeParameters[0],
+		},
+	});
+}
+export interface OwnerArguments {
+	request: RawTransactionArgument<string>;
+}
+export interface OwnerOptions {
+	package?: string;
+	arguments: OwnerArguments | [request: RawTransactionArgument<string>];
+	typeArguments: [string];
+}
+export function owner(options: OwnerOptions) {
+	const packageAddress = options.package ?? '@mysten/pas';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['request'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'unlock_funds',
+			function: 'owner',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+			typeArguments: options.typeArguments,
+		});
+}
+export interface AccountIdArguments {
+	request: RawTransactionArgument<string>;
+}
+export interface AccountIdOptions {
+	package?: string;
+	arguments: AccountIdArguments | [request: RawTransactionArgument<string>];
+	typeArguments: [string];
+}
+export function accountId(options: AccountIdOptions) {
+	const packageAddress = options.package ?? '@mysten/pas';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['request'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'unlock_funds',
+			function: 'account_id',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+			typeArguments: options.typeArguments,
+		});
+}
+export interface FundsArguments {
+	request: RawTransactionArgument<string>;
+}
+export interface FundsOptions {
+	package?: string;
+	arguments: FundsArguments | [request: RawTransactionArgument<string>];
+	typeArguments: [string];
+}
+export function funds(options: FundsOptions) {
+	const packageAddress = options.package ?? '@mysten/pas';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['request'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'unlock_funds',
+			function: 'funds',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+			typeArguments: options.typeArguments,
+		});
+}
+export interface ResolveUnrestrictedBalanceArguments {
+	request: RawTransactionArgument<string>;
+	namespace: RawTransactionArgument<string>;
+}
+export interface ResolveUnrestrictedBalanceOptions {
+	package?: string;
+	arguments:
+		| ResolveUnrestrictedBalanceArguments
+		| [request: RawTransactionArgument<string>, namespace: RawTransactionArgument<string>];
+	typeArguments: [string];
+}
+/**
+ * This enables unlocking assets that are not managed by a Policy within the
+ * system. If a `Policy<T>` exists, they can only be resolved from within the
+ * system.
+ *
+ * For example, `SUI` will never be a managed asset, so the owner needs to be able
+ * to withdraw if anyone transfers some to their account.
+ */
+export function resolveUnrestrictedBalance(options: ResolveUnrestrictedBalanceOptions) {
+	const packageAddress = options.package ?? '@mysten/pas';
+	const argumentsTypes = [null, null] satisfies (string | null)[];
+	const parameterNames = ['request', 'namespace'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'unlock_funds',
+			function: 'resolve_unrestricted_balance',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+			typeArguments: options.typeArguments,
+		});
+}
+export interface ResolveArguments {
+	request: RawTransactionArgument<string>;
+	policy: RawTransactionArgument<string>;
+}
+export interface ResolveOptions {
+	package?: string;
+	arguments:
+		| ResolveArguments
+		| [request: RawTransactionArgument<string>, policy: RawTransactionArgument<string>];
+	typeArguments: [string];
+}
+/**
+ * Resolve an unlock funds request as long as funds management is enabled and there
+ * are enough valid approvals.
+ */
+export function resolve(options: ResolveOptions) {
+	const packageAddress = options.package ?? '@mysten/pas';
+	const argumentsTypes = [null, null] satisfies (string | null)[];
+	const parameterNames = ['request', 'policy'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'unlock_funds',
+			function: 'resolve',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+			typeArguments: options.typeArguments,
+		});
+}

package/src/contracts/pas/versioning.ts

@@ -0,0 +1,69 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+/**
+ * Versioning module.
+ *
+ * This module is responsible for managing the versioning of the package.
+ *
+ * It allows for blocking specific versions of the package in case of emergency, or
+ * to slowly deprecate an earlier feature.
+ */
+
+import { MoveStruct, normalizeMoveArguments, type RawTransactionArgument } from '../utils/index.js';
+import { bcs } from '@mysten/sui/bcs';
+import { type Transaction } from '@mysten/sui/transactions';
+import * as vec_set from './deps/sui/vec_set.js';
+const $moduleName = '@mysten/pas::versioning';
+export const Versioning = new MoveStruct({
+	name: `${$moduleName}::Versioning`,
+	fields: {
+		blocked_versions: vec_set.VecSet(bcs.u64()),
+	},
+});
+export interface IsValidVersionArguments {
+	versioning: RawTransactionArgument<string>;
+	version: RawTransactionArgument<number | bigint>;
+}
+export interface IsValidVersionOptions {
+	package?: string;
+	arguments:
+		| IsValidVersionArguments
+		| [
+				versioning: RawTransactionArgument<string>,
+				version: RawTransactionArgument<number | bigint>,
+		  ];
+}
+/** Verify that a version is not part of the blocked version list. */
+export function isValidVersion(options: IsValidVersionOptions) {
+	const packageAddress = options.package ?? '@mysten/pas';
+	const argumentsTypes = [null, 'u64'] satisfies (string | null)[];
+	const parameterNames = ['versioning', 'version'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'versioning',
+			function: 'is_valid_version',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface AssertIsValidVersionArguments {
+	versioning: RawTransactionArgument<string>;
+}
+export interface AssertIsValidVersionOptions {
+	package?: string;
+	arguments: AssertIsValidVersionArguments | [versioning: RawTransactionArgument<string>];
+}
+export function assertIsValidVersion(options: AssertIsValidVersionOptions) {
+	const packageAddress = options.package ?? '@mysten/pas';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['versioning'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'versioning',
+			function: 'assert_is_valid_version',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}