@ocap/statedb-memory 1.28.8 → 1.29.0

package/lib/db.d.cts

@@ -0,0 +1,31 @@
+import { StateDB } from "@ocap/statedb";
+import { IAccountState, IAssetFactoryState, IAssetState, IBalanceTable, IChainState, IDelegateState, IEvidenceState, IRollupBlock, IRollupTable, IStakeState, IStateTable, ITokenFactoryState, ITokenTable, ITxState } from "@ocap/types";
+import Loki from "lokijs";
+
+//#region src/db.d.ts
+
+/**
+ * 内存 StateDB 实现
+ * 使用 LokiJS 作为内存存储引擎
+ */
+declare class MemoryStateDB extends StateDB {
+  name: string;
+  version: string;
+  db: Loki;
+  balance: IBalanceTable;
+  account: IStateTable<IAccountState>;
+  factory: IStateTable<IAssetFactoryState>;
+  stake: IStateTable<IStakeState>;
+  asset: IStateTable<IAssetState>;
+  delegation: IStateTable<IDelegateState>;
+  tx: IStateTable<ITxState>;
+  token: ITokenTable;
+  chain: IStateTable<IChainState>;
+  rollup: IRollupTable;
+  rollupBlock: IStateTable<IRollupBlock>;
+  evidence: IStateTable<IEvidenceState>;
+  tokenFactory: IStateTable<ITokenFactoryState>;
+  constructor();
+}
+//#endregion
+export { MemoryStateDB as default };

package/lib/index.cjs

@@ -0,0 +1,4 @@
+Object.defineProperty(exports, '__esModule', { value: true });
+const require_db = require('./db.cjs');
+
+exports.default = require_db.default;

package/lib/index.d.cts

@@ -0,0 +1,2 @@
+import MemoryStateDB from "./db.cjs";
+export { MemoryStateDB as default };

package/lib/package.cjs

@@ -0,0 +1,81 @@
+
+//#region package.json
+var name = "@ocap/statedb-memory";
+var package_default = {
+	name,
+	description: "OCAP statedb adapter that uses memory as backend statedb, just for test purpose",
+	version: "1.20.2",
+	author: "wangshijun <shijun@arcblock.io> (https://www.arcblock.io)",
+	bugs: {
+		"url": "https://github.com/ArcBlock/blockchain/issues",
+		"email": "shijun@arcblock.io"
+	},
+	publishConfig: { "access": "public" },
+	contributors: ["wangshijun <shijun@arcblock.io> (https://www.arcblock.io)"],
+	devDependencies: { "@types/lokijs": "^1.5.14" },
+	homepage: "https://github.com/ArcBlock/blockchain/tree/master/statedb/memory",
+	keywords: [
+		"ocap",
+		"statedb",
+		"memory"
+	],
+	license: "Apache-2.0",
+	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", "esm"],
+	repository: {
+		"type": "git",
+		"url": "https://github.com/ArcBlock/blockchain/tree/master/statedb/memory"
+	},
+	scripts: {
+		"build": "tsdown",
+		"prebuild": "rm -rf lib esm",
+		"lint": "biome check",
+		"lint:fix": "biome check --write",
+		"test": "bun test",
+		"coverage": "npm run test -- --coverage"
+	},
+	gitHead: "87990c8b5e215107fc587c1ced0d6b3e2cd2483e",
+	dependencies: {
+		"@ocap/state": "workspace:*",
+		"@ocap/statedb": "workspace:*",
+		"@ocap/types": "workspace:*",
+		"@ocap/util": "workspace:*",
+		"debug": "^4.4.3",
+		"lodash": "^4.17.23",
+		"lokijs": "^1.5.12"
+	}
+};
+
+//#endregion
+Object.defineProperty(exports, 'default', {
+  enumerable: true,
+  get: function () {
+    return package_default;
+  }
+});
+Object.defineProperty(exports, 'name', {
+  enumerable: true,
+  get: function () {
+    return name;
+  }
+});

package/lib/table/account.cjs

@@ -0,0 +1,29 @@
+Object.defineProperty(exports, '__esModule', { value: true });
+const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
+const require_table_base = require('./base.cjs');
+let _ocap_state_lib_states_account = require("@ocap/state/lib/states/account");
+
+//#region src/table/account.ts
+/**
+* Account 表
+* 扩展基础表，增加账户迁移追踪功能
+*/
+var AccountStateDB = class extends require_table_base.default {
+	async _get(address, context = {}) {
+		const { traceMigration = true, ...restContext } = context;
+		const current = await super._get((0, _ocap_state_lib_states_account.ensureChecksumAddress)(address), restContext);
+		if (current && traceMigration && Array.isArray(current.migratedTo) && current.migratedTo.length) return this._get(current.migratedTo[0], context);
+		return current;
+	}
+	_create(key, attrs = {}, context) {
+		const address = (0, _ocap_state_lib_states_account.ensureChecksumAddress)(key);
+		return super._create(address, {
+			...attrs,
+			[this.uniqIndex]: address
+		}, context);
+	}
+};
+var account_default = AccountStateDB;
+
+//#endregion
+exports.default = account_default;

