@mysten/pas 0.0.1

package/dist/resolution.mjs

@@ -0,0 +1,185 @@
+import { PASClientError } from "./error.mjs";
+import { TypeName } from "./contracts/pas/deps/std/type_name.mjs";
+import { Policy } from "./contracts/pas/policy.mjs";
+import { Command, MoveCall } from "./contracts/ptb/ptb.mjs";
+import { Field } from "./contracts/sui/dynamic_field.mjs";
+import { normalizeStructTag } from "@mysten/sui/utils";
+import { Inputs, TransactionCommands } from "@mysten/sui/transactions";
+
+//#region src/resolution.ts
+const OBJECT_BY_ID_EXT = "object_by_id";
+const OBJECT_BY_TYPE_EXT = "object_by_type";
+const RECEIVING_BY_ID_EXT = "receiving_by_id";
+/**
+* Extracts all object IDs referenced by template commands, regardless of
+* how they are specified (fully resolved refs, shared refs, or ext lookups).
+*/
+function collectTemplateObjectIds(commands) {
+	const ids = /* @__PURE__ */ new Set();
+	for (const cmd of commands) for (const arg of cmd.arguments) {
+		const obj = arg.Input?.Object;
+		if (!obj) continue;
+		switch (obj.$kind) {
+			case "ImmOrOwnedObject":
+				ids.add(obj.ImmOrOwnedObject.object_id);
+				break;
+			case "SharedObject":
+				ids.add(obj.SharedObject.object_id);
+				break;
+			case "Receiving":
+				ids.add(obj.Receiving.object_id);
+				break;
+			case "Ext": {
+				const [kind, value] = obj.Ext.split(":");
+				switch (kind) {
+					case OBJECT_BY_ID_EXT:
+					case RECEIVING_BY_ID_EXT:
+						ids.add(value);
+						break;
+					default: throw new PASClientError(`Unsupported external object kind: ${kind}`);
+				}
+				break;
+			}
+			default: throw new PASClientError("Invariant violation: unhandled variant in `collectTemplateObjectIds`");
+		}
+	}
+	return ids;
+}
+/**
+* Parses the Policy object to extract the required approval type names for a given action.
+*
+* The Policy's `required_approvals` is a `VecMap<String, VecSet<TypeName>>` where:
+* - Key is the action name (e.g., "send_funds")
+* - Value is a set of approval TypeNames that must be satisfied
+*
+* @param policyObject - The Policy object fetched with content
+* @returns The list of approval TypeName strings for the given action, or undefined if not found
+*/
+function getRequiredApprovals(policyObject, actionType) {
+	const entry = Policy.parse(policyObject.content).required_approvals.contents.find((e) => e.key === actionType);
+	if (!entry) return void 0;
+	return entry.value.contents.map((tn) => tn.name);
+}
+/**
+* Parses a Command from a Template dynamic field object.
+*
+* Each Template DF is a `Field<TypeName, Command>` where:
+* - TypeName is the approval type (e.g., the `with_defining_ids` of `TransferApproval`)
+* - Command is the move call instruction to execute for that approval
+*
+* @param templateDF - The Template DF object fetched with content
+* @returns The parsed Command, or undefined if parsing fails
+*/
+function getCommandFromTemplate(template) {
+	return parseCommand(Field(TypeName, Command).parse(template.content).value);
+}
+function parseCommand([key, cmd]) {
+	if (key !== 0) throw new PASClientError(`Unknown command type: ${key}`);
+	return MoveCall.parse(new Uint8Array(cmd));
+}
+/**
+* Builds a `Command` (TransactionCommands.MoveCall) from a parsed template command,
+* suitable for use with `transactionData.replaceCommand()`.
+*
+* Resolves template argument placeholders (pas:request, pas:policy, etc.) into
+* concrete Argument references, and converts object/pure inputs via the provided
+* `addInput` callback.
+*
+* @param command - The parsed MoveCall from a template object
+* @param args - The resolved arguments and addInput helper
+* @param commandOffset - Absolute PTB index where the first template command will
+*   land. Raw `Result` and `NestedResult` values from the on-chain BCS are
+*   template-relative (i.e. `Result(0)` means "first command in this template").
+*   We rebase them by adding this offset so they point at the correct position
+*   in the final transaction.
+* @returns A Command object ready for `replaceCommand`
+*/
+function buildMoveCallCommandFromTemplate(command, args, commandOffset) {
+	const resolvedArgs = [];
+	for (const arg of command.arguments) if (arg.Ext) throw new PASClientError(`There are no supported ext arguments in this client.`);
+	else if (arg.GasCoin) throw new PASClientError(`Gas coin is not supported in PAS client.`);
+	else if (arg.NestedResult != null) resolvedArgs.push({
+		$kind: "NestedResult",
+		NestedResult: [arg.NestedResult[0] + commandOffset, arg.NestedResult[1]]
+	});
+	else if (arg.Result != null) resolvedArgs.push({
+		$kind: "Result",
+		Result: arg.Result + commandOffset
+	});
+	else if (arg.Input) if (arg.Input.Pure) resolvedArgs.push(args.addInput("pure", Inputs.Pure(new Uint8Array(arg.Input.Pure))));
+	else if (arg.Input.Object) switch (arg.Input.Object.$kind) {
+		case "ImmOrOwnedObject":
+			resolvedArgs.push(args.addInput("object", Inputs.ObjectRef({
+				objectId: arg.Input.Object.ImmOrOwnedObject.object_id,
+				version: arg.Input.Object.ImmOrOwnedObject.sequence_number,
+				digest: arg.Input.Object.ImmOrOwnedObject.digest
+			})));
+			break;
+		case "SharedObject":
+			resolvedArgs.push(args.addInput("object", Inputs.SharedObjectRef({
+				objectId: arg.Input.Object.SharedObject.object_id,
+				initialSharedVersion: arg.Input.Object.SharedObject.initial_shared_version,
+				mutable: arg.Input.Object.SharedObject.is_mutable
+			})));
+			break;
+		case "Receiving":
+			resolvedArgs.push(args.addInput("object", Inputs.ReceivingRef({
+				objectId: arg.Input.Object.Receiving.object_id,
+				version: arg.Input.Object.Receiving.sequence_number,
+				digest: arg.Input.Object.Receiving.digest
+			})));
+			break;
+		case "Ext":
+			const [kind, value] = arg.Input.Object.Ext.split(":");
+			switch (kind) {
+				case OBJECT_BY_ID_EXT:
+				case RECEIVING_BY_ID_EXT:
+					resolvedArgs.push(args.addInput("object", {
+						$kind: "UnresolvedObject",
+						UnresolvedObject: { objectId: value }
+					}));
+					break;
+				case OBJECT_BY_TYPE_EXT: throw new PASClientError(`There are no supported object by type arguments in this client.`);
+				default: throw new PASClientError(`Unknown external object argument: ${kind}`);
+			}
+			break;
+		default: throw new PASClientError(`Not supported object argument: ${JSON.stringify(arg.Input.Object)}`);
+	}
+	else if (arg.Input.Ext) resolvedArgs.push(resolveRawPasRequest(args, {
+		namespace: arg.Input.Ext[0],
+		value: arg.Input.Ext[1]
+	}));
+	else throw new PASClientError(`Unsupported input kind: ${arg.Input.$kind}`);
+	const typeArgs = [];
+	for (const typeArg of command.type_arguments) typeArgs.push(normalizeStructTag(typeArg).toString());
+	if (!command.module_name || !command.function) throw new PASClientError("Module name or function name is missing from the on-chain policy. This means that the issuer has not set up the policy correctly.");
+	return TransactionCommands.MoveCall({
+		package: command.package_id,
+		module: command.module_name,
+		function: command.function,
+		arguments: resolvedArgs,
+		typeArguments: typeArgs.length > 0 ? typeArgs : []
+	});
+}
+function resolveRawPasRequest(args, extInput) {
+	if (!extInput.namespace.endsWith("templates::PAS")) throw new PASClientError(`Unsupported namespace: ${extInput.namespace}`);
+	switch (extInput.value) {
+		case "request":
+			if (!args.request) throw new PASClientError(`Request is not set in the context.`);
+			return args.request;
+		case "policy":
+			if (!args.policy) throw new PASClientError(`Policy is not set in the context.`);
+			return args.policy;
+		case "sender_account":
+			if (!args.senderAccount) throw new PASClientError(`Sender account is not set in the context.`);
+			return args.senderAccount;
+		case "receiver_account":
+			if (!args.receiverAccount) throw new PASClientError(`Receiver account is not set in the context.`);
+			return args.receiverAccount;
+		default: throw new PASClientError(`Unknown pas request: ${extInput.value}`);
+	}
+}
+
+//#endregion
+export { buildMoveCallCommandFromTemplate, collectTemplateObjectIds, getCommandFromTemplate, getRequiredApprovals };
+//# sourceMappingURL=resolution.mjs.map

