Re-implement encrypt.circom and poseidon decrypt #45

jimthematrix · 2024-08-22T03:39:37Z

So that both the encryption (in circom and js) and decryption (in js) follow the paper closely: https://drive.google.com/file/d/1EVrP3DzoGbmzkRmYnyEDcIQcXVU7GlOd/view

Also added two more circuits, poseidon.circom and poseidon-ex.circom, purely for testing purposes, to ensure that the underlying poseidon templates continue to work as expected.

This PR also eliminates GPL-v3 dependencies from the SDK library (zkp/js/index). Some GPL-v3 exists but only used in constructing tests.

The poseidon-lite dependency is using a fork at git://github.com/kaleido-io/poseidon-lite.git#pre-build. This is a temporary solution until the PR chancehudson/poseidon-lite#3 is merged into a new release.

Signed-off-by: Jim Zhang <[email protected]>

codecov · 2024-08-22T03:43:37Z

Codecov Report

Attention: Patch coverage is 86.66667% with 2 lines in your changes missing coverage. Please review.

Project coverage is 75.22%. Comparing base (3b7a354) to head (930499e).
Report is 12 commits behind head on main.

Files	Patch %	Lines
go-sdk/internal/utxo/utils.go	86.66%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #45      +/-   ##
==========================================
+ Coverage   73.23%   75.22%   +1.99%     
==========================================
  Files          12       13       +1     
  Lines         538      553      +15     
==========================================
+ Hits          394      416      +22     
+ Misses        103       93      -10     
- Partials       41       44       +3

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: Jim Zhang <[email protected]>

Chengxuan

Thanks for the change and the detailed comments! One suggestion on changing --> to ==> to ensure the constraints are added correctly, they were missed in previous reviews.

Chengxuan · 2024-08-24T05:34:49Z

go-sdk/internal/utxo/utils.go

+	// ensure that the salt fits inside the field of SNARKs
+	maxRounds := 10
+	var e error
+	for rounds := 0; rounds < maxRounds; rounds++ {


Not sure why this loop is needed

mainly to account for temporary failures due to entropy related errors

Chengxuan · 2024-08-24T05:59:12Z

go-sdk/internal/utxo/utils.go

+}
+
+func NewEncryptionNonce() *big.Int {
+	max, _ := new(big.Int).SetString("340282366920938463463374607431768211456", 10)


It would be clearer to either add a comment explaining that the number is 2^128 like the node.js version or construct the calculation in code. Also, max can be a constant

Chengxuan · 2024-08-24T06:14:21Z

zkp/circuits/anon_enc_nullifier_non_repudiation.circom

+  encrypt1.cipherText[0] --> cipherTextReceiver[0];
+  encrypt1.cipherText[1] --> cipherTextReceiver[1];
+  encrypt1.cipherText[2] --> cipherTextReceiver[2];
+  encrypt1.cipherText[3] --> cipherTextReceiver[3];


Suggested change

encrypt1.cipherText[0] --> cipherTextReceiver[0];

encrypt1.cipherText[1] --> cipherTextReceiver[1];

encrypt1.cipherText[2] --> cipherTextReceiver[2];

encrypt1.cipherText[3] --> cipherTextReceiver[3];

encrypt1.cipherText[0] ==> cipherTextReceiver[0];

encrypt1.cipherText[1] ==> cipherTextReceiver[1];

encrypt1.cipherText[2] ==> cipherTextReceiver[2];

encrypt1.cipherText[3] ==> cipherTextReceiver[3];

Chengxuan · 2024-08-24T06:14:31Z

zkp/circuits/anon_enc_nullifier_non_repudiation.circom

-    idx2++;
-    j3++;
-  }
+  encrypt2.cipherText --> cipherTextAuthority;


Suggested change

encrypt2.cipherText --> cipherTextAuthority;

encrypt2.cipherText ==> cipherTextAuthority;

Chengxuan · 2024-08-24T08:31:14Z

zkp/circuits/lib/encrypt.circom

+  var l = length;
+  while (l % 3 != 0) {
+    l += 1;
+  }


Suggested change

var l = length;

while (l % 3 != 0) {

l += 1;

}

var l = length;

if (l % 3 != 0) {

l += (3 - (l % 3));

}

I tend to avoid while loop in other programming languages, thus the suggestion. But I don't know whether this will improve/reduce performance in the circom world.

I understand the coding style. and thanks for suggesting the optimization

Chengxuan · 2024-08-24T08:38:18Z

zkp/js/lib/util.js

+    state = poseidon(state, 4);
+
+    // Release three elements of the decrypted message
+    message.push(addMod(ciphertext[i * 3], -state[1]));