package/lib/table/account.d.cts

@@ -0,0 +1,17 @@
+import MemoryTable from "./base.cjs";
+import { IAccountState, IOperationContext } from "@ocap/types";
+
+//#region src/table/account.d.ts
+interface AccountOperationContext extends IOperationContext {
+  traceMigration?: boolean;
+}
+/**
+ * Account 表
+ * 扩展基础表，增加账户迁移追踪功能
+ */
+declare class AccountStateDB extends MemoryTable<IAccountState> {
+  _get(address: string, context?: AccountOperationContext): Promise<IAccountState | null>;
+  _create(key: string, attrs?: Partial<IAccountState>, context?: IOperationContext): Promise<IAccountState>;
+}
+//#endregion
+export { AccountStateDB as default };

package/lib/table/balance.cjs

@@ -0,0 +1,45 @@
+Object.defineProperty(exports, '__esModule', { value: true });
+const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
+const require_table_base = require('./base.cjs');
+let _ocap_state_lib_states_account = require("@ocap/state/lib/states/account");
+
+//#region src/table/balance.ts
+/**
+* Balance 表
+* 扩展基础表，增加余额管理功能
+*/
+var BalanceTable = class extends require_table_base.default {
+	async getBalance(address, _context) {
+		return (await this.collection.find({ address: (0, _ocap_state_lib_states_account.ensureChecksumAddress)(address) }) || []).reduce((acc, token) => {
+			acc[token.tokenAddress] = token.balance;
+			return acc;
+		}, {});
+	}
+	async updateBalance({ address, tokens, context = {} }, ctx) {
+		if (!Object.keys(tokens).length) return {};
+		const tokenBalances = await this.getBalance(address);
+		const updatedTokens = Object.keys(tokens).filter((token) => tokenBalances[token] && tokenBalances[token] !== "0" || tokens[token] && tokens[token] !== "0").filter((token) => tokenBalances[token] !== tokens[token]);
+		await Promise.all(updatedTokens.map(async (token) => {
+			const key = {
+				address,
+				tokenAddress: token
+			};
+			if (tokenBalances[token]) await this.update(key, {
+				...key,
+				balance: tokens[token],
+				context
+			}, ctx);
+			else await this.create(key, {
+				...key,
+				balance: tokens[token],
+				context
+			}, ctx);
+			tokenBalances[token] = tokens[token];
+		}));
+		return tokens;
+	}
+};
+var balance_default = BalanceTable;
+
+//#endregion
+exports.default = balance_default;

package/lib/table/balance.d.cts

@@ -0,0 +1,23 @@
+import MemoryTable from "./base.cjs";
+import { IBalanceState, IOperationContext } from "@ocap/types";
+
+//#region src/table/balance.d.ts
+
+/**
+ * Balance 表
+ * 扩展基础表，增加余额管理功能
+ */
+declare class BalanceTable extends MemoryTable<IBalanceState> {
+  getBalance(address: string, _context?: IOperationContext): Promise<Record<string, string>>;
+  updateBalance({
+    address,
+    tokens,
+    context
+  }: {
+    address: string;
+    tokens: Record<string, string>;
+    context?: unknown;
+  }, ctx?: IOperationContext): Promise<Record<string, string>>;
+}
+//#endregion
+export { BalanceTable as default };

package/lib/table/base.cjs

