@ocap/state 1.28.9 → 1.29.0

package/lib/states/tx.d.cts

@@ -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 };

package/lib/util.cjs

@@ -0,0 +1,19 @@
+
+//#region src/util.ts
+function nullify(obj) {
+	if (typeof obj === "undefined") return null;
+	if (typeof obj === "object" && obj !== null) if (Array.isArray(obj)) obj.forEach((item, index) => {
+		obj[index] = nullify(item);
+	});
+	else {
+		const record = obj;
+		for (const key in record) if (Object.prototype.hasOwnProperty.call(record, key)) {
+			if (typeof record[key] === "undefined") record[key] = null;
+			else if (typeof record[key] === "object") record[key] = nullify(record[key]);
+		}
+	}
+	return obj;
+}
+
+//#endregion
+exports.nullify = nullify;

package/lib/util.d.cts

@@ -0,0 +1,6 @@
+//#region src/util.d.ts
+type NullifyInput = unknown;
+type NullifyOutput<T> = T extends undefined ? null : T;
+declare function nullify<T extends NullifyInput>(obj: T): NullifyOutput<T>;
+//#endregion
+export { nullify };

package/package.json

@@ -3,31 +3,63 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.28.9",
-  "description": "",
-  "main": "lib/index.js",
+  "version": "1.29.0",
+  "description": "State management utilities for OCAP blockchain",
+  "type": "module",
+  "main": "./lib/index.cjs",
+  "module": "./esm/index.mjs",
+  "types": "./esm/index.d.mts",
+  "exports": {
+    ".": {
+      "types": "./esm/index.d.mts",
+      "import": "./esm/index.mjs",
+      "default": "./lib/index.cjs"
+    },
+    "./lib/*.js": {
+      "types": "./esm/*.d.mts",
+      "import": "./esm/*.mjs",
+      "default": "./lib/*.cjs"
+    },
+    "./lib/*": {
+      "types": "./esm/*.d.mts",
+      "import": "./esm/*.mjs",
+      "default": "./lib/*.cjs"
+    }
+  },
   "files": [
-    "lib"
+    "lib",
+    "esm"
   ],
   "scripts": {
+    "build": "tsdown",
+    "prebuild": "rm -rf lib esm",
     "lint": "biome check",
     "lint:fix": "biome check --write",
     "test": "bun test",
     "coverage": "bun test --coverage"
   },
   "dependencies": {
-    "@arcblock/did": "1.28.9",
-    "@arcblock/validator": "1.28.9",
-    "@ocap/contract": "1.28.9",
-    "@ocap/mcrypto": "1.28.9",
-    "@ocap/message": "1.28.9",
-    "@ocap/util": "1.28.9",
-    "@ocap/wallet": "1.28.9",
+    "@arcblock/did": "1.29.0",
+    "@arcblock/validator": "1.29.0",
+    "@ocap/contract": "1.29.0",
+    "@ocap/mcrypto": "1.29.0",
+    "@ocap/message": "1.29.0",
+    "@ocap/types": "1.29.0",
+    "@ocap/util": "1.29.0",
+    "@ocap/wallet": "1.29.0",
     "bloom-filters": "^1.3.9",
-    "lodash": "^4.17.21"
+    "lodash": "^4.17.23"
+  },
+  "devDependencies": {
+    "@types/lodash": "^4.17.16"
   },
-  "devDependencies": {},
-  "keywords": [],
+  "keywords": [
+    "blockchain",
+    "arcblock",
+    "sdk",
+    "nodejs",
+    "state"
+  ],
   "author": "wangshijun <wangshijun2010@gmail.com> (http://github.com/wangshijun)",
   "license": "MIT",
   "gitHead": "e5764f753181ed6a7c615cd4fc6682aacf0cb7cd"

package/lib/contexts/state.js

