From a45bcd5f84b2e7be982e170aa31f64afac61a337 Mon Sep 17 00:00:00 2001 From: Pawel Zelawski Date: Wed, 9 Apr 2025 20:18:15 +0200 Subject: docs: Add README, usage examples, and example runner instructions - Create comprehensive README.md including: - Features, Installation (from GitHub), Usage examples (URI generation, callback verification), API Reference, Dependency status note, Testing instructions. - Review and confirm adequacy of TSDoc comments in source files. - Update README intro sentence and add explicit notes on required URL format. - Create `examples/` directory with runnable scripts: - `examples/generate-uri.ts` - `examples/verify-callback-example.ts` - Update signature verification helper (`_internalVerifySignature`) to use `createRequire` for CJS dependency loading in ESM context (required for examples). - Add "Running Examples" section to README with the correct `node --loader ts-node/esm` command. --- src/digiid.ts | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'src/digiid.ts') diff --git a/src/digiid.ts b/src/digiid.ts index 8b1dc07..363a82f 100644 --- a/src/digiid.ts +++ b/src/digiid.ts @@ -1,4 +1,6 @@ import { randomBytes } from 'crypto'; +// Import createRequire for CJS dependencies in ESM +import { createRequire } from 'module'; import { DigiIDUriOptions, DigiIDError, @@ -20,6 +22,8 @@ export async function _internalVerifySignature( address: string, signature: string ): Promise { + // Create a require function scoped to this module + const require = createRequire(import.meta.url); // eslint-disable-next-line @typescript-eslint/no-var-requires const Message = require('digibyte-message'); try { -- cgit v1.2.3