@ocap/tx-protocols 1.28.9 → 1.29.0

package/lib/pipes/ensure-gas.cjs

@@ -0,0 +1,41 @@
+Object.defineProperty(exports, '__esModule', { value: true });
+const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
+let _ocap_util = require("@ocap/util");
+let debug = require("debug");
+debug = require_rolldown_runtime.__toESM(debug);
+
+//#region src/pipes/ensure-gas.ts
+const debug$1 = (0, debug.default)("@ocap/tx-protocols:pipes:ensure-gas");
+function CreateGasEnsureFn(estimateTxGas) {
+	return function EnsureTxGas(context, next) {
+		const { txHash = "", config } = context;
+		const { txGas } = config.transaction;
+		const basePrice = new _ocap_util.BN(txGas.price);
+		const estimate = estimateTxGas(context);
+		let totalGas = new _ocap_util.BN(0);
+		if (context.txBaseGas) {
+			totalGas = basePrice.mul(new _ocap_util.BN(txGas.dataStorage)).mul(new _ocap_util.BN(context.txSize));
+			totalGas = totalGas.add(basePrice.mul(new _ocap_util.BN(txGas.createState)).mul(new _ocap_util.BN(estimate.create + 1)));
+			totalGas = totalGas.add(basePrice.mul(new _ocap_util.BN(txGas.updateState)).mul(new _ocap_util.BN(estimate.update)));
+		}
+		const { txGas: gasVaults = [] } = config.vaults;
+		const gasVault = gasVaults[gasVaults.length > 0 ? (0, _ocap_util.hexToNumber)(txHash.slice(-8)) % gasVaults.length : 0];
+		context.gasVault = gasVault;
+		debug$1({
+			txType: context.txType,
+			txHash: context.txHash,
+			txSize: context.txSize,
+			txBaseGas: context.txBaseGas,
+			totalGas: totalGas.toString(10),
+			gasVault,
+			estimate
+		});
+		context.totalGas = totalGas;
+		context.gasEstimate = estimate;
+		return next();
+	};
+}
+var ensure_gas_default = CreateGasEnsureFn;
+
+//#endregion
+exports.default = ensure_gas_default;

package/lib/pipes/ensure-gas.d.cts

@@ -0,0 +1,14 @@
+import { PipeFunction } from "@ocap/tx-pipeline";
+
+//#region src/pipes/ensure-gas.d.ts
+/** Gas estimate result */
+interface IGasEstimate {
+  create: number;
+  update: number;
+  payment?: number;
+}
+/** Gas estimator function type - uses any for flexible context access */
+type GasEstimatorFn = (context: any) => IGasEstimate;
+declare function CreateGasEnsureFn(estimateTxGas: GasEstimatorFn): PipeFunction<any>;
+//#endregion
+export { CreateGasEnsureFn as default };

package/lib/protocols/account/delegate.cjs

