feat: refactor, add ts and wasm #1

driemworks · 2024-11-14T16:20:38Z

includes the wasm bindings and typescript wrapper for them (formerly etf-sdk-wasm and etf.js, respectively)
tightly couples the tle rust library, wasm bindings, and typescript wrapper, allowing for easy maintenance of updates to the API as the library evolves, as the ts piece of the library directly depends on the rust one.
tle.js becoms etf.js and we no longer publish the wasm-pack output to npm
- The build script is modified to build the wasm and freshly install dependencies before transpiling to typescript
also includes several update to the tlock API to allow for greater flexibility:
- introduces a StreamCipherProvider trait and AESGCMStreamCipherProvider implementation. This allows for the library to be unopinionated, allowing an implementor to specify the encryption mechanism and CSPRNG used. For example, we could implement tlock using age in the near future

juangirini

I know that many of the requested changes come inherited from the source repo. But we need to clean up.

Generally, we can't merge commented-out code to the main branch.
There are still mentions of ETF everywhere.
Some nits, like using capital letters to start docs comments, or add descriptions to todos

There are also more things to do but I reckon they should be done as separate issues, these are:

code formatting
use mocks in the tests
update the RPCs urls

tle/Cargo.toml

tle/src/stream_ciphers.rs

tle/src/tlock.rs

wasm/src/lib.rs

driemworks · 2024-11-15T14:24:07Z

I know that many of the requested changes come inherited from the source repo. But we need to clean up.
* Generally, we can't merge commented-out code to the main branch.

* There are still mentions of ETF everywhere.

* Some nits, like using capital letters to start docs comments, or add descriptions to todos
There are also more things to do but I reckon they should be done as separate issues, these are:
* code formatting

the same rustfmt.toml from the murmur crate is used here, except I shortened line lengths to 80 instead of 100, can change it back if you prefer but I like the shorter lines more.

* use mocks in the tests

What tests require mocks?

* update the RPCs urls

which rpcs? there aren't any here, I think this comment may have been for a diff repo?

tle/src/stream_ciphers.rs

driemworks · 2024-11-15T15:42:30Z

* Generally, we can't merge commented-out code to the main branch.

we should implement a process that enforces this.

* There are still mentions of ETF everywhere.