@@ -0,0 +1,98 @@
+Object.defineProperty(exports, '__esModule', { value: true });
+const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
+const require_package = require('../package.cjs');
+let _ocap_statedb = require("@ocap/statedb");
+let debug = require("debug");
+debug = require_rolldown_runtime.__toESM(debug);
+let lodash_omit = require("lodash/omit");
+lodash_omit = require_rolldown_runtime.__toESM(lodash_omit);
+
+//#region src/table/base.ts
+const debug$1 = (0, debug.default)(require_package.name);
+/**
+* 内存表基类
+* 使用 LokiJS Collection 作为底层存储
+*/
+var MemoryTable = class MemoryTable extends _ocap_statedb.StateDBTable {
+	constructor({ name: name$1, uniqIndex, balanceTable, syncBalance = false, db }) {
+		super(uniqIndex);
+		this.name = name$1;
+		this.balanceTable = balanceTable;
+		this.syncBalance = syncBalance;
+		if (this.syncBalance && !this.balanceTable) throw new Error("balanceTable is required when syncBalance is true");
+		if (!db) throw new Error("db is required for MemoryTable");
+		this.collection = db.addCollection(name$1, {
+			unique: [this.primaryKey],
+			clone: true
+		});
+		this.markReady();
+	}
+	async _create(key, attrs = {}, _context) {
+		const id = this.generatePrimaryKey(key);
+		if (await MemoryTable.prototype._get.call(this, id)) throw new Error(`${this.name} already exists: ${key}`);
+		debug$1(`insert ${this.name}`, attrs);
+		const insertAttrs = { ...attrs };
+		if (this.syncBalance) delete insertAttrs.tokens;
+		const result = await this.collection.insert({
+			[this.primaryKey]: id,
+			...insertAttrs
+		});
+		if (this.syncBalance && attrs.tokens) {
+			debug$1(`update balance for ${this.name}`, attrs);
+			result.tokens = await this.balanceTable.updateBalance({
+				address: attrs.address,
+				tokens: attrs.tokens,
+				context: attrs.context
+			});
+		}
+		return result;
+	}
+	async _get(key, _context) {
+		if (!key) return null;
+		const id = this.generatePrimaryKey(key);
+		const result = await this.collection.by(this.primaryKey, id) ?? null;
+		if (result && this.syncBalance) {
+			const balance = await this.balanceTable.getBalance(result.address);
+			result.tokens = {
+				...result.tokens || {},
+				...balance
+			};
+		}
+		return result;
+	}
+	_history(_key, _context) {
+		return [];
+	}
+	async _update(key, updates, _context) {
+		const id = this.generatePrimaryKey(key);
+		const doc = await MemoryTable.prototype._get.call(this, id);
+		if (!doc) throw new Error(`${this.name} does not exists: ${key}`);
+		Object.assign(doc, updates);
+		const updateAttrs = { ...doc };
+		if (this.syncBalance) delete updateAttrs.tokens;
+		await this.collection.update(updateAttrs);
+		if (this.syncBalance && doc.tokens) {
+			debug$1(`update balance for ${this.name}`, doc);
+			doc.tokens = await this.balanceTable.updateBalance({
+				address: doc.address,
+				tokens: doc.tokens,
+				context: doc.context
+			});
+		}
+		return doc;
+	}
+	updateOrCreate(exist, state, ctx) {
+		const id = this.generatePrimaryKey(state);
+		const attrs = (0, lodash_omit.default)(state, this.uniqIndex ?? []);
+		if (!id) throw new Error("Cannot update or create without uniq index");
+		if (exist) return this.update(id, attrs, ctx);
+		return this.create(id, attrs, ctx);
+	}
+	_reset(_context) {
+		this.collection.removeWhere({});
+	}
+};
+var base_default = MemoryTable;
+
+//#endregion
+exports.default = base_default;

package/lib/table/base.d.cts

@@ -0,0 +1,37 @@
+import { StateDBTable } from "@ocap/statedb";
+import { IBalanceTable, IOperationContext } from "@ocap/types";
+import Loki from "lokijs";
+
+//#region src/table/base.d.ts
+interface TableOptions {
+  name: string;
+  uniqIndex: string | string[];
+  syncBalance?: boolean;
+  balanceTable?: IBalanceTable;
+  db: Loki;
+}
+/**
+ * 内存表基类
+ * 使用 LokiJS Collection 作为底层存储
+ */
+declare class MemoryTable<T = unknown> extends StateDBTable<T> {
+  name: string;
+  balanceTable?: IBalanceTable;
+  syncBalance: boolean;
+  collection: Collection<LokiObj & Record<string, unknown>>;
+  constructor({
+    name,
+    uniqIndex,
+    balanceTable,
+    syncBalance,
+    db
+  }: TableOptions);
+  _create(key: string | Record<string, unknown>, attrs?: Partial<T>, _context?: IOperationContext): Promise<T>;
+  _get(key: string | Record<string, unknown>, _context?: IOperationContext): Promise<T | null>;
+  _history(_key?: string, _context?: IOperationContext): T[];
+  _update(key: string | Record<string, unknown>, updates: Partial<T>, _context?: IOperationContext): Promise<T>;
+  updateOrCreate(exist: unknown, state: Partial<T>, ctx?: IOperationContext): Promise<T>;
+  _reset(_context?: IOperationContext): void;
+}
+//#endregion
+export { MemoryTable as default };