@@ -0,0 +1,201 @@
+Object.defineProperty(exports, '__esModule', { value: true });
+const require_rolldown_runtime = require('../../_virtual/rolldown_runtime.cjs');
+const require_pipes_ensure_cost = require('../../pipes/ensure-cost.cjs');
+const require_pipes_ensure_gas = require('../../pipes/ensure-gas.cjs');
+let _ocap_tx_pipeline = require("@ocap/tx-pipeline");
+let _ocap_util_lib_error = require("@ocap/util/lib/error");
+let lodash_get = require("lodash/get");
+lodash_get = require_rolldown_runtime.__toESM(lodash_get);
+let lodash_pick = require("lodash/pick");
+lodash_pick = require_rolldown_runtime.__toESM(lodash_pick);
+let _arcblock_did_util = require("@arcblock/did-util");
+let _ocap_state = require("@ocap/state");
+let debug = require("debug");
+debug = require_rolldown_runtime.__toESM(debug);
+let _ocap_message = require("@ocap/message");
+let lodash_cloneDeep = require("lodash/cloneDeep");
+lodash_cloneDeep = require_rolldown_runtime.__toESM(lodash_cloneDeep);
+let _arcblock_validator = require("@arcblock/validator");
+
+//#region src/protocols/account/delegate.ts
+const debug$1 = (0, debug.default)("@ocap/tx-protocols:delegate");
+const runner = new _ocap_tx_pipeline.Runner("delegate");
+runner.use(_ocap_tx_pipeline.pipes.VerifyMultiSig(0));
+const rateLimit = _arcblock_validator.Joi.object({
+	interval: _arcblock_validator.Joi.number().integer().greater(0).required(),
+	anchor: _arcblock_validator.Joi.number().integer().min(0).optional().allow(null).default(0)
+});
+const tokenLimit = _arcblock_validator.Joi.object({
+	address: _arcblock_validator.Joi.DID().prefix().role("ROLE_TOKEN").required(),
+	toList: _arcblock_validator.Joi.array().items(_arcblock_validator.Joi.DID().prefix()).max(32).unique().optional().allow(null).default([]),
+	txCount: _arcblock_validator.Joi.number().integer().min(0).empty("").optional().allow(null).default(0),
+	txAllowance: _arcblock_validator.Joi.BN().optional().allow(null).default("0"),
+	totalAllowance: _arcblock_validator.Joi.BN().optional().allow(null).default("0"),
+	validUntil: _arcblock_validator.Joi.number().integer().min(0).empty("").optional().allow(null).default(0),
+	rate: rateLimit.optional().allow(null)
+});
+const assetLimit = _arcblock_validator.Joi.object({
+	address: _arcblock_validator.Joi.array().items(_arcblock_validator.Joi.DID().prefix().role("ROLE_ASSET")).unique().max(1024).optional().allow(null).default([]),
+	toList: _arcblock_validator.Joi.array().items(_arcblock_validator.Joi.DID().prefix()).unique().max(32).optional().allow(null).default([]),
+	txCount: _arcblock_validator.Joi.number().integer().min(0).empty("").optional().allow(null).default(0),
+	validUntil: _arcblock_validator.Joi.number().integer().min(0).empty("").optional().allow(null).default(0),
+	rate: rateLimit.optional().allow(null)
+});
+const schema = _arcblock_validator.Joi.object({
+	address: _arcblock_validator.Joi.DID().prefix().role("ROLE_DELEGATION").required(),
+	to: _arcblock_validator.Joi.DID().prefix().required(),
+	opsList: _arcblock_validator.Joi.array().items(_arcblock_validator.Joi.object({
+		typeUrl: _arcblock_validator.Joi.string().required(),
+		limit: _arcblock_validator.Joi.object({
+			tokensList: _arcblock_validator.Joi.array().items(tokenLimit).unique((a, b) => a.address === b.address).max(32),
+			assetsList: _arcblock_validator.Joi.array().items(assetLimit).max(32)
+		}).optional().allow(null).default({
+			tokensList: [],
+			assetsList: []
+		})
+	})).unique((a, b) => a.typeUrl === b.typeUrl).min(1).required(),
+	data: _arcblock_validator.Joi.any().optional().allow(null)
+}).options({
+	stripUnknown: true,
+	noDefaults: false
+});
+runner.use((context, next) => {
+	const { error, value } = schema.validate(context.itx);
+	if (error) return next(new _ocap_util_lib_error.CustomError("INVALID_TX", `Invalid itx: ${error.message}`));
+	context.formattedItx = (0, _ocap_message.formatMessage)("DelegateTx", context.itx);
+	context.validatedItx = value;
+	return next();
+});
+runner.use(_ocap_tx_pipeline.pipes.VerifyInfo([{
+	error: "INVALID_TX",
+	message: "Delegation address does not match",
+	fn: (ctx) => {
+		const context = ctx;
+		return (0, _arcblock_did_util.toDelegateAddress)(context.tx.from, context.itx.to) === context.itx.address;
+	}
+}, {
+	error: "INVALID_DELEGATION_TYPE_URL",
+	message: "Delegation type url is not allowed",
+	fn: (ctx) => {
+		const context = ctx;
+		const allowed = (0, lodash_get.default)(context.config, "transaction.delegate.typeUrls", []);
+		return (context.formattedItx?.ops || []).every((op) => allowed.includes(op.typeUrl));
+	}
+}]));
+runner.use(_ocap_tx_pipeline.pipes.ExtractState({
+	from: "tx.from",
+	to: "senderState",
+	status: "OK",
+	table: "account"
+}));
+runner.use(_ocap_tx_pipeline.pipes.VerifyAccountMigration({
+	stateKey: "senderState",
+	addressKey: "tx.from"
+}));
+runner.use(_ocap_tx_pipeline.pipes.ExtractState({
+	from: "itx.to",
+	to: "receiverState",
+	status: "OK",
+	table: "account"
+}));
+runner.use(_ocap_tx_pipeline.pipes.VerifyBlocked({ stateKeys: ["receiverState"] }));
+runner.use(_ocap_tx_pipeline.pipes.VerifyAccountMigration({
+	stateKey: "receiverState",
+	addressKey: "itx.to"
+}));
+runner.use(_ocap_tx_pipeline.pipes.AntiLandAttack({
+	senderState: "senderState",
+	receiverState: "receiverState"
+}));
+runner.use(_ocap_tx_pipeline.pipes.ExtractState({
+	from: "itx.address",
+	to: "delegationState",
+	table: "delegation",
+	status: "OK"
+}));
+runner.use(require_pipes_ensure_gas.default((context) => {
+	const result = {
+		create: 0,
+		update: 1,
+		payment: 0
+	};
+	if (context.receiverState) result.update += 1;
+	else result.create += 1;
+	if (context.delegationState) result.update += 1;
+	else result.create += 1;
+	return result;
+}));
+runner.use(require_pipes_ensure_cost.default({ attachSenderChanges: true }));
+runner.use(_ocap_tx_pipeline.pipes.TakeStateSnapshot());
+runner.use(async (context, next) => {
+	const { tx, itx, formattedItx, validatedItx, statedb, senderState, receiverState, delegationState, senderUpdates, updateVaults } = context;
+	const ops = formattedItx?.ops || [];
+	const opsList = validatedItx?.opsList || [];
+	const merged = (0, lodash_cloneDeep.default)(ops).reduce((acc, x, i) => {
+		const tokens = x.limit?.tokens || [];
+		const assets = x.limit?.assets || [];
+		acc[x.typeUrl] = { limit: {
+			tokens: tokens.map((y, j) => {
+				const input = opsList[i]?.limit?.tokensList?.[j] || {};
+				return Object.assign(y, (0, lodash_pick.default)(input, [
+					"txCount",
+					"txAllowance",
+					"totalAllowance",
+					"validUntil",
+					"rate"
+				]), {
+					txSent: 0,
+					lastTx: y.rate ? y.rate.anchor : 0,
+					spentAllowance: "0"
+				});
+			}),
+			assets: assets.map((y, j) => {
+				const input = opsList[i]?.limit?.assetsList?.[j] || {};
+				return Object.assign(y, (0, lodash_pick.default)(input, [
+					"txCount",
+					"validUntil",
+					"rate"
+				]), {
+					txSent: 0,
+					lastTx: y.rate ? y.rate.anchor : 0
+				});
+			})
+		} };
+		return acc;
+	}, delegationState ? delegationState.ops : {});
+	const sender = senderState ? senderState.address : tx.from;
+	const receiver = receiverState ? receiverState.address : itx.to;
+	const tokenAddress = context.config.token.address;
+	const [newSenderState, newReceiverState, newDelegationState] = await Promise.all([
+		statedb.account.updateOrCreate(senderState ?? null, _ocap_state.account.updateOrCreate(senderState ?? null, {
+			...senderUpdates,
+			address: sender,
+			nonce: tx.nonce,
+			pk: tx.pk
+		}, context), context),
+		receiverState ? Promise.resolve(receiverState) : statedb.account.create(receiver, _ocap_state.account.create({
+			address: receiver,
+			tokens: { [tokenAddress]: "0" }
+		}, context), context),
+		delegationState ? statedb.delegation.update(itx.address, _ocap_state.delegation.update(delegationState, {
+			...itx,
+			from: sender,
+			ops: merged
+		}, context), context) : statedb.delegation.create(itx.address, _ocap_state.delegation.create({
+			...itx,
+			from: sender,
+			ops: merged
+		}, context), context)
+	]);
+	if (updateVaults) await updateVaults();
+	debug$1(delegationState ? "update" : "create", newDelegationState);
+	context.senderState = newSenderState;
+	context.receiverState = newReceiverState;
+	context.delegationState = newDelegationState;
+	return next();
+}, { persistError: true });
+runner.use(_ocap_tx_pipeline.pipes.VerifyStateDiff());
+var delegate_default = runner;
+
+//#endregion
+exports.default = delegate_default;