The majority of these mentions are in the copied TS wrapper (etf.js). I removed references in the core/wasm libs but created a new issue to address etf.js (and migrate it to tle.js or whichever name we land on: #6

juangirini · 2024-11-15T19:25:53Z

the same rustfmt.toml from the murmur crate is used here, except I shortened line lengths to 80 instead of 100, can change it back if you prefer but I like the shorter lines more.

I prefer 100, but is not a big deal if we are consistent across repos. The styling issues I saw were on JS actually

What tests require mocks?

This is what I meant #1 (comment)

which rpcs? there aren't any here, I think this comment may have been for a diff repo?

This is related to this comment #1 (comment)

juangirini

I started reviewing it and got bored of code clean-up comments.
This needs some "search and replace" tle-> timelock, 'etf->timelock, ETF Network->Ideal Network`. File renaming, probably? Removing commented-out code.

juangirini · 2024-11-19T09:32:33Z

timelock/src/stream_ciphers.rs

+/// The expected length of a nonce used with AES_GCM
+const AES_GCM_NONCE_LEN: usize = 12;
+
+/// Errors that mayb be encountered with using a stream cipher


Suggested change

/// Errors that mayb be encountered with using a stream cipher

/// Errors that may be encountered with using a stream cipher

juangirini · 2024-11-19T09:38:06Z

ts/src/index.js

@@ -0,0 +1 @@
+export * from './tle';


Suggested change

export * from './tle';

export * from './timelock';

juangirini · 2024-11-19T09:39:57Z

ts/package.json

-  "description": "a typescript sdk for timelock encryption/decryption with the Ideal Network",
+  "name": "@ideallabs/timelock.js",
+  "version": "0.0.1",
+  "description": "A typescript interface for timelock encryption",
  "license": "GPL-3.0",
  "repository": "https://github.com/ideal-lab5/tle",


Suggested change

"repository": "https://github.com/ideal-lab5/tle",

"repository": "https://github.com/ideal-lab5/timelock",

juangirini · 2024-11-19T09:40:37Z

ts/src/tle.js

Shouldn't this file be renamed to timelock?

juangirini · 2024-11-19T09:41:04Z

ts/src/tle.js

+export async function timelockEncrypt(encodedMessage, roundNumber, identityBuilder, beaconPublicKey, seed) {
+    await init();
+    // TODO: fine for now but should ultimately query the BABE pallet config instead
+    // https://github.com/ideal-lab5/tle/issues/7


Suggested change

// https://github.com/ideal-lab5/tle/issues/7

// https://github.com/ideal-lab5/timelock/issues/7

juangirini · 2024-11-19T09:41:22Z

ts/src/tle.test.spec.js

@@ -0,0 +1,40 @@
+import { describe } from '@jest/globals';
+import { timelockEncrypt, IdealNetworkIdentityHandler } from './tle';


Suggested change

import { timelockEncrypt, IdealNetworkIdentityHandler } from './tle';

import { timelockEncrypt, IdealNetworkIdentityHandler } from './timelock';

juangirini · 2024-11-19T09:41:46Z

ts/src/tle.test.spec.js

+    // it('should timelock decrypt a message', async () => {
+    //   const blockNumber = 1;
+    //   const ciphertext = new Uint8Array(1);
+    //   const signature = new Uint8Array(2);
+    //   const result = await timelockDecrypt(ciphertext, signature);
+    //   expect(result).toEqual({
+    //     message: 'mocked-decrypted',
+    //     sk: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1]
+    //   })
+    // })
+    // it('should decrypt a message on demand if the user knows the secret', async () => {
+    //   const secret = "shhh, it's a secret";
+    //   const ciphertext = 'ciphertext'
+    //   const result = await decrypt(ciphertext, secret);
+    //   expect(result).toEqual({
+    //     message: 'mocked-decrypted',
+    //     sk: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1]
+    //   })
+    // })


Suggested change

// it('should timelock decrypt a message', async () => {

// const blockNumber = 1;

// const ciphertext = new Uint8Array(1);

// const signature = new Uint8Array(2);

// const result = await timelockDecrypt(ciphertext, signature);

// expect(result).toEqual({

// message: 'mocked-decrypted',

// sk: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1]

// })

// })

// it('should decrypt a message on demand if the user knows the secret', async () => {

// const secret = "shhh, it's a secret";

// const ciphertext = 'ciphertext'

// const result = await decrypt(ciphertext, secret);

// expect(result).toEqual({

// message: 'mocked-decrypted',

// sk: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1]

// })

// })

driemworks · 2024-11-19T22:42:10Z

Closing in place of simpler PR that only impacts the rust components, will address typescript wrapper in a new PR as well, tracked in #9 and #6

feat: refactor, add ts and wasm

1a50d56

driemworks requested review from juangirini, colemanirby and carloskiron November 14, 2024 16:27

juangirini requested changes Nov 15, 2024

View reviewed changes

feat: address review comments, fix tests, complete refactor

c2386ef

driemworks commented Nov 15, 2024

View reviewed changes

tle/src/stream_ciphers.rs Outdated Show resolved Hide resolved

tle/src/stream_ciphers.rs Outdated Show resolved Hide resolved

chore: fix capitalization

8dab1c2

driemworks and others added 5 commits November 15, 2024 13:51

feat: update benchmarkxs

5416406

feat: simplify typescript with narrow responsibilities - no polkadotjs

a548cd1

chore: update readme

f8e6019

Update ts/examples/react-auction/README.md

94255e9

Update ts/examples/react-auction/src/App.css

a1ae509

driemworks marked this pull request as draft November 18, 2024 14:12

driemworks self-assigned this Nov 18, 2024

driemworks marked this pull request as ready for review November 18, 2024 16:51

juangirini requested changes Nov 19, 2024

View reviewed changes

driemworks added 4 commits November 19, 2024 09:46

feat: use vitest instead of jest, refactor tests, cleanup ts files

9f25f43

remove examples

9086109

chore: expore EngineBLS, cleanup comments

228231b

chore: add licenses

c638a4f

driemworks closed this Nov 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: refactor, add ts and wasm #1

feat: refactor, add ts and wasm #1

driemworks commented Nov 14, 2024 •

edited

Loading

juangirini left a comment •

edited

Loading

driemworks commented Nov 15, 2024

driemworks commented Nov 15, 2024

juangirini commented Nov 15, 2024 •

edited

Loading

juangirini left a comment

juangirini Nov 19, 2024

juangirini Nov 19, 2024

juangirini Nov 19, 2024

juangirini Nov 19, 2024

juangirini Nov 19, 2024

juangirini Nov 19, 2024

juangirini Nov 19, 2024

driemworks commented Nov 19, 2024

	/// Errors that mayb be encountered with using a stream cipher
	/// Errors that may be encountered with using a stream cipher

	"repository": "https://github.com/ideal-lab5/tle",
	"repository": "https://github.com/ideal-lab5/timelock",

	// https://github.com/ideal-lab5/tle/issues/7
	// https://github.com/ideal-lab5/timelock/issues/7

		@@ -0,0 +1,40 @@
		import { describe } from '@jest/globals';
		import { timelockEncrypt, IdealNetworkIdentityHandler } from './tle';

feat: refactor, add ts and wasm #1

feat: refactor, add ts and wasm #1

Conversation

driemworks commented Nov 14, 2024 • edited Loading

juangirini left a comment • edited Loading

Choose a reason for hiding this comment

driemworks commented Nov 15, 2024

driemworks commented Nov 15, 2024

juangirini commented Nov 15, 2024 • edited Loading

juangirini left a comment

Choose a reason for hiding this comment

juangirini Nov 19, 2024

Choose a reason for hiding this comment

juangirini Nov 19, 2024

Choose a reason for hiding this comment

juangirini Nov 19, 2024

Choose a reason for hiding this comment

juangirini Nov 19, 2024

Choose a reason for hiding this comment

juangirini Nov 19, 2024

Choose a reason for hiding this comment

juangirini Nov 19, 2024

Choose a reason for hiding this comment

juangirini Nov 19, 2024

Choose a reason for hiding this comment

driemworks commented Nov 19, 2024

driemworks commented Nov 14, 2024 •

edited

Loading

juangirini left a comment •

edited

Loading

juangirini commented Nov 15, 2024 •

edited

Loading