package/dist/resolution.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolution.mjs","names":[],"sources":["../src/resolution.ts"],"sourcesContent":["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport { SuiClientTypes } from '@mysten/sui/client';\nimport { Inputs, TransactionCommands } from '@mysten/sui/transactions';\nimport type { Argument, CallArg, Command as SdkCommand } from '@mysten/sui/transactions';\nimport { normalizeStructTag } from '@mysten/sui/utils';\n\nimport { TypeName } from './contracts/pas/deps/std/type_name.js';\nimport { Policy } from './contracts/pas/policy.js';\nimport { Command, MoveCall } from './contracts/ptb/ptb.js';\nimport { PASClientError } from './error.js';\nimport { Field } from './contracts/sui/dynamic_field.js';\n\nconst OBJECT_BY_ID_EXT = 'object_by_id';\nconst OBJECT_BY_TYPE_EXT = 'object_by_type';\nconst RECEIVING_BY_ID_EXT = 'receiving_by_id';\n\ntype ParsedTemplateCommand = ReturnType<typeof parseCommand>;\n\n/**\n * Extracts all object IDs referenced by template commands, regardless of\n * how they are specified (fully resolved refs, shared refs, or ext lookups).\n */\nexport function collectTemplateObjectIds(commands: ParsedTemplateCommand[]): Set<string> {\n\tconst ids = new Set<string>();\n\tfor (const cmd of commands) {\n\t\tfor (const arg of cmd.arguments) {\n\t\t\tconst obj = arg.Input?.Object;\n\t\t\tif (!obj) continue;\n\n\t\t\tswitch (obj.$kind) {\n\t\t\t\tcase 'ImmOrOwnedObject':\n\t\t\t\t\tids.add(obj.ImmOrOwnedObject.object_id);\n\t\t\t\t\tbreak;\n\t\t\t\tcase 'SharedObject':\n\t\t\t\t\tids.add(obj.SharedObject.object_id);\n\t\t\t\t\tbreak;\n\t\t\t\tcase 'Receiving':\n\t\t\t\t\tids.add(obj.Receiving.object_id);\n\t\t\t\t\tbreak;\n\t\t\t\tcase 'Ext': {\n\t\t\t\t\tconst [kind, value] = obj.Ext.split(':');\n\t\t\t\t\tswitch (kind) {\n\t\t\t\t\t\tcase OBJECT_BY_ID_EXT:\n\t\t\t\t\t\tcase RECEIVING_BY_ID_EXT:\n\t\t\t\t\t\t\tids.add(value);\n\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\tdefault:\n\t\t\t\t\t\t\tthrow new PASClientError(`Unsupported external object kind: ${kind}`);\n\t\t\t\t\t}\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t\tdefault:\n\t\t\t\t\tthrow new PASClientError(\n\t\t\t\t\t\t'Invariant violation: unhandled variant in `collectTemplateObjectIds`',\n\t\t\t\t\t);\n\t\t\t}\n\t\t}\n\t}\n\treturn ids;\n}\n/**\n * Supported PAS action types that can be resolved via Policies.\n */\nexport type PASActionType = 'send_funds' | 'unlock_funds' | 'clawback_funds';\n\n/**\n * Parses the Policy object to extract the required approval type names for a given action.\n *\n * The Policy's `required_approvals` is a `VecMap<String, VecSet<TypeName>>` where:\n * - Key is the action name (e.g., \"send_funds\")\n * - Value is a set of approval TypeNames that must be satisfied\n *\n * @param policyObject - The Policy object fetched with content\n * @returns The list of approval TypeName strings for the given action, or undefined if not found\n */\nexport function getRequiredApprovals(\n\tpolicyObject: SuiClientTypes.Object<{ content: true }>,\n\tactionType: PASActionType,\n): string[] | undefined {\n\tconst policy = Policy.parse(policyObject.content);\n\n\tconst entry = policy.required_approvals.contents.find((e) => e.key === actionType);\n\n\tif (!entry) return undefined;\n\n\treturn entry.value.contents.map((tn) => tn.name);\n}\n\n/**\n * Parses a Command from a Template dynamic field object.\n *\n * Each Template DF is a `Field<TypeName, Command>` where:\n * - TypeName is the approval type (e.g., the `with_defining_ids` of `TransferApproval`)\n * - Command is the move call instruction to execute for that approval\n *\n * @param templateDF - The Template DF object fetched with content\n * @returns The parsed Command, or undefined if parsing fails\n */\nexport function getCommandFromTemplate(\n\ttemplate: SuiClientTypes.Object<{ content: true }>,\n): ParsedTemplateCommand {\n\tconst df = Field(TypeName, Command).parse(template.content);\n\treturn parseCommand(df.value);\n}\n\nfunction parseCommand([key, cmd]: ReturnType<typeof Command.parse>) {\n\t// Support only `Command` for now.\n\tif (key !== 0) throw new PASClientError(`Unknown command type: ${key}`);\n\n\t// TODO: switch to support more commands like `TransferObjects` etc.\n\treturn MoveCall.parse(new Uint8Array(cmd));\n}\n\n// ---------------------------------------------------------------------------\n// Command builder (for use with TransactionDataBuilder / replaceCommand)\n// ---------------------------------------------------------------------------\n\n/**\n * Arguments for building a MoveCall Command from a template.\n * Used by the intent resolver which works directly with TransactionDataBuilder.\n */\ninterface RawCommandBuildArgs {\n\t/** Adds an input to the parent transaction and returns the Argument ref. */\n\taddInput: (type: 'object' | 'pure', arg: CallArg) => Argument;\n\t/** The sender account argument (already resolved) */\n\tsenderAccount?: Argument;\n\t/** The receiver account argument (already resolved) */\n\treceiverAccount?: Argument;\n\t/** The policy argument (already resolved) */\n\tpolicy?: Argument;\n\t/** The request argument (already resolved) */\n\trequest?: Argument;\n}\n\n/**\n * Builds a `Command` (TransactionCommands.MoveCall) from a parsed template command,\n * suitable for use with `transactionData.replaceCommand()`.\n *\n * Resolves template argument placeholders (pas:request, pas:policy, etc.) into\n * concrete Argument references, and converts object/pure inputs via the provided\n * `addInput` callback.\n *\n * @param command - The parsed MoveCall from a template object\n * @param args - The resolved arguments and addInput helper\n * @param commandOffset - Absolute PTB index where the first template command will\n *   land. Raw `Result` and `NestedResult` values from the on-chain BCS are\n *   template-relative (i.e. `Result(0)` means \"first command in this template\").\n *   We rebase them by adding this offset so they point at the correct position\n *   in the final transaction.\n * @returns A Command object ready for `replaceCommand`\n */\nexport function buildMoveCallCommandFromTemplate(\n\tcommand: ParsedTemplateCommand,\n\targs: RawCommandBuildArgs,\n\tcommandOffset: number,\n): SdkCommand {\n\tconst resolvedArgs: Argument[] = [];\n\n\tfor (const arg of command.arguments) {\n\t\tif (arg.Ext) throw new PASClientError(`There are no supported ext arguments in this client.`);\n\t\telse if (arg.GasCoin) throw new PASClientError(`Gas coin is not supported in PAS client.`);\n\t\telse if (arg.NestedResult != null)\n\t\t\tresolvedArgs.push({\n\t\t\t\t$kind: 'NestedResult',\n\t\t\t\tNestedResult: [arg.NestedResult[0] + commandOffset, arg.NestedResult[1]],\n\t\t\t});\n\t\telse if (arg.Result != null)\n\t\t\tresolvedArgs.push({ $kind: 'Result', Result: arg.Result + commandOffset });\n\t\telse if (arg.Input) {\n\t\t\tif (arg.Input.Pure)\n\t\t\t\tresolvedArgs.push(args.addInput('pure', Inputs.Pure(new Uint8Array(arg.Input.Pure))));\n\t\t\telse if (arg.Input.Object) {\n\t\t\t\tswitch (arg.Input.Object.$kind) {\n\t\t\t\t\tcase 'ImmOrOwnedObject':\n\t\t\t\t\t\tresolvedArgs.push(\n\t\t\t\t\t\t\targs.addInput(\n\t\t\t\t\t\t\t\t'object',\n\t\t\t\t\t\t\t\tInputs.ObjectRef({\n\t\t\t\t\t\t\t\t\tobjectId: arg.Input.Object.ImmOrOwnedObject.object_id,\n\t\t\t\t\t\t\t\t\tversion: arg.Input.Object.ImmOrOwnedObject.sequence_number,\n\t\t\t\t\t\t\t\t\tdigest: arg.Input.Object.ImmOrOwnedObject.digest,\n\t\t\t\t\t\t\t\t}),\n\t\t\t\t\t\t\t),\n\t\t\t\t\t\t);\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase 'SharedObject':\n\t\t\t\t\t\tresolvedArgs.push(\n\t\t\t\t\t\t\targs.addInput(\n\t\t\t\t\t\t\t\t'object',\n\t\t\t\t\t\t\t\tInputs.SharedObjectRef({\n\t\t\t\t\t\t\t\t\tobjectId: arg.Input.Object.SharedObject.object_id,\n\t\t\t\t\t\t\t\t\tinitialSharedVersion: arg.Input.Object.SharedObject.initial_shared_version,\n\t\t\t\t\t\t\t\t\tmutable: arg.Input.Object.SharedObject.is_mutable,\n\t\t\t\t\t\t\t\t}),\n\t\t\t\t\t\t\t),\n\t\t\t\t\t\t);\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase 'Receiving':\n\t\t\t\t\t\tresolvedArgs.push(\n\t\t\t\t\t\t\targs.addInput(\n\t\t\t\t\t\t\t\t'object',\n\t\t\t\t\t\t\t\tInputs.ReceivingRef({\n\t\t\t\t\t\t\t\t\tobjectId: arg.Input.Object.Receiving.object_id,\n\t\t\t\t\t\t\t\t\tversion: arg.Input.Object.Receiving.sequence_number,\n\t\t\t\t\t\t\t\t\tdigest: arg.Input.Object.Receiving.digest,\n\t\t\t\t\t\t\t\t}),\n\t\t\t\t\t\t\t),\n\t\t\t\t\t\t);\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tcase 'Ext':\n\t\t\t\t\t\tconst [kind, value] = arg.Input.Object.Ext.split(':');\n\n\t\t\t\t\t\tswitch (kind) {\n\t\t\t\t\t\t\tcase OBJECT_BY_ID_EXT:\n\t\t\t\t\t\t\tcase RECEIVING_BY_ID_EXT:\n\t\t\t\t\t\t\t\tresolvedArgs.push(\n\t\t\t\t\t\t\t\t\targs.addInput('object', {\n\t\t\t\t\t\t\t\t\t\t$kind: 'UnresolvedObject',\n\t\t\t\t\t\t\t\t\t\tUnresolvedObject: { objectId: value },\n\t\t\t\t\t\t\t\t\t} as CallArg),\n\t\t\t\t\t\t\t\t);\n\t\t\t\t\t\t\t\tbreak;\n\t\t\t\t\t\t\tcase OBJECT_BY_TYPE_EXT:\n\t\t\t\t\t\t\t\tthrow new PASClientError(\n\t\t\t\t\t\t\t\t\t`There are no supported object by type arguments in this client.`,\n\t\t\t\t\t\t\t\t);\n\t\t\t\t\t\t\tdefault:\n\t\t\t\t\t\t\t\tthrow new PASClientError(`Unknown external object argument: ${kind}`);\n\t\t\t\t\t\t}\n\t\t\t\t\t\tbreak;\n\t\t\t\t\tdefault:\n\t\t\t\t\t\tthrow new PASClientError(\n\t\t\t\t\t\t\t`Not supported object argument: ${JSON.stringify(arg.Input.Object)}`,\n\t\t\t\t\t\t);\n\t\t\t\t}\n\t\t\t} else if (arg.Input.Ext) {\n\t\t\t\tresolvedArgs.push(\n\t\t\t\t\tresolveRawPasRequest(args, {\n\t\t\t\t\t\tnamespace: arg.Input.Ext[0],\n\t\t\t\t\t\tvalue: arg.Input.Ext[1],\n\t\t\t\t\t}),\n\t\t\t\t);\n\t\t\t} else {\n\t\t\t\tthrow new PASClientError(`Unsupported input kind: ${arg.Input.$kind}`);\n\t\t\t}\n\t\t}\n\t}\n\n\tconst typeArgs: string[] = [];\n\tfor (const typeArg of command.type_arguments)\n\t\ttypeArgs.push(normalizeStructTag(typeArg).toString());\n\n\tif (!command.module_name || !command.function)\n\t\tthrow new PASClientError(\n\t\t\t'Module name or function name is missing from the on-chain policy. This means that the issuer has not set up the policy correctly.',\n\t\t);\n\n\treturn TransactionCommands.MoveCall({\n\t\tpackage: command.package_id,\n\t\tmodule: command.module_name,\n\t\tfunction: command.function,\n\t\targuments: resolvedArgs,\n\t\ttypeArguments: typeArgs.length > 0 ? typeArgs : [],\n\t});\n}\n\nfunction resolveRawPasRequest(\n\targs: RawCommandBuildArgs,\n\textInput: { namespace: string; value: string },\n): Argument {\n\tif (!extInput.namespace.endsWith('templates::PAS'))\n\t\tthrow new PASClientError(`Unsupported namespace: ${extInput.namespace}`);\n\n\tswitch (extInput.value) {\n\t\tcase 'request':\n\t\t\tif (!args.request) throw new PASClientError(`Request is not set in the context.`);\n\t\t\treturn args.request;\n\t\tcase 'policy':\n\t\t\tif (!args.policy) throw new PASClientError(`Policy is not set in the context.`);\n\t\t\treturn args.policy;\n\t\tcase 'sender_account':\n\t\t\tif (!args.senderAccount)\n\t\t\t\tthrow new PASClientError(`Sender account is not set in the context.`);\n\t\t\treturn args.senderAccount;\n\t\tcase 'receiver_account':\n\t\t\tif (!args.receiverAccount)\n\t\t\t\tthrow new PASClientError(`Receiver account is not set in the context.`);\n\t\t\treturn args.receiverAccount;\n\t\tdefault:\n\t\t\tthrow new PASClientError(`Unknown pas request: ${extInput.value}`);\n\t}\n}\n"],"mappings":";;;;;;;;;AAcA,MAAM,mBAAmB;AACzB,MAAM,qBAAqB;AAC3B,MAAM,sBAAsB;;;;;AAQ5B,SAAgB,yBAAyB,UAAgD;CACxF,MAAM,sBAAM,IAAI,KAAa;AAC7B,MAAK,MAAM,OAAO,SACjB,MAAK,MAAM,OAAO,IAAI,WAAW;EAChC,MAAM,MAAM,IAAI,OAAO;AACvB,MAAI,CAAC,IAAK;AAEV,UAAQ,IAAI,OAAZ;GACC,KAAK;AACJ,QAAI,IAAI,IAAI,iBAAiB,UAAU;AACvC;GACD,KAAK;AACJ,QAAI,IAAI,IAAI,aAAa,UAAU;AACnC;GACD,KAAK;AACJ,QAAI,IAAI,IAAI,UAAU,UAAU;AAChC;GACD,KAAK,OAAO;IACX,MAAM,CAAC,MAAM,SAAS,IAAI,IAAI,MAAM,IAAI;AACxC,YAAQ,MAAR;KACC,KAAK;KACL,KAAK;AACJ,UAAI,IAAI,MAAM;AACd;KACD,QACC,OAAM,IAAI,eAAe,qCAAqC,OAAO;;AAEvE;;GAED,QACC,OAAM,IAAI,eACT,uEACA;;;AAIL,QAAO;;;;;;;;;;;;AAiBR,SAAgB,qBACf,cACA,YACuB;CAGvB,MAAM,QAFS,OAAO,MAAM,aAAa,QAAQ,CAE5B,mBAAmB,SAAS,MAAM,MAAM,EAAE,QAAQ,WAAW;AAElF,KAAI,CAAC,MAAO,QAAO;AAEnB,QAAO,MAAM,MAAM,SAAS,KAAK,OAAO,GAAG,KAAK;;;;;;;;;;;;AAajD,SAAgB,uBACf,UACwB;AAExB,QAAO,aADI,MAAM,UAAU,QAAQ,CAAC,MAAM,SAAS,QAAQ,CACpC,MAAM;;AAG9B,SAAS,aAAa,CAAC,KAAK,MAAwC;AAEnE,KAAI,QAAQ,EAAG,OAAM,IAAI,eAAe,yBAAyB,MAAM;AAGvE,QAAO,SAAS,MAAM,IAAI,WAAW,IAAI,CAAC;;;;;;;;;;;;;;;;;;;AAyC3C,SAAgB,iCACf,SACA,MACA,eACa;CACb,MAAM,eAA2B,EAAE;AAEnC,MAAK,MAAM,OAAO,QAAQ,UACzB,KAAI,IAAI,IAAK,OAAM,IAAI,eAAe,uDAAuD;UACpF,IAAI,QAAS,OAAM,IAAI,eAAe,2CAA2C;UACjF,IAAI,gBAAgB,KAC5B,cAAa,KAAK;EACjB,OAAO;EACP,cAAc,CAAC,IAAI,aAAa,KAAK,eAAe,IAAI,aAAa,GAAG;EACxE,CAAC;UACM,IAAI,UAAU,KACtB,cAAa,KAAK;EAAE,OAAO;EAAU,QAAQ,IAAI,SAAS;EAAe,CAAC;UAClE,IAAI,MACZ,KAAI,IAAI,MAAM,KACb,cAAa,KAAK,KAAK,SAAS,QAAQ,OAAO,KAAK,IAAI,WAAW,IAAI,MAAM,KAAK,CAAC,CAAC,CAAC;UAC7E,IAAI,MAAM,OAClB,SAAQ,IAAI,MAAM,OAAO,OAAzB;EACC,KAAK;AACJ,gBAAa,KACZ,KAAK,SACJ,UACA,OAAO,UAAU;IAChB,UAAU,IAAI,MAAM,OAAO,iBAAiB;IAC5C,SAAS,IAAI,MAAM,OAAO,iBAAiB;IAC3C,QAAQ,IAAI,MAAM,OAAO,iBAAiB;IAC1C,CAAC,CACF,CACD;AACD;EACD,KAAK;AACJ,gBAAa,KACZ,KAAK,SACJ,UACA,OAAO,gBAAgB;IACtB,UAAU,IAAI,MAAM,OAAO,aAAa;IACxC,sBAAsB,IAAI,MAAM,OAAO,aAAa;IACpD,SAAS,IAAI,MAAM,OAAO,aAAa;IACvC,CAAC,CACF,CACD;AACD;EACD,KAAK;AACJ,gBAAa,KACZ,KAAK,SACJ,UACA,OAAO,aAAa;IACnB,UAAU,IAAI,MAAM,OAAO,UAAU;IACrC,SAAS,IAAI,MAAM,OAAO,UAAU;IACpC,QAAQ,IAAI,MAAM,OAAO,UAAU;IACnC,CAAC,CACF,CACD;AACD;EACD,KAAK;GACJ,MAAM,CAAC,MAAM,SAAS,IAAI,MAAM,OAAO,IAAI,MAAM,IAAI;AAErD,WAAQ,MAAR;IACC,KAAK;IACL,KAAK;AACJ,kBAAa,KACZ,KAAK,SAAS,UAAU;MACvB,OAAO;MACP,kBAAkB,EAAE,UAAU,OAAO;MACrC,CAAY,CACb;AACD;IACD,KAAK,mBACJ,OAAM,IAAI,eACT,kEACA;IACF,QACC,OAAM,IAAI,eAAe,qCAAqC,OAAO;;AAEvE;EACD,QACC,OAAM,IAAI,eACT,kCAAkC,KAAK,UAAU,IAAI,MAAM,OAAO,GAClE;;UAEO,IAAI,MAAM,IACpB,cAAa,KACZ,qBAAqB,MAAM;EAC1B,WAAW,IAAI,MAAM,IAAI;EACzB,OAAO,IAAI,MAAM,IAAI;EACrB,CAAC,CACF;KAED,OAAM,IAAI,eAAe,2BAA2B,IAAI,MAAM,QAAQ;CAKzE,MAAM,WAAqB,EAAE;AAC7B,MAAK,MAAM,WAAW,QAAQ,eAC7B,UAAS,KAAK,mBAAmB,QAAQ,CAAC,UAAU,CAAC;AAEtD,KAAI,CAAC,QAAQ,eAAe,CAAC,QAAQ,SACpC,OAAM,IAAI,eACT,oIACA;AAEF,QAAO,oBAAoB,SAAS;EACnC,SAAS,QAAQ;EACjB,QAAQ,QAAQ;EAChB,UAAU,QAAQ;EAClB,WAAW;EACX,eAAe,SAAS,SAAS,IAAI,WAAW,EAAE;EAClD,CAAC;;AAGH,SAAS,qBACR,MACA,UACW;AACX,KAAI,CAAC,SAAS,UAAU,SAAS,iBAAiB,CACjD,OAAM,IAAI,eAAe,0BAA0B,SAAS,YAAY;AAEzE,SAAQ,SAAS,OAAjB;EACC,KAAK;AACJ,OAAI,CAAC,KAAK,QAAS,OAAM,IAAI,eAAe,qCAAqC;AACjF,UAAO,KAAK;EACb,KAAK;AACJ,OAAI,CAAC,KAAK,OAAQ,OAAM,IAAI,eAAe,oCAAoC;AAC/E,UAAO,KAAK;EACb,KAAK;AACJ,OAAI,CAAC,KAAK,cACT,OAAM,IAAI,eAAe,4CAA4C;AACtE,UAAO,KAAK;EACb,KAAK;AACJ,OAAI,CAAC,KAAK,gBACT,OAAM,IAAI,eAAe,8CAA8C;AACxE,UAAO,KAAK;EACb,QACC,OAAM,IAAI,eAAe,wBAAwB,SAAS,QAAQ"}

package/dist/types.d.mts

@@ -0,0 +1,34 @@
+import { ClientWithCoreApi } from "@mysten/sui/client";
+
+//#region src/types.d.ts
+
+/**
+ * Configuration for the PAS package on a specific network
+ */
+interface PASPackageConfig {
+  /** The package ID of the PAS package */
+  packageId: string;
+  /** The namespace ID of the PAS package */
+  namespaceId: string;
+}
+/**
+ * Configuration for the PAS client
+ */
+interface PASClientConfig {
+  /** The Sui client to use */
+  suiClient: ClientWithCoreApi;
+  /** The package configuration (if network is not provided or supported) */
+  packageConfig?: PASPackageConfig;
+}
+/**
+ * Options for creating a PAS client plugin
+ */
+interface PASOptions<Name extends string = 'pas'> {
+  /** The name of the plugin */
+  name?: Name;
+  /** The package configuration */
+  packageConfig?: PASPackageConfig;
+}
+//#endregion
+export { PASClientConfig, PASOptions, PASPackageConfig };
+//# sourceMappingURL=types.d.mts.map

package/dist/types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.mts","names":[],"sources":["../src/types.ts"],"sourcesContent":[],"mappings":";;;;;;AAQA;AAUiB,UAVA,gBAAA,CAYL;EAQK;;;;;;;;UAVA,eAAA;;aAEL;;kBAEK;;;;;UAMA;;SAET;;kBAES"}

package/package.json

@@ -0,0 +1,59 @@
+{
+	"name": "@mysten/pas",
+	"version": "0.0.1",
+	"private": false,
+	"description": "Permissioned Assets Standard SDK",
+	"license": "Apache-2.0",
+	"author": "Mysten Labs <build@mystenlabs.com>",
+	"type": "module",
+	"main": "./dist/index.mjs",
+	"types": "./dist/index.d.mts",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.mts",
+			"import": "./dist/index.mjs",
+			"default": "./dist/index.mjs"
+		}
+	},
+	"sideEffects": false,
+	"files": [
+		"CHANGELOG.md",
+		"dist",
+		"src"
+	],
+	"engines": {
+		"node": ">=18"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/MystenLabs/ts-sdks.git"
+	},
+	"bugs": {
+		"url": "https://github.com/mystenlabs/ts-sdks/issues"
+	},
+	"scripts": {
+		"clean": "rm -rf tsconfig.tsbuildinfo ./dist",
+		"build": "rm -rf dist && tsc --noEmit && tsdown",
+		"test": "NODE_OPTIONS='--expose-gc' vitest run",
+		"test:e2e": "vitest run e2e",
+		"codegen": "sui-ts-codegen generate && pnpm lint:fix",
+		"prettier:check": "prettier -c --ignore-unknown .",
+		"prettier:fix": "prettier -w --ignore-unknown .",
+		"oxlint:check": "oxlint  .",
+		"oxlint:fix": "oxlint --fix",
+		"lint": "pnpm run oxlint:check && pnpm run prettier:check",
+		"lint:fix": "pnpm run oxlint:fix && pnpm run prettier:fix"
+	},
+	"devDependencies": {
+		"@mysten/codegen": "workspace:^",
+		"@mysten/sui": "workspace:^",
+		"@types/node": "^25.0.8",
+		"ts-retry-promise": "^0.8.1",
+		"tsdown": "0.20.0-beta.1",
+		"typescript": "^5.9.3",
+		"vitest": "^4.0.17"
+	},
+	"peerDependencies": {
+		"@mysten/sui": "workspace:^"
+	}
+}