package/lib/table/rollup.cjs

@@ -0,0 +1,21 @@
+Object.defineProperty(exports, '__esModule', { value: true });
+const require_table_base = require('./base.cjs');
+
+//#region src/table/rollup.ts
+/**
+* Rollup 表
+* 扩展基础表，增加按代币查询功能
+*/
+var RollupTable = class extends require_table_base.default {
+	async existByToken(token) {
+		if (!token) return false;
+		return this.collection.count({
+			tokenAddress: token,
+			paused: false
+		}) > 0;
+	}
+};
+var rollup_default = RollupTable;
+
+//#endregion
+exports.default = rollup_default;

package/lib/table/rollup.d.cts

@@ -0,0 +1,14 @@
+import MemoryTable from "./base.cjs";
+import { IRollupState } from "@ocap/types";
+
+//#region src/table/rollup.d.ts
+
+/**
+ * Rollup 表
+ * 扩展基础表，增加按代币查询功能
+ */
+declare class RollupTable extends MemoryTable<IRollupState> {
+  existByToken(token?: string): Promise<boolean>;
+}
+//#endregion
+export { RollupTable as default };

package/lib/table/token.cjs

@@ -0,0 +1,18 @@
+Object.defineProperty(exports, '__esModule', { value: true });
+const require_table_base = require('./base.cjs');
+
+//#region src/table/token.ts
+/**
+* Token 表
+* 扩展基础表，增加按符号查询功能
+*/
+var TokenTable = class extends require_table_base.default {
+	async existBySymbol(symbol) {
+		if (!symbol) throw new Error("param symbol is required");
+		return this.collection.count({ symbol }) > 0;
+	}
+};
+var token_default = TokenTable;
+
+//#endregion
+exports.default = token_default;

package/lib/table/token.d.cts

@@ -0,0 +1,14 @@
+import MemoryTable from "./base.cjs";
+import { ITokenState } from "@ocap/types";
+
+//#region src/table/token.d.ts
+
+/**
+ * Token 表
+ * 扩展基础表，增加按符号查询功能
+ */
+declare class TokenTable extends MemoryTable<ITokenState> {
+  existBySymbol(symbol: string): Promise<boolean>;
+}
+//#endregion
+export { TokenTable as default };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ocap/statedb-memory",
   "description": "OCAP statedb adapter that uses memory as backend statedb, just for test purpose",
-  "version": "1.28.8",
+  "version": "1.29.0",
   "author": "wangshijun <shijun@arcblock.io> (https://www.arcblock.io)",
   "bugs": {
     "url": "https://github.com/ArcBlock/blockchain/issues",
@@ -13,7 +13,9 @@
   "contributors": [
     "wangshijun <shijun@arcblock.io> (https://www.arcblock.io)"
   ],
-  "devDependencies": {},
+  "devDependencies": {
+    "@types/lokijs": "^1.5.14"
+  },
   "homepage": "https://github.com/ArcBlock/blockchain/tree/master/statedb/memory",
   "keywords": [
     "ocap",
@@ -21,15 +23,38 @@
     "memory"
   ],
   "license": "Apache-2.0",
-  "main": "./lib/index.js",
+  "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"
   ],
   "repository": {
     "type": "git",
     "url": "https://github.com/ArcBlock/blockchain/tree/master/statedb/memory"
   },
   "scripts": {
+    "build": "tsdown",
+    "prebuild": "rm -rf lib esm",
     "lint": "biome check",
     "lint:fix": "biome check --write",
     "test": "bun test",
@@ -37,11 +62,12 @@
   },
   "gitHead": "87990c8b5e215107fc587c1ced0d6b3e2cd2483e",
   "dependencies": {
-    "@ocap/state": "1.28.8",
-    "@ocap/statedb": "1.28.8",
-    "@ocap/util": "1.28.8",
-    "debug": "^4.3.6",
-    "lodash": "^4.17.21",
+    "@ocap/state": "1.29.0",
+    "@ocap/statedb": "1.29.0",
+    "@ocap/types": "1.29.0",
+    "@ocap/util": "1.29.0",
+    "debug": "^4.4.3",
+    "lodash": "^4.17.23",
     "lokijs": "^1.5.12"
   }
 }

package/lib/db.js