@@ -1,19 +0,0 @@
-// StateContext utils for account/asset/delegate etc.
-
-const create = ({ txHash, txTime }) => ({
-  genesisTime: txTime || '',
-  genesisTx: txHash || '',
-  renaissanceTime: txTime || '',
-  renaissanceTx: txHash || '',
-});
-
-const update = (context, { txHash, txTime }) => ({
-  ...context,
-  // NOTE: for historical reasons, some account state does not have genesisTime
-  genesisTime: context.genesisTime || '2020-01-15T00:00:00.000Z',
-  genesisTx: context.genesisTx || '',
-  renaissanceTime: txTime || '',
-  renaissanceTx: txHash || '',
-});
-
-module.exports = { create, update };

package/lib/index.js

@@ -1,63 +0,0 @@
-const chain = require('./states/chain');
-const account = require('./states/account');
-const asset = require('./states/asset');
-const delegation = require('./states/delegation');
-const tx = require('./states/tx');
-const factory = require('./states/factory');
-const token = require('./states/token');
-const stake = require('./states/stake');
-const rollup = require('./states/rollup');
-const rollupBlock = require('./states/rollup-block');
-const evidence = require('./states/evidence');
-const tokenFactory = require('./states/token-factory');
-
-const Blacklist = require('./states/blacklist');
-
-module.exports = {
-  chain,
-  account,
-  asset,
-  factory,
-  delegation,
-  tx,
-  token,
-  stake,
-  rollup,
-  rollupBlock,
-  evidence,
-  tokenFactory,
-
-  // indexes of the statedb to speed up reading
-  indexes: [
-    'account',
-    'asset',
-    'delegation',
-    'tx',
-    'factory',
-    'token',
-    'stake',
-    'rollup',
-    'rollupBlock',
-    'rollupValidator',
-    'tokenDistribution',
-    'tokenFactory',
-  ],
-
-  tables: [
-    'chain',
-    'account',
-    'asset',
-    'delegation',
-    'tx',
-    'factory',
-    'token',
-    'stake',
-    'rollup',
-    'rollupBlock',
-    'evidence', // a simple key-value store
-    'balance',
-    'tokenFactory',
-  ],
-
-  Blacklist,
-};

package/lib/states/account.js

@@ -1,95 +0,0 @@
-const pick = require('lodash/pick');
-const uniq = require('lodash/uniq');
-const flatten = require('lodash/flatten');
-const { CustomError: Error } = require('@ocap/util/lib/error');
-const { isFromPublicKey } = require('@arcblock/did');
-const { isEthereumDid, toChecksumAddress } = require('@arcblock/did/lib/type');
-const { toBase58, toAddress, BN } = require('@ocap/util');
-
-const { Joi, schemas } = require('@arcblock/validator');
-const { create: createStateContext, update: updateStateContext } = require('../contexts/state');
-
-const schema = Joi.object({
-  address: Joi.DID().prefix().required(),
-  pk: Joi.string().allow(null).allow(''),
-  issuer: Joi.DID().prefix().allow(null).allow(''),
-  moniker: Joi.string()
-    .regex(/^[a-zA-Z0-9][-a-zA-Z0-9_]{2,128}$/)
-    .allow(''),
-  nonce: Joi.number().min(0).default(0),
-  tokens: Joi.object().pattern(Joi.DID().prefix().role('ROLE_TOKEN'), Joi.BN().min(0)).default({}),
-  migratedTo: Joi.array().items(Joi.DID().prefix()).default([]),
-  migratedFrom: Joi.array().items(Joi.DID().prefix()).default([]),
-  context: schemas.context,
-  data: Joi.any().optional().allow(null),
-}).options({ stripUnknown: true, noDefaults: false });
-
-const create = (attrs, context) => {
-  const account = {
-    nonce: 0,
-    migratedTo: uniq([].concat(attrs.migratedTo || [])),
-    migratedFrom: [],
-    tokens: {},
-    context: createStateContext(context),
-    ...pick(attrs, ['address', 'pk', 'issuer', 'moniker', 'data', 'nonce', 'migratedFrom', 'tokens']),
-  };
-
-  account.address = toAddress(ensureChecksumAddress(account.address));
-
-  if (!account.moniker) {
-    account.moniker = [account.address.slice(0, 6), account.address.slice(-5)].join('-');
-  }
-
-  return validate(account);
-};
-
-const update = (state, attrs, context) => {
-  if (attrs.nonce && new BN(attrs.nonce).eq(new BN(state.nonce))) {
-    throw new Error('INVALID_NONCE', 'nonce must be greater in newer transactions');
-  }
-
-  // ensure we are updating the correct pk
-  if (attrs.pk && isFromPublicKey(state.address, attrs.pk) === false) {
-    delete attrs.pk;
-  }
-
-  const account = {
-    ...state,
-    ...pick(attrs, ['moniker', 'data', 'migratedTo', 'nonce', 'tokens', 'pk']),
-    migratedTo: uniq(flatten(attrs.migratedTo ? [attrs.migratedTo].concat(state.migratedTo) : state.migratedTo)),
-    context: updateStateContext(state.context, context),
-  };
-
-  return validate(account);
-};
-
-const updateOrCreate = (state, attrs, context) => {
-  if (state) {
-    return update(state, attrs, context);
-  }
-
-  return create(attrs, context);
-};
-
-const validate = (state) => {
-  // ensure we have correct pk
-  if (state.pk && typeof state.pk !== 'string') {
-    state.pk = toBase58(state.pk);
-  }
-
-  const { value, error } = schema.validate(state);
-  if (error) {
-    throw new Error('INVALID_ACCOUNT', `Invalid account: ${error.details.map((x) => x.message).join(', ')}`);
-  }
-
-  if (!value.data) {
-    value.data = null;
-  }
-
-  return value;
-};
-
-const isMigrated = (state) => (state.migratedTo || []).length > 0;
-const ensureChecksumAddress = (address) => (isEthereumDid(address) ? toChecksumAddress(address) : address);
-
-module.exports = { create, update, updateOrCreate, validate, isMigrated, ensureChecksumAddress, schema };