package/lib/protocols/account/delegate.d.cts

@@ -0,0 +1,4 @@
+//#region src/protocols/account/delegate.d.ts
+declare const runner: any;
+//#endregion
+export { runner as default };

package/lib/protocols/account/migrate.cjs

@@ -0,0 +1,135 @@
+Object.defineProperty(exports, '__esModule', { value: true });
+const require_rolldown_runtime = require('../../_virtual/rolldown_runtime.cjs');
+const require_util = require('../../util.cjs');
+const require_pipes_ensure_cost = require('../../pipes/ensure-cost.cjs');
+const require_pipes_ensure_gas = require('../../pipes/ensure-gas.cjs');
+let _ocap_tx_pipeline = require("@ocap/tx-pipeline");
+let _ocap_util_lib_error = require("@ocap/util/lib/error");
+let _arcblock_did = require("@arcblock/did");
+let _ocap_state = require("@ocap/state");
+let debug = require("debug");
+debug = require_rolldown_runtime.__toESM(debug);
+let _arcblock_validator = require("@arcblock/validator");
+let _ocap_mcrypto = require("@ocap/mcrypto");
+let _ocap_util_lib_get_related_addr = require("@ocap/util/lib/get-related-addr");
+let lodash_flatten = require("lodash/flatten");
+lodash_flatten = require_rolldown_runtime.__toESM(lodash_flatten);
+let lodash_uniq = require("lodash/uniq");
+lodash_uniq = require_rolldown_runtime.__toESM(lodash_uniq);
+
+//#region src/protocols/account/migrate.ts
+const { RoleType } = _ocap_mcrypto.types;
+const debug$1 = (0, debug.default)("@ocap/tx-protocols:migrate");
+const runner = new _ocap_tx_pipeline.Runner("account_migrate");
+runner.use(_ocap_tx_pipeline.pipes.VerifyMultiSig(0));
+const schema = _arcblock_validator.Joi.object({
+	address: _arcblock_validator.Joi.DID().prefix().required(),
+	pk: _arcblock_validator.Joi.any().required(),
+	data: _arcblock_validator.Joi.any().optional().allow(null)
+}).options({
+	stripUnknown: true,
+	noDefaults: false
+});
+runner.use((context, next) => {
+	const { error } = schema.validate(context.itx);
+	if (error) return next(new _ocap_util_lib_error.CustomError("INVALID_TX", `Invalid itx: ${error.message}`));
+	return next();
+});
+runner.use(_ocap_tx_pipeline.pipes.VerifyInfo([{
+	error: "INVALID_RECEIVER_STATE",
+	message: "Receiver pk and address does not match",
+	fn: (ctx) => {
+		const context = ctx;
+		return (0, _arcblock_did.fromPublicKey)(context.itx.pk, (0, _arcblock_did.toTypeInfo)(context.itx.address)) === context.itx.address && context.itx.address !== context.tx.from;
+	}
+}]));
+runner.use(_ocap_tx_pipeline.pipes.ExtractState({
+	from: "tx.from",
+	to: "senderState",
+	status: "OK",
+	table: "account"
+}));
+runner.use(_ocap_tx_pipeline.pipes.VerifyAccountMigration({
+	stateKey: "senderState",
+	addressKey: "tx.from"
+}));
+runner.use(require_pipes_ensure_gas.default((context) => {
+	const { senderState, tx, itx } = context;
+	if ([senderState?.address || tx.from, itx.address].every((address) => (0, _arcblock_did.toTypeInfo)(address).role === RoleType.ROLE_APPLICATION)) {
+		Object.defineProperty(context, "txBaseGas", { value: false });
+		return {
+			create: 0,
+			update: 0,
+			payment: 0
+		};
+	}
+	if (itx.data) {
+		const decodedValue = require_util.decodeAnySafe(itx.data)?.value;
+		if (decodedValue && decodedValue.purpose === "connect-wallet") {
+			Object.defineProperty(context, "txBaseGas", { value: false });
+			return {
+				create: 0,
+				update: 0,
+				payment: 0
+			};
+		}
+	}
+	return {
+		create: context.senderState ? 1 : 2,
+		update: context.senderState ? (0, _ocap_util_lib_get_related_addr.getRelatedAddresses)(context.senderState).length : 0,
+		payment: 0
+	};
+}));
+runner.use(require_pipes_ensure_cost.default({
+	attachSenderChanges: true,
+	throwOnInsufficientFund: false
+}));
+runner.use(_ocap_tx_pipeline.pipes.TakeStateSnapshot());
+runner.use(async (context, next) => {
+	const { statedb, tx, itx, senderUpdates, updateVaults } = context;
+	const sender = context.senderState;
+	const receiver = await statedb.account.get(itx.address, context);
+	const tokenAddress = context.config.token.address;
+	const senderTokens = sender?.tokens || { [tokenAddress]: "0" };
+	const senderAddress = sender?.address || tx.from;
+	if (receiver) return next(new _ocap_util_lib_error.CustomError("INVALID_RECEIVER_STATE", "Can not migrate to an existing account"));
+	const newAccount = await statedb.account.create(itx.address, _ocap_state.account.create({
+		...sender || { tokens: senderTokens },
+		...senderUpdates,
+		address: itx.address,
+		pk: itx.pk,
+		migratedFrom: sender ? (0, lodash_uniq.default)((0, lodash_flatten.default)([sender.address, ...sender.migratedFrom || []])) : [senderAddress]
+	}, context), context);
+	debug$1("new account", newAccount);
+	const addresses = sender ? (0, _ocap_util_lib_get_related_addr.getRelatedAddresses)(sender) : [senderAddress];
+	const states = await Promise.all(addresses.map(async (address) => {
+		let state;
+		if (address === senderAddress) {
+			state = _ocap_state.account.updateOrCreate(sender ?? null, {
+				address,
+				tokens: senderTokens,
+				migratedTo: [itx.address],
+				nonce: tx.nonce
+			}, context);
+			await statedb.account.updateOrCreate(sender ?? null, state, context);
+		} else {
+			const old = await statedb.account.get(address, {
+				traceMigration: false,
+				txn: context.txn
+			});
+			state = _ocap_state.account.update(old, { migratedTo: [itx.address] }, context);
+			await statedb.account.update(address, state, context);
+		}
+		return state;
+	}));
+	debug$1("old accounts", states);
+	if (updateVaults) await updateVaults();
+	context.receiverState = newAccount;
+	context.senderState = states.find((x) => x.address === senderAddress);
+	return next();
+}, { persistError: true });
+runner.use(_ocap_tx_pipeline.pipes.VerifyStateDiff());
+var migrate_default = runner;
+
+//#endregion
+exports.default = migrate_default;