@@ -1,60 +0,0 @@
-const { StateDB } = require('@ocap/statedb');
-const Lokijs = require('lokijs');
-const Table = require('./table/base');
-const Account = require('./table/account');
-const Token = require('./table/token');
-const Rollup = require('./table/rollup');
-const Balance = require('./table/balance');
-
-const { name, version } = require('../package.json');
-
-let instanceCounter = 0;
-
-class MemoryStateDB extends StateDB {
-  constructor() {
-    super();
-
-    this.name = name;
-    this.version = version;
-
-    // Each instance has its own LokiJS database to ensure test isolation
-    instanceCounter += 1;
-    this.db = new Lokijs(`ocap-memory-statedb-${instanceCounter}.db`);
-
-    this.balance = new Balance({ name: 'balance', uniqIndex: ['address', 'tokenAddress'], db: this.db });
-    this.account = new Account({
-      name: 'account',
-      uniqIndex: 'address',
-      balanceTable: this.balance,
-      syncBalance: true,
-      db: this.db,
-    });
-    this.factory = new Table({
-      name: 'factory',
-      uniqIndex: 'address',
-      syncBalance: true,
-      balanceTable: this.balance,
-      db: this.db,
-    });
-    this.stake = new Table({
-      name: 'stake',
-      uniqIndex: 'address',
-      syncBalance: true,
-      balanceTable: this.balance,
-      db: this.db,
-    });
-    this.asset = new Table({ name: 'asset', uniqIndex: 'address', db: this.db });
-    this.delegation = new Table({ name: 'delegation', uniqIndex: 'address', db: this.db });
-    this.tx = new Table({ name: 'tx', uniqIndex: 'hash', db: this.db });
-    this.token = new Token({ name: 'token', uniqIndex: 'address', db: this.db });
-    this.chain = new Table({ name: 'chain', uniqIndex: 'address', db: this.db });
-    this.rollup = new Rollup({ name: 'rollup', uniqIndex: 'address', db: this.db });
-    this.rollupBlock = new Table({ name: 'rollupBlock', uniqIndex: 'hash', db: this.db });
-    this.evidence = new Table({ name: 'evidence', uniqIndex: 'hash', db: this.db });
-    this.tokenFactory = new Table({ name: 'tokenFactory', uniqIndex: 'address', db: this.db });
-
-    this.attachReadyListeners();
-  }
-}
-
-module.exports = MemoryStateDB;

package/lib/index.js

@@ -1 +0,0 @@
-module.exports = require('./db');

package/lib/table/account.js

@@ -1,20 +0,0 @@
-const { ensureChecksumAddress } = require('@ocap/state/lib/states/account');
-const MemoryStateDB = require('./base');
-
-class AccountStateDB extends MemoryStateDB {
-  async _get(address, { traceMigration = true } = {}) {
-    const current = await super._get(ensureChecksumAddress(address));
-    if (current && traceMigration && Array.isArray(current.migratedTo) && current.migratedTo.length) {
-      return this._get(current.migratedTo[0]);
-    }
-
-    return current;
-  }
-
-  _create(key, attrs = {}) {
-    const address = ensureChecksumAddress(key);
-    return super._create(address, { ...attrs, [this.uniqIndex]: address });
-  }
-}
-
-module.exports = AccountStateDB;

package/lib/table/balance.js

@@ -1,41 +0,0 @@
-const { ensureChecksumAddress } = require('@ocap/state/lib/states/account');
-const MemoryStateDB = require('./base');
-
-class BalanceTable extends MemoryStateDB {
-  async getBalance(address) {
-    const tokens = await this.collection.find({ address: ensureChecksumAddress(address) });
-    return (tokens || []).reduce((acc, token) => {
-      acc[token.tokenAddress] = token.balance;
-      return acc;
-    }, {});
-  }
-
-  async updateBalance({ address, tokens, context = {} }, ctx) {
-    if (!Object.keys(tokens).length) return {};
-
-    const tokenBalances = await this.getBalance(address);
-    const updatedTokens = Object.keys(tokens)
-      .filter(
-        (token) => (tokenBalances[token] && tokenBalances[token] !== '0') || (tokens[token] && tokens[token] !== '0')
-      )
-      .filter((token) => tokenBalances[token] !== tokens[token]);
-
-    await Promise.all(
-      updatedTokens.map(async (token) => {
-        const key = { address, tokenAddress: token };
-
-        if (tokenBalances[token]) {
-          await this.update(key, { ...key, balance: tokens[token], context }, ctx);
-        } else {
-          await this.create(key, { ...key, balance: tokens[token], context }, ctx);
-        }
-
-        tokenBalances[token] = tokens[token];
-      })
-    );
-
-    return tokens;
-  }
-}
-
-module.exports = BalanceTable;