I was confused by the paper which didn't use subtraction for decryption. But I guess it's just the level of details that didn't need to be expressed explicitly

Signed-off-by: Jim Zhang <[email protected]>

jimthematrix · 2024-08-26T03:00:00Z

thanks @Chengxuan for the detailed reviews. All good comments especially catching the non-verifying assignments to the cipher text outputs 👍

jimthematrix added 2 commits August 21, 2024 23:31

Re-implement encrypt.circom and poseidon decrypt

257f2ab

Signed-off-by: Jim Zhang <[email protected]>

Merge branch 'main' into encrypt

351186b

jimthematrix marked this pull request as draft August 22, 2024 03:39

jimthematrix added 4 commits August 22, 2024 13:24

Switch to using poseidon-lite

2630240

Signed-off-by: Jim Zhang <[email protected]>

Update go-sdk to use newEncryptionNonce()

ffaca5e

Signed-off-by: Jim Zhang <[email protected]>

Update js tests to use newEncryptionNonce()

dab6064

Signed-off-by: Jim Zhang <[email protected]>

update zeto token contracts using encryption

591478e

Signed-off-by: Jim Zhang <[email protected]>

jimthematrix requested review from Chengxuan and EnriqueL8 August 23, 2024 01:04

Update dependency poseidon-lite to a fork in kaleido-io

ce24246

Signed-off-by: Jim Zhang <[email protected]>

jimthematrix marked this pull request as ready for review August 23, 2024 01:36

jimthematrix added 3 commits August 22, 2024 22:55

Update zkp/js dependency for ethers

9b3d92c

Signed-off-by: Jim Zhang <[email protected]>

Add unit tests for go-sdk

8ba1ff4

Signed-off-by: Jim Zhang <[email protected]>

Remove temp solution for poseidon-lite and use the new official release

4bfda8f

Signed-off-by: Jim Zhang <[email protected]>

jimthematrix mentioned this pull request Aug 23, 2024

Re-implement encryption circuit and decrypt logic in Zeto js-sdk LF-Decentralized-Trust-labs/paladin#91

Closed

Chengxuan approved these changes Aug 24, 2024

View reviewed changes

Chengxuan reviewed Aug 24, 2024

View reviewed changes

Address review comments

930499e

Signed-off-by: Jim Zhang <[email protected]>

Chengxuan merged commit e015cdc into main Aug 26, 2024
7 checks passed

jimthematrix deleted the encrypt branch August 26, 2024 12:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Re-implement encrypt.circom and poseidon decrypt #45

Re-implement encrypt.circom and poseidon decrypt #45

jimthematrix commented Aug 22, 2024 •

edited

Loading

codecov bot commented Aug 22, 2024 •

edited

Loading

Chengxuan left a comment

Chengxuan Aug 24, 2024

jimthematrix Aug 26, 2024

Chengxuan Aug 24, 2024

Chengxuan Aug 24, 2024

Chengxuan Aug 24, 2024

Chengxuan Aug 24, 2024 •

edited

Loading

jimthematrix Aug 26, 2024

Chengxuan Aug 24, 2024 •

edited

Loading

jimthematrix commented Aug 26, 2024

	encrypt2.cipherText --> cipherTextAuthority;
	encrypt2.cipherText ==> cipherTextAuthority;

Re-implement encrypt.circom and poseidon decrypt #45

Re-implement encrypt.circom and poseidon decrypt #45

Conversation

jimthematrix commented Aug 22, 2024 • edited Loading

codecov bot commented Aug 22, 2024 • edited Loading

Codecov Report

Chengxuan left a comment

Choose a reason for hiding this comment

Chengxuan Aug 24, 2024

Choose a reason for hiding this comment

jimthematrix Aug 26, 2024

Choose a reason for hiding this comment

Chengxuan Aug 24, 2024

Choose a reason for hiding this comment

Chengxuan Aug 24, 2024

Choose a reason for hiding this comment

Chengxuan Aug 24, 2024

Choose a reason for hiding this comment

Chengxuan Aug 24, 2024 • edited Loading

Choose a reason for hiding this comment

jimthematrix Aug 26, 2024

Choose a reason for hiding this comment

Chengxuan Aug 24, 2024 • edited Loading

Choose a reason for hiding this comment

jimthematrix commented Aug 26, 2024

jimthematrix commented Aug 22, 2024 •

edited

Loading

codecov bot commented Aug 22, 2024 •

edited

Loading

Chengxuan Aug 24, 2024 •

edited

Loading

Chengxuan Aug 24, 2024 •

edited

Loading