548 investigate the trac crypto api build by lucasfernandes · Pull Request #38 · Trac-Systems/trac-crypto-api

lucasfernandes · 2026-04-10T18:58:28Z

PR Description

This PR refactors the package structure and build system to ensure consistent behavior across Node, browser, and React Native.

What was done

• Introduced conditional exports in package.json for environment-specific resolution (Node, browser, RN)
• Unified all exports through a single entrypoint (index.js) to eliminate divergence
• Ensured compatibility for both default and named imports
• Fixed packaging to correctly include dist/ artifacts via "files"
• Validated integration across:
• Node (CJS + ESM)
• Browser (UMD + ESM via Vite)
• React Native
• Standardized local validation using npm pack and .tgz installation

Answers to open questions

Browser test entrypoint

• Confirmed browser tests use dist/trac-crypto-api.browser.js (UMD)
• Validated via manual HTML test that bundle loads correctly

→ No change required, this is the correct entrypoint

Unifying indexes

• Ensured all exports originate from index.js (single source of truth)
• Node, browser (via bundlers) and React Native now resolve from the same entrypoint
• Eliminated previous divergence between environments

→ Addressed

sodium-universal in React Native

• Tested directly in a React Native app using sign/verify flow
• Verified sodium-universal loads and operates via JS fallback (sodium-javascript)
• Cryptographic operations (keypair, sign, verify) executed successfully

→ Works correctly in current setup; no RN-specific implementation required

Conditional exports

• Added exports in package.json
• Validated resolution in Node, browser (Vite) and React Native

→ Fully addressed; environment-specific builds are resolved via conditional exports

Committing dist/

• Removed dist/ from repository
• Added dist/ to .gitignore
• Validated packaging still works via npm pack and .tgz install

→ Addressed; build artifacts are no longer versioned and can be generated in CI

Local testing

Confirmed working via:

npm pack
npm install ./trac-crypto-api-0.1.5.tgz

Summary of impact

•	Consistent exports across environments
•	Validated real-world usage (Node, RN, browser)
•	Improved packaging reliability

simulator_screenshot_1B3CD5B5-44E4-43EE-8051-1AC142B75D86

…d React Native support with cross-environment validation

b-garbacz · 2026-04-10T19:08:18Z

test/browser/package.json

  "license": "ISC",
  "dependencies": {
-    "trac-crypto-api": "file:../../"
+    "trac-crypto-api": "file:trac-crypto-api-0.1.5.tgz"


Only one question, won't we need to remember this line with every release?

This dependency is auto-generated via npm pack during the browser test setup and is not meant to be manually maintained. It gets updated automatically with each release.

… ensure cross-platform CI compatibility

github-actions · 2026-04-12T19:20:43Z

Coverage

Metric	Coverage	Covered/Total
Lines	90.67%	1011/1115
Statements	90.67%	1011/1115
Functions	94.11%	48/51
Branches	79.89%	147/184

index.js

leonardostsouza · 2026-04-13T08:33:42Z

It would be a good idea to check if the README.md file in test/browser/manual is still up to date

leonardostsouza · 2026-04-13T08:18:46Z

index.js

+module.exports.operation = api.operation;
+module.exports.sign = api.sign;
+module.exports.MAINNET_ID = api.MAINNET_ID;
+module.exports.TESTNET_ID = api.TESTNET_ID;


Can't we do it like this?

module.exports = { ... }

leonardostsouza · 2026-04-13T08:19:04Z

index.js

+};
+
+// ===== NODE EXPORTS =====
+api.data = data;


Why not put this directly in the object above?

leonardostsouza · 2026-04-13T08:39:28Z

index.js

-const constants = require('./constants.js');
+if (typeof document === "undefined") {
+  globalThis.document = { currentScript: { src: "" } };
+}


This will end up setting document and location in Node.js environments, which is not the intended behavior

Please, add a test to attest that Bare or Node do not contain browser/rn specific definitions. This may compromise environment detection downstream

You're right, I'll try to restrict this to browser only and also, add a test.

This is now restricted to browser environments only (isBrowser guard).
Also added a runtime test to ensure Node/Bare environments are not polluted with browser globals.

leonardostsouza · 2026-04-13T08:47:46Z

test/browser/signature/signature.test.js

-test("sodium is on window", () => {
-  expect(window.sodium).toBe(sodium);
+// ⚠️ browser: sign pode não funcionar (sodium)
+test("signature.sign: should throw in browser", async () => {


This contradicts the documentation and the html for manual tests in test/browser/ html

LEt's have a discussion about this. But, in any case:

Do not use emojis in commentaries

If we indeed keep this change, please update the manual test html for signature, because I am sure it expects a success in this case. We also need to update test/browser/manual/ README.md

You're correct. It was a little mistake that passed my attention. I'm fixing to reflect the documentation. Everything must work via browser injection as expected. Also removing annoying emogis planted.

leonardostsouza · 2026-04-13T08:49:37Z

test/browser/transaction/transaction.test.js

+  } else if (window.crypto && window.crypto.getRandomValues) {
+    window.crypto.getRandomValues(buf);
+  }
+  return buf;


Please, disable automatic code linter in your IDE

Maybe I can leverage the moment to abosorb a linter configuration here like Barto said. Let's talk about it later.

leonardostsouza · 2026-04-13T08:51:08Z

test/browser/transaction/transaction.test.js

+  try {
+    payload = api.transaction.build(txData, fromKeyPair.secretKey);
+  } catch (err) {
+    return;


This means that a throw in transaction.build will return early and this test will become green when an exception happens. Please, change this

You're correct here again, same approach of signature. Browser tests must works as expected/documented. Fixing.

…overage

lucasfernandes added 2 commits April 10, 2026 09:34

fix: remove dist folder + include it on .gitignore

14956f1

refactor: add package exports and improve Node, browser (UMD/ESM), an…

36ff853

…d React Native support with cross-environment validation

lucasfernandes linked an issue Apr 10, 2026 that may be closed by this pull request

Investigate the trac-crypto-api build Trac-Systems/main_settlement_bus#548

Open

lucasfernandes requested a review from leonardostsouza April 10, 2026 18:58

lucasfernandes self-assigned this Apr 10, 2026

lucasfernandes added the bug Something isn't working label Apr 10, 2026

lucasfernandes requested review from b-garbacz and leonardotc April 10, 2026 18:59

b-garbacz reviewed Apr 10, 2026

View reviewed changes

lucasfernandes added 3 commits April 12, 2026 15:37

fix: browser tests

40554af

fix: ci clean

2b34365

ci: refactor browser setup to node script, remove shell commands, and…

d54c67f

… ensure cross-platform CI compatibility

leonardostsouza reviewed Apr 13, 2026

View reviewed changes

index.js Outdated Show resolved Hide resolved

leonardostsouza requested changes Apr 13, 2026

View reviewed changes

lucasfernandes added 2 commits April 13, 2026 20:08

test: align browser tests with runtime behavior and restore missing c…

f83ebcc

…overage

fix: restrict browser globals + simplify exports + update README

307eb74

lucasfernandes requested review from b-garbacz and leonardostsouza April 14, 2026 00:29

Conversation

lucasfernandes commented Apr 10, 2026

PR Description

What was done

Answers to open questions

Local testing

Summary of impact

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Apr 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage

Uh oh!

Uh oh!

leonardostsouza commented Apr 13, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions bot commented Apr 12, 2026 •

edited

Loading