feat!: add support for VerifiableURI and deprecate JSONURL / AssetURL #365

richtera · 2023-12-06T10:13:53Z

What kind of change does this PR introduce (bug fix, feature, docs update, ...)?

fix: Add VerifiableURI support and make it default on encode.
fix: Add testing for old JSONURL

What is the current behaviour (you can also link to an open issue here)?

The current software does not support the VerifiableURI encoding.

What is the new behaviour (if this is a feature change)?

Support VerifiableURI and JSONURL on read and always output VerifiableURL on encode.

Other information:

Related to: Add VerifiableURI contentType in LSP2 lukso-network/LIPs#263

codecov-commenter · 2023-12-06T10:15:22Z

Codecov Report

Attention: 5 lines in your changes are missing coverage. Please review.

Comparison is base (8a02062) 83.29% compared to head (32c3b52) 83.18%.

Files	Patch %	Lines
src/lib/encoder.ts	75.00%	0 Missing and 4 partials ⚠️
src/lib/utils.ts	50.00%	0 Missing and 1 partial ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop     #365      +/-   ##
===========================================
- Coverage    83.29%   83.18%   -0.11%     
===========================================
  Files           19       19              
  Lines         1221     1231      +10     
  Branches       276      282       +6     
===========================================
+ Hits          1017     1024       +7     
  Misses         110      110              
- Partials        94       97       +3

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

CJ42

added review comments

src/lib/decodeData.test.ts

src/lib/utils.test.ts

src/lib/encoder.ts

CJ42 · 2023-12-12T15:25:08Z

Let's get @Hugoo review as well on this

JeneaVranceanu

LGTM except that I think the type should be rather named VerifiableURI and not VerifiableURL.

src/lib/encoder.ts

CJ42

I have pushed the latest commit with suggested changes from @JeneaVranceanu

604ec9b

The rest LGTM ✅

src/lib/decodeData.test.ts

Hugoo · 2023-12-13T18:00:51Z

src/lib/encoder.ts

+    if (verificationMethod !== undefined) {
+      const encodedLength = `0x${value.slice(14, 18)}`; // Rest of data string after function hash
+      const dataLength = hexToNumber(encodedLength, false) as number;
+      const dataHash = `0x${value.slice(18, 18 + dataLength * 2)}`; // Get jsonHash 32 bytes
+      const dataSource = hexToUtf8('0x' + value.slice(18 + dataLength * 2)); // Get remainder as URI
+      return {
+        verification: {
+          method: verificationMethod.name,
+          data: dataHash,
+        },
+        url: dataSource,
+      };
+    }


what happens if there is no verification method?

Id rather do it the other way with early return

if (verificationMethod === undefined) {
return null or undefined or stmg;
}

// and the current code here

A null verification method should return the data but no verification method or data. So you're right we should not exit this way. Fixing.

src/lib/getDataFromExternalSources.ts

examples/src/decodeData.js

src/lib/encoder.ts

magalimorin18 · 2023-12-13T19:18:29Z

src/lib/encoder.ts