package/lib/protocols/account/migrate.d.cts

@@ -0,0 +1,4 @@
+//#region src/protocols/account/migrate.d.ts
+declare const runner: any;
+//#endregion
+export { runner as default };

package/lib/protocols/account/revoke-delegate.cjs

@@ -0,0 +1,107 @@
+Object.defineProperty(exports, '__esModule', { value: true });
+const require_rolldown_runtime = require('../../_virtual/rolldown_runtime.cjs');
+const require_pipes_ensure_cost = require('../../pipes/ensure-cost.cjs');
+const require_pipes_ensure_gas = require('../../pipes/ensure-gas.cjs');
+let _ocap_tx_pipeline = require("@ocap/tx-pipeline");
+let _ocap_util_lib_error = require("@ocap/util/lib/error");
+let lodash_get = require("lodash/get");
+lodash_get = require_rolldown_runtime.__toESM(lodash_get);
+let _arcblock_did_util = require("@arcblock/did-util");
+let _ocap_state = require("@ocap/state");
+let debug = require("debug");
+debug = require_rolldown_runtime.__toESM(debug);
+let _ocap_util_lib_get_list_field = require("@ocap/util/lib/get-list-field");
+let lodash_cloneDeep = require("lodash/cloneDeep");
+lodash_cloneDeep = require_rolldown_runtime.__toESM(lodash_cloneDeep);
+let _arcblock_validator = require("@arcblock/validator");
+
+//#region src/protocols/account/revoke-delegate.ts
+const debug$1 = (0, debug.default)("@ocap/tx-protocols:delegate");
+const runner = new _ocap_tx_pipeline.Runner("revoke_delegate");
+runner.use(_ocap_tx_pipeline.pipes.VerifyMultiSig(0));
+const schema = _arcblock_validator.Joi.object({
+	address: _arcblock_validator.Joi.DID().prefix().role("ROLE_DELEGATION").required(),
+	to: _arcblock_validator.Joi.DID().prefix().required(),
+	typeUrlsList: _arcblock_validator.Joi.array().items(_arcblock_validator.Joi.string().required()).min(1).required(),
+	data: _arcblock_validator.Joi.any().optional().allow(null)
+}).options({
+	stripUnknown: true,
+	noDefaults: false
+});
+runner.use((context, next) => {
+	const { error } = schema.validate(context.itx);
+	if (error) return next(new _ocap_util_lib_error.CustomError("INVALID_TX", `Invalid itx: ${error.message}`));
+	return next();
+});
+runner.use(_ocap_tx_pipeline.pipes.VerifyInfo([
+	{
+		error: "OK",
+		fn: (ctx) => {
+			const context = ctx;
+			context.typeUrls = (0, _ocap_util_lib_get_list_field.getListField)(context, "itx.typeUrls");
+			return true;
+		}
+	},
+	{
+		error: "INVALID_TX",
+		message: "Delegation address does not match",
+		fn: (ctx) => {
+			const context = ctx;
+			return (0, _arcblock_did_util.toDelegateAddress)(context.tx.from, context.itx.to) === context.itx.address;
+		}
+	},
+	{
+		error: "INVALID_DELEGATION_TYPE_URL",
+		message: "Delegation type url is not allowed",
+		fn: (ctx) => {
+			const context = ctx;
+			const allowed = (0, lodash_get.default)(context.config, "transaction.delegate.typeUrls", []);
+			return (context.typeUrls || []).every((x) => allowed.includes(x));
+		}
+	}
+]));
+runner.use(_ocap_tx_pipeline.pipes.ExtractState({
+	from: "itx.address",
+	to: "delegationState",
+	status: "INVALID_DELEGATION",
+	table: "delegation"
+}));
+runner.use(_ocap_tx_pipeline.pipes.ExtractState({
+	from: "tx.from",
+	to: "senderState",
+	status: "INVALID_SENDER_STATE",
+	table: "account"
+}));
+runner.use(_ocap_tx_pipeline.pipes.VerifyAccountMigration({
+	stateKey: "senderState",
+	addressKey: "tx.from"
+}));
+runner.use(require_pipes_ensure_gas.default(() => ({
+	create: 0,
+	update: 2,
+	payment: 0
+})));
+runner.use(require_pipes_ensure_cost.default({ attachSenderChanges: true }));
+runner.use(_ocap_tx_pipeline.pipes.TakeStateSnapshot());
+runner.use(async (context, next) => {
+	const { tx, itx, typeUrls, statedb, senderState, senderUpdates, delegationState, updateVaults } = context;
+	debug$1("update", {
+		address: itx.address,
+		typeUrls
+	});
+	const newOps = (0, lodash_cloneDeep.default)(delegationState.ops);
+	(typeUrls || []).forEach((x) => delete newOps[x]);
+	const [newSenderState, newDelegationState] = await Promise.all([statedb.account.update(senderState.address, _ocap_state.account.update(senderState, {
+		...senderUpdates,
+		nonce: tx.nonce
+	}, context), context), statedb.delegation.update(itx.address, _ocap_state.delegation.update(delegationState, { ops: newOps }, context), context)]);
+	if (updateVaults) await updateVaults();
+	context.senderState = newSenderState;
+	context.delegationState = newDelegationState;
+	return next();
+}, { persistError: true });
+runner.use(_ocap_tx_pipeline.pipes.VerifyStateDiff());
+var revoke_delegate_default = runner;
+
+//#endregion
+exports.default = revoke_delegate_default;

package/lib/protocols/account/revoke-delegate.d.cts

@@ -0,0 +1,4 @@
+//#region src/protocols/account/revoke-delegate.d.ts
+declare const runner: any;
+//#endregion
+export { runner as default };