Merge branch 'master' into rayane/event-ika-polling

Author: Rcc999

AGENTS.md

@@ -14,12 +14,9 @@ Check @README.md for more details.
 
 ### Packages
 
-- `./packages/lib` : a library package where we put common functions to be shared with other packages.
-- `./packages/btcindexer` : a Bitcoin indexer (btcindexer) for the nBTC project. The project is designed to monitor the Bitcoin blockchain, parse Bitcoin blocks, identify nBTC deposits, and facilitate their minting on the Sui blockchain.
-- `./packages/sui-indexer` : Polls Sui events for all active packages listed in the `nbtc_packages` database. The events are handled by the `SuiEventHandler`. Provides Redeem Solver and RPC.
-- `./packages/block-ingestor` : a new worker that exposes REST API to receive new blocks and queue them for processing.
+All packages are in the `./packages` directory. Each package, except `lib` is a service (Cloudflare worker). `lib` is a package with helper modules and functions shared between other packages.
 
-Details about each package is in described in the sections below.
+See @README.md file for details about packages.
 
 ### Core Technologies
 
@@ -245,17 +242,6 @@ Regenerate using `tree --gitignore`.
 │   └── git-hooks/
 ├── node_modules/
 ├── packages/
-│   └── btcindexer/
-│       ├── db/
-│       │   └── migrations/
-│       └── src/
-│           ├── api/
-│           ├── btcindexer.test.ts
-│           ├── electrs-service.ts
-│           ├── models.ts
-│           ├── router.ts
-│           ├── sui_client.ts
-│           └── sui_client.test.ts
 ├── .editorconfig
 ├── .gitignore
 ├── .markdownlint.yml

README.md

@@ -35,6 +35,11 @@ Workers are based on the Cloudflare Workers framework.
   - Proposes appropriate UTXO sets for withdrawal transactions
   - Coordinates with BTCIndexer for consistent state
 
+#### [Compliance](./packages/compliance/)
+
+- Updates sanctions and geo-location data.
+- Providing API to block specific addresses or queries.
+
 #### [Shared Library](./packages/lib/) (`lib`)
 
 - Provides shared functions, types, and configurations

packages/compliance/README.md

@@ -0,0 +1,6 @@
+# Compliance
+
+This worker provides data for compliance checks:
+
+- Sanctioned addresses
+- Geoblocking locations

packages/compliance/package.json

@@ -0,0 +1,21 @@
+{
+	"name": "@gonative-cc/compliance",
+	"version": "0.0.1",
+	"exports": {
+		"./*": "./src/*.ts"
+	},
+	"type": "module",
+	"scripts": {
+		"dev": "wrangler dev --test-scheduled",
+		"deploy": "wrangler deploy",
+		"typecheck": "tsc --noEmit",
+		"cf-typegen": "wrangler types",
+		"test": "bun test"
+	},
+	"dependencies": {
+		"@gonative-cc/lib": "workspace:*"
+	},
+	"devDependencies": {
+		"miniflare": "4.20251008.0"
+	}
+}

packages/compliance/src/index.ts

@@ -0,0 +1,11 @@
+import { D1Storage } from "./storage";
+
+// Export RPC entrypoints for service bindings
+export { RPC } from "./rpc";
+
+export default {
+	async scheduled(_event: ScheduledController, env: Env, _ctx: ExecutionContext): Promise<void> {
+		// TODO: run DB updates
+		const storage = new D1Storage(env.DB);
+	},
+} satisfies ExportedHandler<Env>;

packages/compliance/src/rpc.ts

@@ -0,0 +1,22 @@
+import { WorkerEntrypoint } from "cloudflare:workers";
+
+import { D1Storage } from "./storage";
+import type {
+	ConfirmingRedeemReq,
+	RedeemRequestEventRaw,
+	RedeemRequestResp,
+	FinalizeRedeemTx,
+} from "@gonative-cc/lib/rpc-types";
+
+/**
+ * RPC entrypoint for the worker.
+ *
+ * @see https://developers.cloudflare.com/workers/runtime-apis/bindings/service-bindings/rpc/
+ */
+export class RPC extends WorkerEntrypoint<Env> {
+	// TODO: check if we can use a proper type for address instead of string
+	async isBtcBlocked(btcAddrs: string[]): Promise<boolean> {
+		const storage = new D1Storage(this.env.DB);
+		return storage.isBtcBlocked(btcAddrs);
+	}
+}

packages/compliance/src/storage.test.ts

@@ -0,0 +1,48 @@
+import { describe, test, expect, beforeAll, afterAll, beforeEach, afterEach } from "bun:test";
+import { Miniflare } from "miniflare";
+import { D1Storage } from "./storage";
+import { payments, networks } from "bitcoinjs-lib";
+import { dropTables, initDb } from "@gonative-cc/lib/test-helpers/init_db";
+
+export const UTXO_LOCK_TIME_MS = 120000; // 2 minutes
+
+let mf: Miniflare;
+
+beforeAll(async () => {
+	mf = new Miniflare({
+		script: "",
+		modules: true,
+		d1Databases: ["DB"],
+		d1Persist: false,
+	});
+});
+
+afterAll(async () => {
+	await mf.dispose();
+});
+
+const p2wpkh1 = payments.p2wpkh({
+	pubkey: Buffer.from(
+		"03b32dc780fba98db25b4b72cf2b69da228f5e10ca6aa8f46eabe7f9fe22c994ee",
+		"hex",
+	),
+	network: networks.regtest,
+});
+
+describe("Bitcoin compliance", () => {
+	let storage: D1Storage;
+	let db: D1Database;
+
+	beforeEach(async () => {
+		db = await mf.getD1Database("DB");
+		await initDb(db);
+
+		storage = new D1Storage(db);
+	});
+
+	afterEach(() => dropTables(db));
+
+	test("should detect sanctioned bitcoin addresses", async () => {
+		expect(await storage.isBtcBlocked([])).toBeFalse();
+	});
+});

packages/compliance/src/storage.ts

@@ -0,0 +1,11 @@
+import { logError } from "@gonative-cc/lib/logger";
+
+export class D1Storage {
+	constructor(private db: D1Database) {}
+
+	// returns true if any of the given btcAddrs is blocked
+	async isBtcBlocked(btcAddrs: string[]): Promise<boolean> {
+		// TODO: finish implementation
+		return false;
+	}
+}

packages/compliance/tsconfig.json

@@ -0,0 +1,28 @@
+{
+	"compilerOptions": {
+		// Environment setup & latest features
+		"lib": ["ESNext"],
+		"target": "ESNext",
+		"module": "Preserve",
+		"moduleDetection": "force",
+		"allowJs": true,
+
+		// Bundler mode
+		"moduleResolution": "bundler",
+		"allowImportingTsExtensions": true,
+		"verbatimModuleSyntax": true,
+		"noEmit": true,
+
+		// Best practices
+		"strict": true,
+		"skipLibCheck": true,
+		"noFallthroughCasesInSwitch": true,
+		"noUncheckedIndexedAccess": true,
+		"noImplicitOverride": true,
+
+		// Some stricter flags (disabled by default)
+		"noUnusedLocals": false,
+		"noUnusedParameters": false,
+		"noPropertyAccessFromIndexSignature": false
+	}
+}