@ocap/state 1.28.9 → 1.29.0

package/esm/states/token.mjs

@@ -0,0 +1,109 @@
+import { __exportAll } from "../_virtual/rolldown_runtime.mjs";
+import { create as create$1 } from "../contexts/state.mjs";
+import { toChecksumAddress } from "@arcblock/did/lib/type";
+import { BN, toAddress } from "@ocap/util";
+import pick from "lodash/pick.js";
+import { Joi, schemas } from "@arcblock/validator";
+import cloneDeep from "lodash/cloneDeep.js";
+
+//#region src/states/token.ts
+var token_exports = /* @__PURE__ */ __exportAll({
+	create: () => create,
+	metadataSchema: () => metadataSchema,
+	stateSchema: () => stateSchema,
+	update: () => update,
+	validate: () => validate
+});
+const isTest = process.env.NODE_ENV === "development" || process.env.NODE_ENV === "test" || process.env.CI;
+const metadataSchema = Joi.object({
+	communityUrl: Joi.string().uri({
+		scheme: ["https"],
+		allowRelative: false
+	}).max(256).optional().allow(null, ""),
+	issuer: Joi.string().max(64).required()
+}).options({
+	stripUnknown: true,
+	noDefaults: false
+});
+const stateSchema = Joi.object({
+	address: Joi.DID().prefix().role("ROLE_TOKEN").required(),
+	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, ""),
+	totalSupply: Joi.BN().min(0).required(),
+	initialSupply: Joi.BN().min(0).required(),
+	maxTotalSupply: Joi.alternatives().try(Joi.BN().greater(0), Joi.string().valid("")).optional().allow(null),
+	foreignToken: schemas.foreignToken.optional().allow(null),
+	issuer: Joi.DID().prefix().optional().allow(null, ""),
+	website: Joi.string().uri({
+		scheme: isTest ? ["http", "https"] : ["https"],
+		allowRelative: false
+	}).max(256).optional().allow(null, ""),
+	metadata: Joi.object({
+		type: Joi.string().valid("json").required(),
+		value: metadataSchema.optional()
+	}).optional().allow(null),
+	tokenFactoryAddress: Joi.DID().prefix().role("ROLE_TOKEN_FACTORY").optional().allow(null, ""),
+	spenders: Joi.array().items(Joi.DID().prefix()).max(30).optional().allow(null),
+	minters: Joi.array().items(Joi.DID().prefix()).max(30).optional().allow(null),
+	type: Joi.string().valid("Token", "CreditToken", "BondingCurveToken").optional().allow(null, ""),
+	context: schemas.context,
+	data: Joi.any().optional().allow(null)
+}).options({
+	stripUnknown: true,
+	noDefaults: false
+});
+const create = (attrs, context) => {
+	const token = {
+		context: create$1(context),
+		...pick(attrs, [
+			"name",
+			"description",
+			"symbol",
+			"unit",
+			"decimal",
+			"icon",
+			"totalSupply",
+			"initialSupply",
+			"maxTotalSupply",
+			"address",
+			"foreignToken",
+			"data",
+			"issuer",
+			"website",
+			"metadata",
+			"tokenFactoryAddress",
+			"spenders",
+			"minters",
+			"type"
+		])
+	};
+	if (!token.data) token.data = null;
+	if (!token.metadata) token.metadata = null;
+	if (!token.foreignToken) token.foreignToken = null;
+	else token.foreignToken.contractAddress = toChecksumAddress(token.foreignToken.contractAddress);
+	token.address = toAddress(token.address);
+	return validate(token);
+};
+const update = (state, attrs) => validate({
+	...state,
+	...pick(attrs, [
+		"totalSupply",
+		"metadata",
+		"icon",
+		"website"
+	])
+});
+const validate = (state) => {
+	if (state.maxTotalSupply && new BN(state.maxTotalSupply).lt(new BN(state.totalSupply))) throw new Error("maxTotalSupply must be greater than or equal to totalSupply");
+	const data = cloneDeep(state);
+	const { value, error } = stateSchema.validate(data);
+	if (error) throw new Error(`Invalid token state: ${error.message}`);
+	return value;
+};
+
+//#endregion
+export { create, metadataSchema, stateSchema, token_exports, update, validate };

package/esm/states/tx.d.mts

