@ocap/tx-protocols 1.28.8 → 1.29.0

package/esm/protocols/token-factory/burn.mjs

@@ -0,0 +1,233 @@
+import { applyTokenChange, applyTokenUpdates } from "../../util.mjs";
+import ensure_cost_default from "../../pipes/ensure-cost.mjs";
+import ensure_gas_default from "../../pipes/ensure-gas.mjs";
+import calc_reserve_default from "./pipes/calc-reserve.mjs";
+import { Runner, pipes } from "@ocap/tx-pipeline";
+import { CustomError } from "@ocap/util/lib/error";
+import pick from "lodash/pick.js";
+import { account, token, tokenFactory } from "@ocap/state";
+import { BN, fromUnitToToken } from "@ocap/util";
+import { getListField } from "@ocap/util/lib/get-list-field";
+import { Joi, schemas } from "@arcblock/validator";
+
+//#region src/protocols/token-factory/burn.ts
+const runner = new Runner("burn_token");
+const schema = Joi.object({
+	tokenFactory: Joi.DID().prefix().role("ROLE_TOKEN_FACTORY").required(),
+	receiver: schemas.tokenHolder.required(),
+	minReserve: Joi.alternatives().try(Joi.BN().greater(0), Joi.equal("")).optional(),
+	inputsList: schemas.multiInput.min(1).required(),
+	data: Joi.any().optional().allow(null)
+}).options({
+	stripUnknown: true,
+	noDefaults: false
+});
+runner.use(({ itx }, next) => {
+	const { error } = schema.validate(itx);
+	if (error) return next(new CustomError("INVALID_TX", `Invalid itx: ${error.message}`));
+	return next();
+});
+runner.use(pipes.ExtractState({
+	from: "itx.tokenFactory",
+	to: "tokenFactoryState",
+	status: "INVALID_TOKEN_FACTORY",
+	table: "tokenFactory"
+}));
+runner.use(pipes.ExtractState({
+	from: "tokenFactoryState.tokenAddress",
+	to: "tokenState",
+	status: "INVALID_TOKEN",
+	table: "token"
+}));
+runner.use(pipes.VerifyTxInput({
+	fieldKey: "itx.inputs",
+	inputsKey: "inputs",
+	sendersKey: "senders",
+	tokensKey: "tokens",
+	assetsKey: null
+}));
+runner.use(pipes.VerifyListSize({ listKey: [
+	"inputs",
+	"senders",
+	"tokens",
+	"assets"
+] }));
+runner.use(pipes.VerifyMultiSigV2({ signersKey: "senders" }));
+runner.use((context, next) => {
+	const { tokenFactoryState, inputs } = context;
+	if (!(inputs || []).every((input) => {
+		const tokensList = getListField(input, "tokens");
+		const assetsList = getListField(input, "assets");
+		return tokensList.length && tokensList.every((x) => x.address === tokenFactoryState.tokenAddress) && !assetsList.length;
+	})) return next(new CustomError("INVALID_TX", `Inputs only accept ${tokenFactoryState.tokenAddress}`));
+	return next();
+});
+runner.use(pipes.ExtractState({
+	from: "tx.from",
+	to: "senderState",
+	status: "OK",
+	table: "account"
+}));
+runner.use(pipes.VerifyAccountMigration({
+	stateKey: "senderState",
+	addressKey: "tx.from"
+}));
+runner.use(pipes.ExtractState({
+	from: "senders",
+	to: "signerStates",
+	status: "INVALID_SIGNER_STATE",
+	table: "account"
+}));
+runner.use(pipes.VerifyAccountMigration({
+	signerKey: "signerStates",
+	stateKey: "senderState",
+	addressKey: "tx.from"
+}));
+runner.use(pipes.ExtractState({
+	from: "itx.receiver",
+	to: "receiverState",
+	status: "OK",
+	table: "account"
+}));
+runner.use(pipes.VerifyAccountMigration({
+	stateKey: "receiverState",
+	addressKey: "itx.receiver"
+}));
+runner.use(pipes.VerifyBlocked({ stateKeys: ["signerStates", "receiverState"] }));
+runner.use(pipes.ExtractState({
+	from: "tokenFactoryState.owner",
+	to: "ownerState",
+	status: "INVALID_OWNER_STATE",
+	table: "account"
+}));
+runner.use(pipes.verifyTokenAccess({
+	statesKey: "tokenState",
+	listFieldKey: "minters",
+	accountKeys: ["senderState"],
+	errorMessage: "Account {address} is not allowed to burn token {tokenAddress}"
+}));
+runner.use((context, next) => {
+	const { inputs = [], tokenFactoryState } = context;
+	let amount = new BN("0");
+	for (const { tokensList } of inputs) {
+		const delta = tokensList.find((x) => x.address === tokenFactoryState.tokenAddress)?.value;
+		if (!delta) return next(new CustomError("INVALID_TX", "Invalid inputs"));
+		amount = amount.add(new BN(delta));
+	}
+	context.burnAmount = amount.toString();
+	return next();
+});
+runner.use(calc_reserve_default({
+	tokenFactoryKey: "tokenFactoryState",
+	tokenStateKey: "tokenState",
+	reserveKey: "reserveAmount",
+	feeKey: "reserveFee",
+	amountKey: "burnAmount",
+	direction: "burn"
+}), { shouldSkip: (ctx) => !ctx.tokenFactoryState?.curve });
+runner.use((context, next) => {
+	const { reserveAmount = "0", reserveFee } = context;
+	const { minReserve } = context.itx;
+	if (minReserve && new BN(reserveAmount).lt(new BN(minReserve).add(new BN(reserveFee || "0")))) return next(new CustomError("SLIPPAGE_EXCEEDED", `Burn token failed due to price movement. Expected minimum: ${fromUnitToToken(minReserve)}, actual: ${fromUnitToToken(reserveAmount)}. Try reducing your minReserve.`));
+	return next();
+}, { shouldSkip: (ctx) => !ctx.tokenFactoryState?.curve });
+runner.use(pipes.ExtractState({
+	from: "tokens",
+	to: "tokenStates",
+	status: "INVALID_TOKEN",
+	table: "token"
+}));
+runner.use(pipes.VerifyTokenBalance({
+	ownerKey: "signerStates",
+	conditionKey: "inputs"
+}));
+runner.use((context, next) => {
+	const { tokenFactoryState, burnAmount = "0", reserveAmount = "0" } = context;
+	if (new BN(tokenFactoryState.currentSupply).lt(new BN(burnAmount))) return next(new CustomError("INSUFFICIENT_FUND", "Token factory supply is not enough"));
+	if (new BN(tokenFactoryState.reserveBalance).lt(new BN(reserveAmount))) return next(new CustomError("INSUFFICIENT_FUND", "Token factory reserve balance is not enough"));
+	return next();
+});
+runner.use(ensure_gas_default((context) => {
+	const result = {
+		create: 0,
+		update: 2,
+		payment: 0
+	};
+	if (context.senderState) result.update += 1;
+	else result.create += 1;
+	if (context.tokenFactoryState?.curve) if (context.receiverState) result.update += 1;
+	else result.create += 1;
+	if (context.reserveFee) result.update += 1;
+	if (context.signerStates) result.update += context.signerStates.length;
+	return result;
+}));
+runner.use(ensure_cost_default({ attachSenderChanges: true }));
+runner.use(pipes.TakeStateSnapshot());
+runner.use(async (context, next) => {
+	const { tx: tx$1, senderState, receiverState, ownerState, statedb, senderChange, updateVaults, tokenFactoryState, tokenState, reserveAmount = "0", reserveFee, itx, inputs = [], signerStates = [], burnAmount = "0" } = context;
+	const { receiver } = itx;
+	const { reserveAddress, tokenAddress } = tokenFactoryState;
+	const accountUpdates = {};
+	const inputChanges = [];
+	inputs.forEach((input) => {
+		const { owner } = input;
+		const tokenChange = getListField(input, "tokens").find((item) => item.address === tokenAddress);
+		accountUpdates[owner] = applyTokenUpdates([tokenChange], signerStates.find((s) => s.address === owner), "sub");
+		inputChanges.push({
+			address: owner,
+			token: tokenAddress,
+			delta: new BN(tokenChange.value).neg().toString()
+		});
+	});
+	if (!accountUpdates[tx$1.from]) accountUpdates[tx$1.from] = senderState || {};
+	if (reserveFee && new BN(reserveFee).gt(new BN(0))) accountUpdates[ownerState.address] = applyTokenChange(accountUpdates[ownerState.address] || ownerState, {
+		token: reserveAddress,
+		delta: reserveFee
+	});
+	if (tokenFactoryState.curve) accountUpdates[receiver] = applyTokenChange(accountUpdates[receiver] || receiverState || {
+		address: receiver,
+		tokens: {}
+	}, {
+		token: reserveAddress,
+		delta: new BN(reserveAmount).sub(new BN(reserveFee || "0")).toString()
+	});
+	if (senderChange) accountUpdates[senderChange.address] = applyTokenChange(accountUpdates[senderChange.address] || senderState, senderChange);
+	const [newAccountStates, newTokenFactoryState, newTokenState] = await Promise.all([
+		Promise.all(Object.entries(accountUpdates).map(([address, updates]) => {
+			const state = [
+				senderState,
+				receiverState,
+				ownerState,
+				...signerStates
+			].find((x) => x?.address === address);
+			const actualUpdates = state ? pick(updates, ["tokens"]) : {
+				...updates,
+				address
+			};
+			if (address === tx$1.from) {
+				actualUpdates.pk = tx$1.pk;
+				actualUpdates.nonce = tx$1.nonce;
+			}
+			return statedb.account.updateOrCreate(state ?? null, account.updateOrCreate(state ?? null, actualUpdates, context), context);
+		})),
+		statedb.tokenFactory.update(tokenFactoryState.address, tokenFactory.update(tokenFactoryState, {
+			currentSupply: new BN(tokenFactoryState.currentSupply).sub(new BN(burnAmount)).toString(),
+			reserveBalance: new BN(tokenFactoryState.reserveBalance).sub(new BN(reserveAmount)).toString()
+		}, context), context),
+		statedb.token.update(tokenAddress, token.update(tokenState, { totalSupply: new BN(tokenState.totalSupply).sub(new BN(burnAmount)).toString() }), context)
+	]);
+	context.senderState = newAccountStates.find((x) => x.address === tx$1.from);
+	context.receiverState = newAccountStates.find((x) => x.address === receiver);
+	context.ownerState = newAccountStates.find((x) => x.address === ownerState.address) || ownerState;
+	context.signerStates = newAccountStates.filter((x) => signerStates.find((s) => s.address === x.address));
+	context.tokenFactoryState = newTokenFactoryState;
+	context.tokenState = newTokenState;
+	context.inputChanges = inputChanges;
+	if (updateVaults) await updateVaults();
+	next();
+}, { persistError: true });
+runner.use(pipes.VerifyStateDiff());
+var burn_default = runner;
+
+//#endregion
+export { burn_default as default };