package/lib/states/asset.js

@@ -1,91 +0,0 @@
-const pick = require('lodash/pick');
-const { Joi, schemas } = require('@arcblock/validator');
-const { CustomError: Error } = require('@ocap/util/lib/error');
-const { toAddress } = require('@ocap/util');
-
-const { create: createStateContext, update: updateStateContext } = require('../contexts/state');
-
-const schema = Joi.object({
-  ...schemas.assetProps,
-  owner: Joi.DID().prefix().required(),
-  consumedTime: Joi.date().iso().raw().allow(''),
-  context: schemas.context,
-}).options({
-  stripUnknown: true,
-  noDefaults: false,
-});
-
-const create = (attrs, context) => {
-  const asset = {
-    consumedTime: '',
-    issuer: '',
-    parent: '',
-    readonly: false,
-    transferrable: true,
-    ttl: 0, // means unlimited
-    tags: [],
-    context: createStateContext(context),
-    ...pick(attrs, [
-      'address',
-      'owner',
-      'issuer',
-      'moniker',
-      'parent',
-      'data',
-      'readonly',
-      'transferrable',
-      'ttl',
-      'endpoint',
-      'display',
-      'tags',
-    ]),
-  };
-
-  if (asset.tags === null) {
-    asset.tags = [];
-  }
-
-  asset.address = toAddress(asset.address);
-
-  return validate(asset);
-};
-
-const update = (state, attrs, context) => {
-  const asset = {
-    ...state,
-    ...pick(attrs, ['moniker', 'data', 'owner', 'consumedTime']),
-    context: updateStateContext(state.context, context),
-  };
-
-  if (asset.tags === null) {
-    asset.tags = [];
-  }
-
-  if (!asset.consumedTime) {
-    asset.consumedTime = '';
-  }
-
-  return validate(asset);
-};
-
-const validate = (state) => {
-  const { value, error } = schema.validate(state);
-  if (error) {
-    throw new Error('INVALID_ASSET', `Invalid asset: ${error.details.map((x) => x.message).join(', ')}`);
-  }
-
-  ['endpoint', 'display'].forEach((key) => {
-    if (!value[key]) {
-      delete value[key];
-    }
-  });
-
-  return value;
-};
-
-module.exports = {
-  create,
-  update,
-  validate,
-  schema: schemas.assetSchema,
-};