@@ -0,0 +1,233 @@
+declare namespace tx_d_exports {
+  export { FORGE_TOKEN_HOLDER, ItxJson, Receipt, ReceiptChange, TokenInput, TxContext, TxData, TxInput, TxOutput, TxResult, attachPaidTxGas, create, eachReceipts, getTxReceipts, getTxReceiver, getTxSender, groupReceiptTokenChanges, mergeTxReceipts, update, verifyTxReceipts };
+}
+declare const FORGE_TOKEN_HOLDER = "zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz";
+interface ReceiptChange {
+  target: string;
+  action: string;
+  value: string;
+}
+interface Receipt {
+  address: string;
+  changes: ReceiptChange[];
+}
+interface TokenInput {
+  address: string;
+  value: string;
+}
+interface TxInput {
+  owner: string;
+  tokens?: TokenInput[];
+  assets?: string[];
+}
+interface TxOutput {
+  owner: string;
+  tokens?: TokenInput[];
+  assets?: string[];
+}
+interface ItxJson {
+  _type?: string;
+  to?: string;
+  owner?: string;
+  address?: string;
+  receiver?: string;
+  value?: string;
+  tokens?: TokenInput[];
+  assets?: string[];
+  sender?: {
+    value?: string;
+    tokens?: TokenInput[];
+    assets?: string[];
+  };
+  inputs?: TxInput[];
+  outputs?: TxOutput[];
+  initialSupply?: string;
+  amount?: string;
+  issuer?: string;
+  withdraw_tx_hash?: string;
+  [key: string]: unknown;
+}
+interface TxData {
+  from: string;
+  delegator?: string;
+  itxJson: ItxJson;
+  chainId?: string;
+  nonce?: number;
+  serviceFee?: string;
+  pk?: Uint8Array;
+  signature?: Uint8Array;
+  signatures?: unknown[];
+  itx?: {
+    typeUrl: string;
+    value?: Uint8Array;
+  };
+  gasPaid?: string;
+  gasFee?: string;
+}
+interface TxContext {
+  txHash?: string;
+  txTime?: string;
+  tx?: TxData;
+  totalGas?: unknown;
+  itxExtras?: Record<string, unknown>;
+  extra?: {
+    txExtra?: unknown;
+  };
+  senderState?: {
+    address?: string;
+    tokens?: Record<string, string>;
+  };
+  receiverState?: {
+    address?: string;
+  };
+  fromState?: {
+    address?: string;
+    tokens?: Record<string, string>;
+  };
+  factoryState?: {
+    input?: {
+      value?: string;
+      tokens?: TokenInput[];
+    };
+  };
+  ownerAddress?: string;
+  config?: {
+    token?: {
+      address?: string;
+      decimal?: number;
+    };
+    vaults?: {
+      txGas?: string[];
+    };
+  };
+  time?: string;
+  receipts?: Receipt[];
+  gasPaid?: boolean;
+  outputs?: TxOutput[];
+  withdrawTx?: {
+    hash?: string;
+    tx?: TxData;
+    receipts?: Receipt[];
+  };
+  updatedAccounts?: Array<{
+    address?: string;
+    delta?: string;
+    token?: string;
+    action?: string;
+  }>;
+  inputChanges?: Array<{
+    address: string;
+    delta: string;
+  }>;
+  tokenFactoryState?: {
+    reserveAddress: string;
+    tokenAddress: string;
+    owner: string;
+  };
+  reserveFee?: string;
+  reserveAmount?: string;
+  [key: string]: unknown;
+}
+interface TxResult {
+  code: string;
+  hash?: string;
+  height: number;
+  index: number;
+  time?: string;
+  sender: string;
+  receiver: string;
+  type: string;
+  tx: {
+    chainId?: string;
+    delegator?: string;
+    from?: string;
+    nonce?: number;
+    serviceFee: string;
+    gasFee: string;
+    gasPaid?: string;
+    pk?: string;
+    signature?: string;
+    signatures?: unknown[];
+    itx?: {
+      __typename: string;
+    };
+    itxJson?: Record<string, unknown>;
+    extra?: unknown;
+  };
+  receipts?: Receipt[];
+  receiptsVerified?: boolean;
+  finalized?: boolean;
+}
+type EachReceiptsCallback = (address: string, change: ReceiptChange) => unknown;
+declare function eachReceipts(receipts: Receipt[] | undefined, callback: EachReceiptsCallback): unknown[];
+declare function groupReceiptTokenChanges(receipts: Receipt[] | undefined): Record<string, Record<string, string>>;
+interface GetTxReceiverArgs {
+  tx?: TxData;
+  itx?: ItxJson;
+  typeUrl: string;
+}
+declare const getTxReceiver: ({
+  tx,
+  itx,
+  typeUrl
+}: GetTxReceiverArgs) => string;
+interface GetTxSenderArgs {
+  tx: TxData;
+  itx?: ItxJson;
+  typeUrl: string;
+}
+declare const getTxSender: ({
+  tx,
+  typeUrl
+}: GetTxSenderArgs) => string;
+declare const mergeTxReceipts: (receipts: Receipt[]) => Receipt[];
+/**
+ * Verify transaction receipts
+ */
+declare const verifyTxReceipts: (receipts: Receipt[], typeUrl: string, ctx?: TxContext) => boolean;
+interface GetTxReceiptsInput {
+  tx: TxData;
+  code: string;
+}
+/**
+ * Create transaction receipts, each receipt has following properties:
+ *
+ * - address: the entity did that changed
+ * - changes:
+ *   - target: the target address that was changed, can be token address, asset address
+ *   - action: why the target has changed, such as consume, burn and transfer
+ *   - value: the amount that has changed
+ */
+declare const getTxReceipts: ({
+  tx,
+  code
+}: GetTxReceiptsInput, ctx?: TxContext) => Receipt[];
+interface CreateContext extends TxContext {
+  txHash: string;
+  txTime: string;
+  tx: {
+    chainId?: string;
+    delegator?: string;
+    from: string;
+    nonce?: number;
+    serviceFee?: string;
+    pk?: Uint8Array;
+    signature?: Uint8Array;
+    signatures?: unknown[];
+    itx: {
+      typeUrl: string;
+      value?: Uint8Array;
+    };
+    itxJson: ItxJson;
+  };
+  totalGas?: unknown;
+  itxExtras?: Record<string, unknown>;
+  extra?: {
+    txExtra?: unknown;
+  };
+}
+declare const create: (context: CreateContext, code?: string, verifyReceipts?: boolean) => TxResult;
+declare const attachPaidTxGas: (tx: TxResult) => TxResult;
+declare const update: (state: TxResult, updates: Partial<TxResult>) => TxResult;
+//#endregion
+export { FORGE_TOKEN_HOLDER, ItxJson, Receipt, ReceiptChange, TokenInput, TxContext, TxData, TxInput, TxOutput, TxResult, attachPaidTxGas, create, eachReceipts, getTxReceipts, getTxReceiver, getTxSender, groupReceiptTokenChanges, mergeTxReceipts, tx_d_exports, update, verifyTxReceipts };