package/esm/protocols/token-factory/create.d.mts

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

package/esm/protocols/token-factory/create.mjs

@@ -0,0 +1,254 @@
+import { applyTokenChange, decodeAnySafe, getDelegationRequirements } from "../../util.mjs";
+import ensure_cost_default from "../../pipes/ensure-cost.mjs";
+import ensure_gas_default from "../../pipes/ensure-gas.mjs";
+import verify_icon_default from "./pipes/verify-icon.mjs";
+import verify_ownership_default from "./pipes/verify-ownership.mjs";
+import verify_url_default from "./pipes/verify-url.mjs";
+import { Runner, pipes } from "@ocap/tx-pipeline";
+import { CustomError } from "@ocap/util/lib/error";
+import { toStakeAddress, toTokenAddress, toTokenFactoryAddress } from "@arcblock/did-util";
+import { account, delegation, stake, token, tokenFactory } from "@ocap/state";
+import { BN, fromTokenToUnit, fromUnitToToken } from "@ocap/util";
+import Debug from "debug";
+import { getListField } from "@ocap/util/lib/get-list-field";
+import cloneDeep from "lodash/cloneDeep.js";
+import { Joi } from "@arcblock/validator";
+import uniq from "lodash/uniq.js";
+import isEmpty from "lodash/isEmpty.js";
+
+//#region src/protocols/token-factory/create.ts
+const debug = Debug("@ocap/tx-protocols:create-token-factory");
+const runner = new Runner("create_token_factory");
+const isTest = process.env.NODE_ENV === "development" || process.env.NODE_ENV === "test" || process.env.CI;
+runner.use(pipes.VerifyMultiSig(0));
+const schema = Joi.object({
+	address: Joi.DID().prefix().role("ROLE_TOKEN_FACTORY").required(),
+	feeRate: Joi.number().min(0).max(2e3).required(),
+	curve: Joi.when("token.type", {
+		is: "CreditToken",
+		then: Joi.valid(null).optional().messages({ "any.only": "Should not provide curve for CreditToken" }),
+		otherwise: tokenFactory.curveSchema.required()
+	}),
+	reserveAddress: Joi.DID().prefix().role("ROLE_TOKEN").required(),
+	token: Joi.object({
+		name: Joi.string().min(1).max(32).required(),
+		description: Joi.string().min(16).max(128).required(),
+		symbol: Joi.string().min(2).max(6).uppercase().required(),
+		unit: Joi.string().min(1).max(6).lowercase().required(),
+		decimal: Joi.number().min(2).max(18).required(),
+		icon: Joi.string().optional().allow(null, ""),
+		maxTotalSupply: Joi.alternatives().try(Joi.BN().greater(0), Joi.string().valid("")).optional().allow(null),
+		website: Joi.string().uri({
+			scheme: isTest ? ["http", "https"] : ["https"],
+			allowRelative: false
+		}).max(256).optional().allow(null, ""),
+		metadata: Joi.any().required(),
+		spendersList: Joi.array().items(Joi.DID().prefix()).max(30).optional().allow(null).default(null),
+		mintersList: Joi.array().items(Joi.DID().prefix()).max(30).optional().allow(null).default(null),
+		type: Joi.string().valid("CreditToken", "BondingCurveToken").required()
+	}).required(),
+	data: 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 CustomError("INVALID_TX", `Invalid itx: ${error.message}`));
+	context.itx.curve = value.curve;
+	const itxToken = context.itx.token;
+	if (itxToken.metadata) {
+		const metadata = decodeAnySafe(itxToken.metadata ?? null);
+		const { error: metadataError, value: metadataValue } = token.metadataSchema.validate(metadata?.value);
+		if (metadataError) return next(new CustomError("INVALID_TX", `Invalid metadata: ${metadataError.message}`));
+		itxToken.metadata = {
+			...metadata,
+			value: metadataValue
+		};
+	}
+	const tokenWithLists = itxToken;
+	const spendersList = getListField(itxToken, "spenders");
+	itxToken.spenders = spendersList?.length ? uniq(spendersList) : null;
+	delete tokenWithLists.spendersList;
+	const mintersList = getListField(itxToken, "minters");
+	itxToken.minters = mintersList?.length ? uniq(mintersList) : null;
+	delete tokenWithLists.mintersList;
+	return next();
+});
+runner.use(pipes.VerifyInfo([
+	{
+		error: "INVALID_TOKEN",
+		message: "Token address is not valid",
+		fn: (ctx) => {
+			const itxToken = ctx.itx.token;
+			return toTokenAddress({
+				...itxToken,
+				address: ""
+			}) === itxToken.address;
+		}
+	},
+	{
+		error: "INVALID_TOKEN_FACTORY",
+		message: "Token factory address is not valid",
+		fn: (ctx) => {
+			const context = ctx;
+			const itx = cloneDeep(context.itx);
+			itx.data = decodeAnySafe(itx.data ?? null);
+			itx.address = "";
+			return toTokenFactoryAddress(itx) === context.itx.address;
+		}
+	},
+	{
+		error: "INVALID_RESERVE_ADDRESS",
+		message: "Reserve address is not valid",
+		fn: (ctx) => {
+			const context = ctx;
+			return context.itx.reserveAddress === context.config.token.address;
+		}
+	}
+]));
+runner.use(verify_icon_default());
+runner.use(verify_url_default({ urlKeys: ["itx.token.website", "itx.token.metadata.value.communityUrl"] }));
+runner.use(verify_ownership_default({ tokenKey: "itx.token" }));
+runner.use((context, next) => {
+	const { reservedSymbols = [] } = context.config;
+	const { symbol } = context.itx.token;
+	if (reservedSymbols.includes(symbol.toUpperCase())) return next(new CustomError("INVALID_SYMBOL", `Token symbol can not be ${symbol}`));
+	return next();
+});
+runner.use(pipes.ExtractState({
+	from: "itx.address",
+	to: "tokenFactoryState",
+	table: "tokenFactory",
+	status: "OK"
+}));
+runner.use(pipes.VerifyInfo([{
+	error: "DUPLICATE_TOKEN_FACTORY",
+	message: "Token factory address already exists on chain",
+	fn: (ctx) => {
+		return isEmpty(ctx.tokenFactoryState);
+	}
+}]));
+runner.use(pipes.ExtractState({
+	from: "itx.token.address",
+	to: "tokenState",
+	table: "token",
+	status: "OK"
+}));
+runner.use(pipes.VerifyInfo([{
+	error: "DUPLICATE_TOKEN",
+	message: "Token address already exists on chain",
+	fn: (ctx) => {
+		return isEmpty(ctx.tokenState);
+	}
+}]));
+runner.use(pipes.ExtractState({
+	from: "tx.from",
+	to: "senderState",
+	status: "INVALID_SENDER_STATE",
+	table: "account"
+}));
+runner.use(pipes.VerifyAccountMigration({
+	stateKey: "senderState",
+	addressKey: "tx.from"
+}));
+runner.use(pipes.VerifyBlocked({ stateKeys: ["senderState"] }));
+runner.use((context, next) => {
+	const { tx: tx$1, itx } = context;
+	const sender = tx$1.delegator || tx$1.from;
+	const receiver = context.config.token.address;
+	context.stakeAddress = toStakeAddress(sender, receiver, itx.token.symbol);
+	return next();
+});
+runner.use(pipes.ExtractState({
+	from: "stakeAddress",
+	to: "stakeState",
+	status: "INVALID_STAKE_STATE",
+	table: "stake"
+}));
+runner.use((context, next) => {
+	const { stakeState, config, itx } = context;
+	if (stakeState.revocable === false) return next(new CustomError("INVALID_STAKE_STATE", `Staking for token creating already locked: ${stakeState.address}`));
+	const actualStake = new BN(stakeState.tokens[config.token.address] || 0);
+	const requiredStake = fromTokenToUnit(itx.token.type === "CreditToken" ? config.transaction.txStake.createCreditToken : config.transaction.txStake.createToken, config.token.decimal);
+	if (actualStake.lt(requiredStake)) return next(new CustomError("INVALID_STAKE_STATE", `Insufficient stake amount: required ${fromUnitToToken(requiredStake, config.token.decimal)} ${config.token.symbol}`));
+	return next();
+});
+runner.use(pipes.ExtractState({
+	from: "tx.delegator",
+	to: "delegatorState",
+	status: "OK",
+	table: "account"
+}));
+runner.use(pipes.VerifyAccountMigration({
+	stateKey: "delegatorState",
+	addressKey: "tx.delegator"
+}));
+runner.use(pipes.VerifyDelegation({
+	type: "signature",
+	signerKey: "senderState",
+	delegatorKey: "delegatorState",
+	getRequirements: getDelegationRequirements
+}));
+runner.use(async function EnsureTokenSymbol(context, next) {
+	const itxToken = context.itx.token;
+	if (await context.statedb.token.existBySymbol(itxToken.symbol, context)) return next(new CustomError("DUPLICATE_SYMBOL", "Token symbol already exists"));
+	return next();
+}, { persistError: true });
+runner.use(ensure_gas_default((context) => {
+	const result = {
+		create: 2,
+		update: 2,
+		payment: 0
+	};
+	if (context.isDelegationChanged) result.update += 1;
+	return result;
+}));
+runner.use(ensure_cost_default({ attachSenderChanges: true }));
+runner.use(pipes.TakeStateSnapshot());
+runner.use(async (context, next) => {
+	const { tx: tx$1, itx, statedb, senderState, delegatorState, delegationState, senderChange, stakeState, stakeAddress, updateVaults, config } = context;
+	const data = decodeAnySafe(itx.data ?? null);
+	const owner = delegatorState ? delegatorState.address : senderState.address;
+	const itxToken = itx.token;
+	const { tokens: senderTokens = {} } = senderState;
+	const senderUpdates = senderChange ? applyTokenChange({ tokens: senderTokens }, senderChange) : { tokens: senderTokens };
+	const [newSenderState, newTokenState, newTokenFactoryState, newDelegationState, newStakeState] = await Promise.all([
+		statedb.account.update(senderState.address, account.update(senderState, {
+			nonce: tx$1.nonce,
+			pk: tx$1.pk,
+			...senderUpdates
+		}, context), context),
+		statedb.token.create(itxToken.address, token.create({
+			...cloneDeep(itxToken),
+			totalSupply: "0",
+			initialSupply: "0",
+			issuer: owner,
+			tokenFactoryAddress: itx.address
+		}, context), context),
+		statedb.tokenFactory.create(itx.address, tokenFactory.create({
+			...cloneDeep(itx),
+			owner,
+			tokenAddress: itxToken.address,
+			data
+		}, context), context),
+		context.isDelegationChanged ? statedb.delegation.update(delegationState.address, delegation.update(delegationState, {}, context), context) : delegationState,
+		statedb.stake.update(stakeAddress, stake.update(stakeState, {
+			revocable: false,
+			revokeWaitingPeriod: config.transaction.txStake.createTokenLockPeriod
+		}, context), context)
+	]);
+	if (updateVaults) await updateVaults();
+	context.senderState = newSenderState;
+	context.tokenState = newTokenState;
+	context.tokenFactoryState = newTokenFactoryState;
+	context.delegationState = newDelegationState;
+	context.stakeState = newStakeState;
+	debug("create token factory", newTokenFactoryState);
+	next();
+}, { persistError: true });
+runner.use(pipes.VerifyStateDiff());
+var create_default = runner;
+
+//#endregion
+export { create_default as default };

package/esm/protocols/token-factory/mint.d.mts

@@ -0,0 +1,15 @@
+//#region src/protocols/token-factory/mint.d.ts
+/** Token input type */
+interface TokenInput {
+  address: string;
+  value: string;
+}
+/** Multi-input type */
+interface MultiInput {
+  owner: string;
+  tokensList: TokenInput[];
+  assetsList: string[];
+}
+declare const runner: any;
+//#endregion
+export { MultiInput, TokenInput, runner as default };