Merge pull request #365 from ERC725Alliance/fix/add-verifiable-url

feat!: add support for VerifiableURI and deprecate JSONURL / AssetURL
ERC725Alliance · Dec 14, 2023 · 9aa87e5 · 9aa87e5
2 parents 8a02062 + 9bbd63d
commit 9aa87e5
Show file tree

Hide file tree

Showing 19 changed files with 350 additions and 100 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,122 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [0.21.3](https://github.com/ERC725Alliance/erc725.js/compare/v0.21.2...v0.21.3) (2023-11-29)
+
+
+### Features
+
+* add `encode/decodeValueType` as public callable methods ([#325](https://github.com/ERC725Alliance/erc725.js/issues/325)) ([a6fe7c8](https://github.com/ERC725Alliance/erc725.js/commit/a6fe7c8470688f573426b59fc2023a08da0cbd36))
+* add more schemas available to parse via `getSchema` ([#351](https://github.com/ERC725Alliance/erc725.js/issues/351)) ([b882379](https://github.com/ERC725Alliance/erc725.js/commit/b8823796c5f99d89d56954c894dfb6964adc552a))
+* add support for multi types in mappings ([#357](https://github.com/ERC725Alliance/erc725.js/issues/357)) ([ba92903](https://github.com/ERC725Alliance/erc725.js/commit/ba9290326efad0aab3855ad3f0ed2722180980ed))
+* add support to encode / decode any `uint8` to `uint256` types ([#355](https://github.com/ERC725Alliance/erc725.js/issues/355)) ([417a4e8](https://github.com/ERC725Alliance/erc725.js/commit/417a4e8ff2c74f3f9e35d0018a4973c97c6ac997))
+* allow to encode LSP2 Array length only ([#326](https://github.com/ERC725Alliance/erc725.js/issues/326)) ([3a6be55](https://github.com/ERC725Alliance/erc725.js/commit/3a6be551d889904b7d95e2630ab637f2a31feb50))
+
+
+### Bug Fixes
+
+* update lsp6 schema ([75c4044](https://github.com/ERC725Alliance/erc725.js/commit/75c40444e407d93076cc1e49ad706cc0055f383b))
+
+## [0.21.2](https://github.com/ERC725Alliance/erc725.js/compare/v0.21.1...v0.21.2) (2023-11-07)
+
+
+### Bug Fixes
+
+* Add for unknown verification method to allow for null verification data in LSP2 ([f205818](https://github.com/ERC725Alliance/erc725.js/commit/f205818af348471bde8f88af2008497b8c13e258))
+* Add more fixes per PR comments ([e7302e4](https://github.com/ERC725Alliance/erc725.js/commit/e7302e4504408e2f4f6304badd2024bfe05fcf47))
+* Change to verification object ([ddd2ab2](https://github.com/ERC725Alliance/erc725.js/commit/ddd2ab23d1c5181745827f338d9abaea48c772f7))
+* More renames _FUNCTIONS to _METHODS ([1a96be1](https://github.com/ERC725Alliance/erc725.js/commit/1a96be1dd15942d2a844bc26b9ab73e053e3b766))
+* Move @types/jest and jest ([852918c](https://github.com/ERC725Alliance/erc725.js/commit/852918c72228b3839ba60730dadef66837008f5a))
+
+## [0.21.1](https://github.com/ERC725Alliance/erc725.js/compare/v0.21.0...v0.21.1) (2023-11-06)
+
+
+### Bug Fixes
+
+* incorrect hex for `LSP8MetadataTokenURI` ([0500a75](https://github.com/ERC725Alliance/erc725.js/commit/0500a752e3117c5c7e9df8cfed22cb5d6fee20c5))
+
+## [0.21.0](https://github.com/ERC725Alliance/erc725.js/compare/v0.20.1...v0.21.0) (2023-11-02)
+
+
+### ⚠ BREAKING CHANGES
+
+* update lsp3/lsp4 verificationData
+
+### Features
+
+* new gas parameter ([82e3833](https://github.com/ERC725Alliance/erc725.js/commit/82e383345a712619b5c6a1030b124d2625115fc1))
+
+
+### Code Refactoring
+
+* update lsp3/lsp4 verificationData ([9640d9f](https://github.com/ERC725Alliance/erc725.js/commit/9640d9fbf88c7cf694b9e82cc3a711350334b097))
+
+## [0.20.1](https://github.com/ERC725Alliance/erc725.js/compare/v0.20.0...v0.20.1) (2023-10-30)
+
+
+### Bug Fixes
+
+* incorrect permission value for `EXECUTE_RELAY_CALL` ([55b8f5e](https://github.com/ERC725Alliance/erc725.js/commit/55b8f5e64c29c5a85d872f605667c88c1546f6b3))
+
+## [0.20.0](https://github.com/ERC725Alliance/erc725.js/compare/v0.19.0...v0.20.0) (2023-10-18)
+
+
+### Features
+
+* add permission `EXECUTE_RELAY_CALL` ([6db8835](https://github.com/ERC725Alliance/erc725.js/commit/6db8835ccd9d1082d9e8184bb2f14972760bea69))
+
+## [0.19.0](https://github.com/ERC725Alliance/erc725.js/compare/v0.18.0...v0.19.0) (2023-10-05)
+
+
+### ⚠ BREAKING CHANGES
+
+* change LSP3 to SupportedStandards:LSP3Profile ([#307](https://github.com/ERC725Alliance/erc725.js/issues/307))
+* new encoding for static value types (not arrays `[]`) ([#288](https://github.com/ERC725Alliance/erc725.js/issues/288))
+* change `ArrayLength` value from `uint256` to `uint128` ([#287](https://github.com/ERC725Alliance/erc725.js/issues/287))
+
+### Features
+
+* add checkPermissions function ([17d2258](https://github.com/ERC725Alliance/erc725.js/commit/17d225843c236951ef1515a0ff91095b5ef27cd3))
+* add schemas for LSP8 + LSP17 ([#311](https://github.com/ERC725Alliance/erc725.js/issues/311)) ([1e8dbf7](https://github.com/ERC725Alliance/erc725.js/commit/1e8dbf765c6c5e250539b402e9bd5a395966a8c2))
+
+
+### Bug Fixes
+
+* decode any uint256 as number not string ([#289](https://github.com/ERC725Alliance/erc725.js/issues/289)) ([37203f1](https://github.com/ERC725Alliance/erc725.js/commit/37203f14d313a0caff75724dc74175c741c1b540))
+* dependencies & example ([#302](https://github.com/ERC725Alliance/erc725.js/issues/302)) ([9979e89](https://github.com/ERC725Alliance/erc725.js/commit/9979e89e438cd9f7cc586d7dc271de969f13b125))
+* incorrect value in schema for array length in `...Map` ([#310](https://github.com/ERC725Alliance/erc725.js/issues/310)) ([0d28b13](https://github.com/ERC725Alliance/erc725.js/commit/0d28b1317dc085078090a8babacf4db517d91a87))
+* Remove hardcoded require ([5279278](https://github.com/ERC725Alliance/erc725.js/commit/527927812b1a05b13f8dc6b14aecaa6d24e98d61))
+* variable naming ([44b4785](https://github.com/ERC725Alliance/erc725.js/commit/44b47851ed63b817edc21c63655d67bac13a7e7f))
+
+
+### Code Refactoring
+
+* change `ArrayLength` value from `uint256` to `uint128` ([#287](https://github.com/ERC725Alliance/erc725.js/issues/287)) ([c95ee8a](https://github.com/ERC725Alliance/erc725.js/commit/c95ee8a53bf25bcf47777054af27cae1fbad8b2f))
+* change LSP3 to SupportedStandards:LSP3Profile ([#307](https://github.com/ERC725Alliance/erc725.js/issues/307)) ([73f3481](https://github.com/ERC725Alliance/erc725.js/commit/73f34818fe152c3ab5299177adc0eddfed6886c5))
+* new encoding for static value types (not arrays `[]`) ([#288](https://github.com/ERC725Alliance/erc725.js/issues/288)) ([f0b04da](https://github.com/ERC725Alliance/erc725.js/commit/f0b04daa57a281c537a8f28594439573188f0dce))
+
+## [0.18.0](https://github.com/ERC725Alliance/erc725.js/compare/v0.17.2...v0.18.0) (2023-08-03)
+
+### ⚠ BREAKING CHANGES
+
+- new encoding for static value types (not arrays `[]`) (#288)
+- change `ArrayLength` value from `uint256` to `uint128` (#287)
+
+### Features
+
+- add checkPermissions function ([17d2258](https://github.com/ERC725Alliance/erc725.js/commit/17d225843c236951ef1515a0ff91095b5ef27cd3))
+- Add new feature "Decode Mapping Key" ([8c1f1fc](https://github.com/ERC725Alliance/erc725.js/commit/8c1f1fcfb15fa43d1d3934b0b15f09d47902bb41))
+
+### Bug Fixes
+
+- decode any uint256 as number not string ([#289](https://github.com/ERC725Alliance/erc725.js/issues/289)) ([37203f1](https://github.com/ERC725Alliance/erc725.js/commit/37203f14d313a0caff75724dc74175c741c1b540))
+- variable naming ([44b4785](https://github.com/ERC725Alliance/erc725.js/commit/44b47851ed63b817edc21c63655d67bac13a7e7f))
+
+### improvement
+
+- change `ArrayLength` value from `uint256` to `uint128` ([#287](https://github.com/ERC725Alliance/erc725.js/issues/287)) ([c95ee8a](https://github.com/ERC725Alliance/erc725.js/commit/c95ee8a53bf25bcf47777054af27cae1fbad8b2f))
+- new encoding for static value types (not arrays `[]`) ([#288](https://github.com/ERC725Alliance/erc725.js/issues/288)) ([f0b04da](https://github.com/ERC725Alliance/erc725.js/commit/f0b04daa57a281c537a8f28594439573188f0dce))
+
 ### [0.17.2](https://github.com/ERC725Alliance/erc725.js/compare/v0.17.1...v0.17.2) (2023-03-14)
 
 - removed ERC725JSONSchemaKeyType duplicate value ([060ee6c](https://github.com/ERC725Alliance/erc725.js/commit/060ee6ce23bda328f727140419de7590f48fc394))
@@ -103,7 +219,6 @@ Minor update to update the LSP-2 schemas.
 
 ### improvement
 
-- change fetchData output to non object ([1d4d570](https://github.com/ERC725Alliance/erc725.js/commit/1d4d57077a7766b3490477efb20f194fc4e00da4))
 - fetchData as same output as decodeData ([59c3a87](https://github.com/ERC725Alliance/erc725.js/commit/59c3a879fefb2b9bfe46b9bea91ff6bd2a528df1))
 - getData as same output as decodeData ([0f3b149](https://github.com/ERC725Alliance/erc725.js/commit/0f3b149f2280e6025a05e8e9ed306facfa63601a))
 - use array for decodeData ([261d100](https://github.com/ERC725Alliance/erc725.js/commit/261d1007f4ff63abd9d794f4e64e5b408ce7c1a3))

diff --git a/README.md b/README.md
@@ -60,7 +60,7 @@ const schema = [
     name: 'LSP3Profile',
     key: '0x5ef83ad9559033e6e941db7d7c495acdce616347d28e90c7ce47cbfcfcad3bc5',
     keyType: 'Singleton',
-    valueContent: 'JSONURL',
+    valueContent: 'VerifiableURI',
     valueType: 'bytes',
   },
   {

diff --git a/docs/classes/ERC725.md b/docs/classes/ERC725.md
@@ -238,7 +238,7 @@ const schemas = [
     key: '0x...',
     keyType: 'Singleton',
     valueType: 'bytes',
-    valueContent: 'JSONURL',
+    valueContent: 'VerifiableURI',
   },
 ];
 
@@ -251,7 +251,7 @@ myErc725.decodeData(
         'true',
       ],
       value:
-        '0x6f357c6a820464ddfac1bec070cc14a8daf04129871d458f2ca94368aae8391311af6361696670733a2f2f516d597231564a4c776572673670456f73636468564775676f3339706136727963455a4c6a7452504466573834554178',
+        '0x00006f357c6a0020820464ddfac1bec070cc14a8daf04129871d458f2ca94368aae8391311af6361696670733a2f2f516d597231564a4c776572673670456f73636468564775676f3339706136727963455a4c6a7452504466573834554178',
     },
   ],
   schemas,
@@ -469,9 +469,9 @@ After the `data` is encoded, the object is ready to be stored in smart contracts
 #### Examples
 
 <details>
-    <summary>Encode a <code>JSONURL</code> with JSON and uploaded URL</summary>
+    <summary>Encode a <code>VerifiableURI</code> with JSON and uploaded URL</summary>
 
-```javascript title="Encode a JSONURL with JSON and uploaded URL"
+```javascript title="Encode a VerifiableURI with JSON and uploaded URL"
 myErc725.encodeData([
   {
     keyName: 'LSP3Profile',
@@ -541,9 +541,9 @@ myErc725.encodeData([
 </details>
 
 <details>
-    <summary>Encode a <code>JSONURL</code> with hash function, hash and uploaded URL</summary>
+    <summary>Encode a <code>VerifiableURI</code> with hash function, hash and uploaded URL</summary>
 
-```javascript title="Encode a JSONURL with hash function, hash and uploaded URL"
+```javascript title="Encode a VerifiableURI with hash function, hash and uploaded URL"
 myErc725.encodeData([
   {
     keyName: 'LSP3Profile',
@@ -1005,7 +1005,7 @@ myErc725.decodeMappingKey(
 myErc725.fetchData([keys]);
 ```
 
-The `fetchData` function fetches smart contract data and can additionally return [`JSONURL`](https://github.com/lukso-network/LIPs/blob/master/LSPs/LSP-2-ERC725YJSONSchema.md#jsonurl) or [`ASSETURL`](https://github.com/lukso-network/LIPs/blob/master/LSPs/LSP-2-ERC725YJSONSchema.md#asseturl) data from IPFS, HTTP, or HTTPS endpoints.
+The `fetchData` function fetches smart contract data and can additionally return [`VerifiableURI`](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-2-ERC725YJSONSchema.md#verifiableuri) data from IPFS, HTTP, or HTTPS endpoints.
 
 :::info
 
@@ -1032,9 +1032,9 @@ The name(s) (or the encoded name(s) as schema key) of the element(s) in the smar
 
 #### Returns
 
-| Name | Type                                        | Description                                                                                                                                                                                                                              |
-| :--- | :------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| data | `Promise<Array>` or <br/> `Promise<Object>` | An array with same objects as for [`decodeData()`](./ERC725#decodedata) function but with the value being remplaced by the actual file for `JSONURL` and `ASSETURL` valueContent. If there is a hash mismatch, the value will be `null`. |
+| Name | Type                                        | Description                                                                                                                                                                                                                     |
+| :--- | :------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| data | `Promise<Array>` or <br/> `Promise<Object>` | An array with same objects as for [`decodeData()`](./ERC725#decodedata) function but with the value being remplaced by the actual file for `VerifiableURI` valueContent. If there is a hash mismatch, the value will be `null`. |
 
 :::info
 
@@ -1162,8 +1162,7 @@ When omitting the `keys` parameter, it will give back every key (as per `ERC725J
 
 :::caution
 
-- Data returned by this function does not contain external data of [`JSONURL`](https://github.com/lukso-network/LIPs/blob/master/LSPs/LSP-2-ERC725YJSONSchema.md#jsonurl)
-  or [`ASSETURL`](https://github.com/lukso-network/LIPs/blob/master/LSPs/LSP-2-ERC725YJSONSchema.md#asseturl) schema elements.
+- Data returned by this function does not contain external data of [`VerifiableURI`](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-2-ERC725YJSONSchema.md#verifiableuri) schema elements.
 - If you would like to receive everything in one go, you can use [`fetchData`](ERC725.md#fetchdata).
 
 :::
@@ -1455,7 +1454,7 @@ myErc725.getSchema(
   name: 'LSP3Profile',
   key: '0x5ef83ad9559033e6e941db7d7c495acdce616347d28e90c7ce47cbfcfcad3bc5',
   keyType: 'Singleton',
-  valueContent: 'JSONURL',
+  valueContent: 'VerifiableURI',
   valueType: 'bytes'
 }
 */
@@ -1469,7 +1468,7 @@ myErc725.getSchema([
     name: 'LSP3Profile',
     key: '0x5ef83ad9559033e6e941db7d7c495acdce616347d28e90c7ce47cbfcfcad3bc5',
     keyType: 'Singleton',
-    valueContent: 'JSONURL',
+    valueContent: 'VerifiableURI',
     valueType: 'bytes'
   },
   '0x3a47ab5bd3a594c3a8995f8fa58d087600000000000000000000000000000001': {
@@ -1493,7 +1492,7 @@ myErc725.getSchema(
       name: 'ParameterSchema',
       key: '0x777f55baf2e0c9f73d3bb456dfb8dbf6e609bf557969e3184c17ff925b3c402c',
       keyType: 'Singleton',
-      valueContent: 'JSONURL',
+      valueContent: 'VerifiableURI',
       valueType: 'bytes',
     },
   ],
@@ -1503,7 +1502,7 @@ myErc725.getSchema(
   name: 'ParameterSchema',
   key: '0x777f55baf2e0c9f73d3bb456dfb8dbf6e609bf557969e3184c17ff925b3c402c',
   keyType: 'Singleton',
-  valueContent: 'JSONURL',
+  valueContent: 'VerifiableURI',
   valueType: 'bytes',
 }
 */

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -45,7 +45,7 @@ const schemas = [
     key: '0x5ef83ad9559033e6e941db7d7c495acdce616347d28e90c7ce47cbfcfcad3bc5',
     keyType: 'Singleton',
     valueType: 'bytes',
-    valueContent: 'JSONURL',
+    valueContent: 'VerifiableURI',
   },
   {
     name: 'LSP1UniversalReceiverDelegate',

diff --git a/examples/src/decodeData.js b/examples/src/decodeData.js
@@ -8,7 +8,7 @@ const decodedDataOneKey = myERC725.decodeData([
   {
     keyName: 'LSP3Profile',
     value:
-      '0x6f357c6a820464ddfac1bec070cc14a8daf04129871d458f2ca94368aae8391311af6361697066733a2f2f516d597231564a4c776572673670456f73636468564775676f3339706136727963455a4c6a7452504466573834554178',
+      '0x00006f357c6a0020820464ddfac1bec070cc14a8daf04129871d458f2ca94368aae8391311af6361697066733a2f2f516d597231564a4c776572673670456f73636468564775676f3339706136727963455a4c6a7452504466573834554178',
   },
 ]);
 /**
@@ -31,7 +31,7 @@ const decodedDataManyKeys = myERC725.decodeData([
   {
     keyName: 'LSP3Profile',
     value:
-      '0x6f357c6a820464ddfac1bec070cc14a8daf04129871d458f2ca94368aae8391311af6361697066733a2f2f516d597231564a4c776572673670456f73636468564775676f3339706136727963455a4c6a7452504466573834554178',
+      '0x00006f357c6a0020820464ddfac1bec070cc14a8daf04129871d458f2ca94368aae8391311af6361697066733a2f2f516d597231564a4c776572673670456f73636468564775676f3339706136727963455a4c6a7452504466573834554178',
   },
   {
     keyName: 'LSP3IssuedAssets[]',
@@ -76,7 +76,7 @@ const decodedDataManyKeys = myERC725.decodeData([
 ]
 */
 console.log('/*--------------------------------------------/*');
-console.log('/* decodeData - one key                       /*');
+console.log('/* decodeData - one key (VerifiableURI)       /*');
 console.log('/*--------------------------------------------/*');
 console.log(decodedDataOneKey);
 console.log('/*--------------------------------------------/*');

diff --git a/examples/src/encodeData.js b/examples/src/encodeData.js
@@ -38,7 +38,7 @@ const encodedDataOneKeyV2 = myERC725.encodeData({
     '0x5ef83ad9559033e6e941db7d7c495acdce616347d28e90c7ce47cbfcfcad3bc5'
   ],
   values: [
-    '0x6f357c6a820464ddfac1bec070cc14a8daf04129871d458f2ca94368aae8391311af6361697066733a2f2f516d597231564a4c776572673670456f73636468564775676f3339706136727963455a4c6a7452504466573834554178'
+    '0x00006f357c6a0020820464ddfac1bec070cc14a8daf04129871d458f2ca94368aae8391311af6361697066733a2f2f516d597231564a4c776572673670456f73636468564775676f3339706136727963455a4c6a7452504466573834554178'
   ]
 }
 */
@@ -76,7 +76,7 @@ const encodedDataManyKeys = myERC725.encodeData([
     '0x0cfc51aec37c55a4d0b1a65c6255c4bf2fbdf6277f3cc0730c45b828b6db8b47'
   ],
   values: [
-    '0x6f357c6a820464ddfac1bec070cc14a8daf04129871d458f2ca94368aae8391311af6361697066733a2f2f516d597231564a4c776572673670456f73636468564775676f3339706136727963455a4c6a7452504466573834554178',
+    '0x00006f357c6a0020820464ddfac1bec070cc14a8daf04129871d458f2ca94368aae8391311af6361697066733a2f2f516d597231564a4c776572673670456f73636468564775676f3339706136727963455a4c6a7452504466573834554178',
     '0x0000000000000000000000000000000000000000000000000000000000000002',
     '0xd94353d9b005b3c0a9da169b768a31c57844e490',
     '0xdaea594e385fc724449e3118b2db7e86dfba1826',

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@erc725/erc725.js",
-  "version": "0.17.2",
+  "version": "0.21.3",
   "description": "Library to interact with ERC725 smart contracts",
   "main": "build/main/src/index.js",
   "typings": "build/main/src/index.d.ts",

diff --git a/schemas/LSP3ProfileMetadata.json b/schemas/LSP3ProfileMetadata.json
@@ -11,7 +11,7 @@
     "key": "0x5ef83ad9559033e6e941db7d7c495acdce616347d28e90c7ce47cbfcfcad3bc5",
     "keyType": "Singleton",
     "valueType": "bytes",
-    "valueContent": "JSONURL"
+    "valueContent": "VerifiableURI"
   },
   {
     "name": "LSP12IssuedAssets[]",

diff --git a/schemas/LSP4DigitalAsset.json b/schemas/LSP4DigitalAsset.json
@@ -25,7 +25,7 @@
     "key": "0x9afb95cacc9f95858ec44aa8c3b685511002e30ae54415823f406128b85b238e",
     "keyType": "Singleton",
     "valueType": "bytes",
-    "valueContent": "JSONURL"
+    "valueContent": "VerifiableURI"
   },
   {
     "name": "LSP4Creators[]",

diff --git a/src/index.ts b/src/index.ts
@@ -138,14 +138,23 @@ export class ERC725 {
   // eslint-disable-next-line class-methods-use-this
   private validateSchemas(schemas: ERC725JSONSchema[]) {
     return schemas.filter((schema) => {
+      if (
+        schema.valueContent === 'AssetURL' ||
+        schema.valueContent === 'JSONURL'
+      ) {
+        console.warn(
+          `[Deprecation notice] The schema with keyName: ${schema.name} uses deprecated valueContent: ${schema.valueContent}. It has been replaced by VerifiableURI. Decoding is backward compatible but value will be encoded as VerifiableURI.`,
+        );
+      }
+
       try {
         const encodedKeyName = encodeKeyName(schema.name);
 
         const isKeyValid = schema.key === encodedKeyName;
 
         if (!isKeyValid) {
-          console.log(
-            `The schema with keyName: ${schema.key} is skipped because its key hash does not match its key name (expected: ${encodedKeyName}, got: ${schema.key}).`,
+          console.warn(
+            `The schema with keyName: ${schema.name} is skipped because its key hash does not match its key name (expected: ${encodedKeyName}, got: ${schema.key}).`,
           );
         }