+      const dataSource = hexToUtf8('0x' + value.slice(18 + dataLength * 2)); // Get remainder as URI
+      return {
+        verification: {
+          method: verificationMethod.name,


Suggested change

method: verificationMethod.name,

method: verificationMethod?.name || UNKNOWN_VERIFICATION_METHOD,

Can name not be defined on verificationMethod ?

The verificationMethod could be undefined and therefore the url is not validated

I was more thinking of a situation where : it is defined but doesnt have a name property

But we kind of want it to be undefined if not defined

The default should be the signature hash so that reading a VerificationURI can return a yet unsupported custom verification method.

magalimorin18 · 2023-12-13T19:37:02Z

src/lib/encoder.ts

+      const dataSource = hexToUtf8('0x' + value.slice(18 + dataLength * 2)); // Get remainder as URI
+      return {
+        verification: {
+          method: verificationMethod.name,


I was more thinking of a situation where : it is defined but doesnt have a name property

src/lib/encoder.ts

…se an error within decoder.

src/lib/decodeData.test.ts

src/index.ts

src/lib/encoder.ts

magalimorin18 · 2023-12-14T14:38:04Z

fmi, will we keep the backward compatibility forever or is it temporary? If so we can already create a ticket that we keep in the backlog to remove the deprecated code

Hugoo · 2023-12-14T14:41:06Z

@magalimorin18 it will be for some time until devs can update their code but ultimately

shouldBackwardCompatibilityOfJSONURLAndAssetURLExistAt(time) when time -> infinity = false

richtera

Creating github issue for unknown method.

richtera · 2023-12-14T12:37:58Z

src/lib/encoder.ts

-    stripHexPrefix(verification ? verification.data : padLeft(0, 64)) +
-    stripHexPrefix(utf8ToHex(dataSource))
-  );
+  return [


This currently cannot return data containing an unsupported verification method. I think it needs to copy the verification function signature and data verbatim every time. I messed this up.

richtera · 2023-12-14T12:38:39Z

src/lib/encoder.ts

+
+    return {
+      verification: {
+        method: verificationMethod?.name || UNKNOWN_VERIFICATION_METHOD,


The default should be verificationMethodSig and not UNKNOWN_VERIFICATION_METHOD.

src/index.ts

richtera changed the base branch from develop to main December 6, 2023 10:19

CJ42 reviewed Dec 8, 2023

View reviewed changes

richtera force-pushed the fix/add-verifiable-url branch from a074259 to 4df2377 Compare December 12, 2023 10:17

Hugoo changed the base branch from main to develop December 12, 2023 13:47

richtera closed this Dec 12, 2023

richtera force-pushed the fix/add-verifiable-url branch from 4df2377 to 8a02062 Compare December 12, 2023 15:02

fix: Rebase and merge support for VerifiableURL

44bfcc1

richtera reopened this Dec 12, 2023

fix: Rename JSONURLDataToEncode

808f1b3

JeneaVranceanu approved these changes Dec 13, 2023

View reviewed changes

src/lib/encoder.ts Outdated Show resolved Hide resolved

refactor: use literals for 00 zero bytes

604ec9b

CJ42 reviewed Dec 13, 2023

View reviewed changes

CJ42 approved these changes Dec 13, 2023

View reviewed changes

Hugoo reviewed Dec 13, 2023

View reviewed changes

CJ42 added 2 commits December 13, 2023 18:34

refactor: change valueContent to VerifiableURI

26c9988

refactor: throw error when verificationMethod is undefined

e1dc33e

magalimorin18 reviewed Dec 13, 2023

View reviewed changes

examples/src/decodeData.js Outdated Show resolved Hide resolved

magalimorin18 reviewed Dec 13, 2023

View reviewed changes

src/lib/encoder.ts Outdated Show resolved Hide resolved

magalimorin18 reviewed Dec 13, 2023

View reviewed changes

fix: Make sure unknown verification methods or 0x00000000 doesn't cau…

0585066

…se an error within decoder.

Hugoo changed the title ~~fix: Add support for verifiableURL. Read JSONURL, VerifiableURL, Write VerifiableURL. Tests.~~ fix: Add support for VerifiableURI. Read JSONURL, VerifiableURI, Write VerifiableURI. Tests. Dec 14, 2023

Hugoo added 2 commits December 14, 2023 13:27

chore: replace JSONURL to VerifiableURI in schemas

078f902

docs: update README and examples and docs for VerifiableURI

b3a273a

Hugoo force-pushed the fix/add-verifiable-url branch from 2e22522 to b3a273a Compare December 14, 2023 12:27

Hugoo added 2 commits December 14, 2023 15:21

chore: add deprecation notice on load

f7149bb

chore: add more deprecation warnings

32c3b52

Hugoo approved these changes Dec 14, 2023

View reviewed changes

src/lib/decodeData.test.ts Show resolved Hide resolved

Hugoo changed the title ~~fix: Add support for VerifiableURI. Read JSONURL, VerifiableURI, Write VerifiableURI. Tests.~~ feat!: add support for VerifiableURI and deprecate JSONURL / AssetURL Dec 14, 2023

magalimorin18 reviewed Dec 14, 2023

View reviewed changes

src/index.ts Show resolved Hide resolved

magalimorin18 reviewed Dec 14, 2023

View reviewed changes

src/lib/encoder.ts Show resolved Hide resolved

magalimorin18 approved these changes Dec 14, 2023

View reviewed changes

richtera commented Dec 14, 2023

View reviewed changes

richtera mentioned this pull request Dec 14, 2023

The default should be verificationMethodSig and not UNKNOWN_VERIFICATION_METHOD. #368

Open

chore: fix PR comment

9bbd63d

richtera merged commit 9aa87e5 into develop Dec 14, 2023
2 checks passed

richtera deleted the fix/add-verifiable-url branch December 14, 2023 15:15

Hugoo mentioned this pull request Dec 20, 2023

Implement VerifiableURI load #364

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat!: add support for VerifiableURI and deprecate JSONURL / AssetURL #365

feat!: add support for VerifiableURI and deprecate JSONURL / AssetURL #365

richtera commented Dec 6, 2023 •

edited by Hugoo

Loading

codecov-commenter commented Dec 6, 2023 •

edited

Loading

CJ42 left a comment

CJ42 commented Dec 12, 2023

JeneaVranceanu left a comment

CJ42 left a comment

Hugoo Dec 13, 2023

richtera Dec 14, 2023

magalimorin18 Dec 13, 2023 •

edited

Loading

magalimorin18 Dec 13, 2023

richtera Dec 13, 2023

magalimorin18 Dec 13, 2023

richtera Dec 13, 2023

richtera Dec 14, 2023

magalimorin18 Dec 13, 2023

magalimorin18 commented Dec 14, 2023

Hugoo commented Dec 14, 2023

richtera left a comment

richtera Dec 14, 2023

richtera Dec 14, 2023

	method: verificationMethod.name,
	method: verificationMethod?.name \|\| UNKNOWN_VERIFICATION_METHOD,

feat!: add support for VerifiableURI and deprecate JSONURL / AssetURL #365

feat!: add support for VerifiableURI and deprecate JSONURL / AssetURL #365

Conversation

richtera commented Dec 6, 2023 • edited by Hugoo Loading

What kind of change does this PR introduce (bug fix, feature, docs update, ...)?

What is the current behaviour (you can also link to an open issue here)?

What is the new behaviour (if this is a feature change)?

Other information:

codecov-commenter commented Dec 6, 2023 • edited Loading

Codecov Report

CJ42 left a comment

Choose a reason for hiding this comment

CJ42 commented Dec 12, 2023

JeneaVranceanu left a comment

Choose a reason for hiding this comment

CJ42 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

magalimorin18 Dec 13, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

magalimorin18 commented Dec 14, 2023

Hugoo commented Dec 14, 2023

richtera left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

richtera commented Dec 6, 2023 •

edited by Hugoo

Loading

codecov-commenter commented Dec 6, 2023 •

edited

Loading

magalimorin18 Dec 13, 2023 •

edited

Loading