package/src/client.ts

@@ -0,0 +1,173 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import type { ClientWithCoreApi } from '@mysten/sui/client';
+
+import { TESTNET_PAS_PACKAGE_CONFIG } from './constants.js';
+import {
+	deriveAccountAddress,
+	derivePolicyAddress,
+	deriveTemplateAddress,
+	deriveTemplateRegistryAddress,
+} from './derivation.js';
+import { PASClientError } from './error.js';
+import {
+	accountForAddressIntent,
+	sendBalanceIntent,
+	unlockBalanceIntent,
+	unlockUnrestrictedBalanceIntent,
+} from './intents.js';
+import type { PASClientConfig, PASOptions, PASPackageConfig } from './types.js';
+
+export function pas<const Name extends string = 'pas'>({
+	packageConfig,
+	name = 'pas' as Name,
+	...options
+}: PASOptions<Name> = {}): {
+	name: Name;
+	register: (client: ClientWithCoreApi) => PASClient;
+} {
+	return {
+		name,
+		register: (client: ClientWithCoreApi) =>
+			new PASClient({ packageConfig, suiClient: client, ...options }),
+	};
+}
+
+export class PASClient {
+	#packageConfig: PASPackageConfig;
+
+	constructor(config: PASClientConfig) {
+		const network = config.suiClient.network;
+
+		// Mainnet: no custom config allowed (avoid accidental republishing).
+		if (network === 'mainnet' && config.packageConfig) {
+			throw new PASClientError(
+				'Custom package configuration is not allowed on mainnet. Use the built-in mainnet config when mainnet is supported.',
+			);
+		}
+
+		if (config.packageConfig) {
+			this.#packageConfig = config.packageConfig;
+			return;
+		}
+
+		if (!network || (network !== 'mainnet' && network !== 'testnet')) {
+			throw new PASClientError(
+				'PAS client requires a known network (mainnet, testnet) or a custom package configuration.',
+			);
+		}
+
+		// TODO: Remove when we add mainnet data
+		if (network === 'mainnet') {
+			throw new PASClientError('Mainnet is not supported yet.');
+		}
+
+		this.#packageConfig = TESTNET_PAS_PACKAGE_CONFIG;
+	}
+
+	/**
+	 * Get the package configuration
+	 */
+	getPackageConfig() {
+		return this.#packageConfig;
+	}
+
+	/**
+	 * Derives the account address for a given owner address.
+	 *
+	 * @param owner - The owner address (can be a user address or object address)
+	 * @returns The derived account object ID
+	 */
+	deriveAccountAddress(owner: string): string {
+		return deriveAccountAddress(owner, this.#packageConfig);
+	}
+
+	/**
+	 * Derives the policy address for a given asset type T.
+	 * By default wraps with `Balance<T>` to match the on-chain convention.
+	 *
+	 * @param assetType - The full type of the asset (e.g., "0x2::sui::SUI")
+	 * @returns The derived policy object ID
+	 */
+	derivePolicyAddress(assetType: string): string {
+		return derivePolicyAddress(assetType, this.#packageConfig);
+	}
+
+	/**
+	 * Derives the templates object address for a given package configuration.
+	 *
+	 * @returns The derived templates object ID
+	 */
+	deriveTemplateRegistryAddress(): string {
+		return deriveTemplateRegistryAddress(this.#packageConfig);
+	}
+
+	/**
+	 * Derives the template DF address for a given approval type name.
+	 *
+	 * @param approvalTypeName - The fully qualified approval type name
+	 * @returns The derived dynamic field object ID
+	 */
+	deriveTemplateAddress(approvalTypeName: string): string {
+		return deriveTemplateAddress(this.deriveTemplateRegistryAddress(), approvalTypeName);
+	}
+
+	/**
+	 * Intent-based transaction builders. Each method returns a synchronous closure
+	 * that registers a `$Intent` placeholder in the transaction. The actual PTB commands
+	 * are resolved lazily at `tx.build()` time via the shared PAS resolver plugin.
+	 */
+	get call() {
+		return {
+			/**
+			 * Creates a transfer funds intent. At build time, it auto-resolves the issuer's
+			 * approval template commands by reading the Policy and Templates objects on-chain.
+			 * If the recipient account does not exist, it will be created and shared automatically.
+			 *
+			 * @param options - Transfer options
+			 * @param options.from - The sender's address (owner of the source account)
+			 * @param options.to - The receiver's address (owner of the destination account)
+			 * @param options.amount - The amount to transfer
+			 * @param options.assetType - The full asset type (e.g., "0x2::sui::SUI")
+			 * @returns A sync closure `(tx: Transaction) => TransactionResult`
+			 */
+			sendBalance: sendBalanceIntent(this.#packageConfig),
+
+			/**
+			 * Creates an unlock balance intent. At build time, it resolves the issuer's
+			 * approval template commands. This will fail if the issuer has not configured
+			 * unlock approvals for the asset type.
+			 *
+			 * @param options - Unlock options
+			 * @param options.from - The sender's address (owner of the source account)
+			 * @param options.amount - The amount to unlock
+			 * @param options.assetType - The full asset type (e.g., "0x2::sui::SUI")
+			 * @returns A sync closure `(tx: Transaction) => TransactionResult`
+			 */
+			unlockBalance: unlockBalanceIntent(this.#packageConfig),
+
+			/**
+			 * Creates an unlock balance intent for unrestricted (non-managed) assets.
+			 * Use this when no Policy exists for the asset type (e.g., SUI).
+			 *
+			 * @param options - Unlock options
+			 * @param options.from - The sender's address (owner of the source account)
+			 * @param options.amount - The amount to unlock
+			 * @param options.assetType - The full asset type (e.g., "0x2::sui::SUI")
+			 * @returns A sync closure `(tx: Transaction) => TransactionResult`
+			 */
+			unlockUnrestrictedBalance: unlockUnrestrictedBalanceIntent(this.#packageConfig),
+
+			/**
+			 * Returns a account object for the given address. At build time, if the account
+			 * already exists on-chain it resolves to an object reference; otherwise it
+			 * creates the account and shares it.
+			 *
+			 * @param owner - The owner address
+			 * @returns A sync closure `(tx: Transaction) => TransactionResult` (the account)
+			 */
+			accountForAddress: accountForAddressIntent(this.#packageConfig),
+		};
+	}
+}

package/src/constants.ts

@@ -0,0 +1,15 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+import type { PASPackageConfig } from './types.js';
+
+export const TESTNET_PAS_PACKAGE_CONFIG: PASPackageConfig = {
+	packageId: '0x7e77592474ea9759b46ca5c6515ed4840952cd80d60ee54a1614382811d46730',
+	namespaceId: '0xf7c77ac8bbbdf47f7b1cf8ac8aa489cfc4dff25847f3e2e1db53bde5c454be2b',
+};
+
+// TODO: also update `client.ts` when adding these variables
+export const MAINNET_PAS_PACKAGE_CONFIG: PASPackageConfig = {
+	packageId: '', // TODO: Replace with actual mainnet package ID
+	namespaceId: '', // TODO: Replace with actual mainnet namespace ID
+};