Merge pull request #186 from ERC725Alliance/develop

Release v0.14.0
ERC725Alliance · Jun 14, 2022 · 22c5e1a · 22c5e1a
2 parents 4401e62 + f380e9d
commit 22c5e1a
Show file tree

Hide file tree

Showing 28 changed files with 1,384 additions and 528 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,8 +2,7 @@
 
 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.14.0-beta.0](https://github.com/ERC725Alliance/erc725.js/compare/v0.13.0...v0.14.0-beta.0) (2022-06-09)
-
+## [0.14.0](https://github.com/ERC725Alliance/erc725.js/compare/v0.13.0...v0.14.0) (2022-06-14)
 
 ### ⚠ BREAKING CHANGES
 
@@ -20,7 +19,8 @@ All notable changes to this project will be documented in this file. See [standa
 * add dynamicKeys for decodeData ([f386e15](https://github.com/ERC725Alliance/erc725.js/commit/f386e15396cbf6c2b842302f1c85b41a0798b684))
 * add non array input on decodeData ([0774a86](https://github.com/ERC725Alliance/erc725.js/commit/0774a86d652e205814863d07319adef2266f634c))
 * add support for hashed key for encodeData ([23323a0](https://github.com/ERC725Alliance/erc725.js/commit/23323a02a6bfb81be1eba24207fe353942367837))
-
+* add BytesN value content ([#184](https://github.com/ERC725Alliance/erc725.js/issues/184)) ([7e073e4](https://github.com/ERC725Alliance/erc725.js/commit/7e073e4dfc7094aac55935fffc18ef14d16a24c8))
+* add tuples support ([7f3d1a0](https://github.com/ERC725Alliance/erc725.js/commit/7f3d1a09c3e6058b76a5b3ceca8bc1f454e634ce))
 
 ### Bug Fixes
 

diff --git a/examples/package-lock.json b/examples/package-lock.json
diff --git a/examples/package.json b/examples/package.json
@@ -9,7 +9,7 @@
     "decodeData": "node src/decodeData.js"
   },
   "dependencies": {
-    "@erc725/erc725.js": "0.5.8",
+    "@erc725/erc725.js": "^0.14.0-beta.0",
     "web3": "1.5.0"
   },
   "devDependencies": {

diff --git a/examples/src/decodeData.js b/examples/src/decodeData.js
@@ -4,48 +4,72 @@ import { getInstance } from './instantiation.js';
 
 const myERC725 = getInstance();
 
-const decodedDataOneKey = myERC725.decodeData({
-  LSP3Profile:
-    '0x6f357c6a820464ddfac1bec070cc14a8daf04129871d458f2ca94368aae8391311af6361697066733a2f2f516d597231564a4c776572673670456f73636468564775676f3339706136727963455a4c6a7452504466573834554178',
-});
-/**
-{
-  LSP3Profile: {
-    hashFunction: 'keccak256(utf8)',
-    hash: '0x820464ddfac1bec070cc14a8daf04129871d458f2ca94368aae8391311af6361',
-    url: 'ipfs://QmYr1VJLwerg6pEoscdhVGugo39pa6rycEZLjtRPDfW84UAx',
+const decodedDataOneKey = myERC725.decodeData([
+  {
+    keyName: 'LSP3Profile',
+    value:
+      '0x6f357c6a820464ddfac1bec070cc14a8daf04129871d458f2ca94368aae8391311af6361697066733a2f2f516d597231564a4c776572673670456f73636468564775676f3339706136727963455a4c6a7452504466573834554178',
   },
-}
+]);
+/**
+[
+  {
+    name: 'LSP3Profile',
+    key: '0x5ef83ad9559033e6e941db7d7c495acdce616347d28e90c7ce47cbfcfcad3bc5',
+    value: {
+      hashFunction: 'keccak256(utf8)',
+      hash: '0x820464ddfac1bec070cc14a8daf04129871d458f2ca94368aae8391311af6361',
+      url: 'ipfs://QmYr1VJLwerg6pEoscdhVGugo39pa6rycEZLjtRPDfW84UAx'
+    }
+  }
+]
 */
 
-const decodedDataManyKeys = myERC725.decodeData({
-  LSP3Profile:
-    '0x6f357c6a820464ddfac1bec070cc14a8daf04129871d458f2ca94368aae8391311af6361697066733a2f2f516d597231564a4c776572673670456f73636468564775676f3339706136727963455a4c6a7452504466573834554178',
-  'LSP3IssuedAssets[]': [
-    {
-      key: '0x3a47ab5bd3a594c3a8995f8fa58d0876c96819ca4516bd76100c92462f2f9dc0',
-      value:
-        '0x0000000000000000000000000000000000000000000000000000000000000002',
-    },
-    {
-      key: '0x3a47ab5bd3a594c3a8995f8fa58d087600000000000000000000000000000000',
-      value: '0xd94353d9b005b3c0a9da169b768a31c57844e490',
-    },
-    {
-      key: '0x3a47ab5bd3a594c3a8995f8fa58d087600000000000000000000000000000001',
-      value: '0xdaea594e385fc724449e3118b2db7e86dfba1826',
-    },
-  ],
-});
+const decodedDataManyKeys = myERC725.decodeData([
+  {
+    keyName: 'LSP3Profile',
+    value:
+      '0x6f357c6a820464ddfac1bec070cc14a8daf04129871d458f2ca94368aae8391311af6361697066733a2f2f516d597231564a4c776572673670456f73636468564775676f3339706136727963455a4c6a7452504466573834554178',
+  },
+  {
+    keyName: 'LSP3IssuedAssets[]',
+    value: [
+      {
+        key: '0x3a47ab5bd3a594c3a8995f8fa58d0876c96819ca4516bd76100c92462f2f9dc0',
+        value:
+          '0x0000000000000000000000000000000000000000000000000000000000000002',
+      },
+      {
+        key: '0x3a47ab5bd3a594c3a8995f8fa58d087600000000000000000000000000000000',
+        value: '0xd94353d9b005b3c0a9da169b768a31c57844e490',
+      },
+      {
+        key: '0x3a47ab5bd3a594c3a8995f8fa58d087600000000000000000000000000000001',
+        value: '0xdaea594e385fc724449e3118b2db7e86dfba1826',
+      },
+    ],
+  },
+]);
 /**
-{
-  LSP3Profile: {
-    hashFunction: 'keccak256(utf8)',
-    hash: '0x820464ddfac1bec070cc14a8daf04129871d458f2ca94368aae8391311af6361',
-    url: 'ipfs://QmYr1VJLwerg6pEoscdhVGugo39pa6rycEZLjtRPDfW84UAx',
+[
+  {
+    name: 'LSP3Profile',
+    key: '0x5ef83ad9559033e6e941db7d7c495acdce616347d28e90c7ce47cbfcfcad3bc5',
+    value: {
+      hashFunction: 'keccak256(utf8)',
+      hash: '0x820464ddfac1bec070cc14a8daf04129871d458f2ca94368aae8391311af6361',
+      url: 'ipfs://QmYr1VJLwerg6pEoscdhVGugo39pa6rycEZLjtRPDfW84UAx'
+    }
   },
-  LSP1UniversalReceiverDelegate: '0x1183790f29BE3cDfD0A102862fEA1a4a30b3AdAb',
-}
+  {
+    name: 'LSP3IssuedAssets[]',
+    key: '0x3a47ab5bd3a594c3a8995f8fa58d0876c96819ca4516bd76100c92462f2f9dc0',
+    value: [
+      '0xD94353D9B005B3c0A9Da169b768a31C57844e490',
+      '0xDaea594E385Fc724449E3118B2Db7E86dFBa1826'
+    ]
+  }
+]
 */
 console.log('/*--------------------------------------------/*');
 console.log('/* decodeData - one key                       /*');

diff --git a/examples/src/encodeData.js b/examples/src/encodeData.js
@@ -5,64 +5,79 @@ import { getInstance, profileJson } from './instantiation.js';
 const myERC725 = getInstance();
 
 const encodedDataOneKey = myERC725.encodeData({
-  LSP3Profile: {
+  keyName: 'LSP3Profile',
+  value: {
     json: profileJson, // check instantiation.js to see the actual JSON
     url: 'ipfs://QmQTqheBLZFnQUxu5RDs8tA9JtkxfZqMBcmGd9sukXxwRm',
   },
 });
 /**
 {
-  LSP3Profile: {
-    value: '0x6f357c6a2404a2866f05e53e141eb61382a045e53c2fc54831daca9d9e1e039a11f739e1696670733a2f2f516d5154716865424c5a466e5155787535524473387441394a746b78665a714d42636d47643973756b587877526d',
-    key: '0x5ef83ad9559033e6e941db7d7c495acdce616347d28e90c7ce47cbfcfcad3bc5'
-  }
+  keys: [
+    '0x5ef83ad9559033e6e941db7d7c495acdce616347d28e90c7ce47cbfcfcad3bc5'
+  ],
+  values: [
+    '0x6f357c6a2404a2866f05e53e141eb61382a045e53c2fc54831daca9d9e1e039a11f739e1697066733a2f2f516d5154716865424c5a466e5155787535524473387441394a746b78665a714d42636d47643973756b587877526d'
+  ]
 }
 */
 
 const encodedDataOneKeyV2 = myERC725.encodeData({
-  LSP3Profile: {
+  keyName: 'LSP3Profile',
+  value: {
     hashFunction: 'keccak256(utf8)',
     hash: '0x820464ddfac1bec070cc14a8daf04129871d458f2ca94368aae8391311af6361',
     url: 'ipfs://QmYr1VJLwerg6pEoscdhVGugo39pa6rycEZLjtRPDfW84UAx',
   },
 });
 /**
 {
-  LSP3Profile: {
-    value:
-      '0x6f357c6a820464ddfac1bec070cc14a8daf04129871d458f2ca94368aae8391311af6361697066733a2f2f516d597231564a4c776572673670456f73636468564775676f3339706136727963455a4c6a7452504466573834554178',
-    key: '0x5ef83ad9559033e6e941db7d7c495acdce616347d28e90c7ce47cbfcfcad3bc5',
-  },
+  keys: [
+    '0x5ef83ad9559033e6e941db7d7c495acdce616347d28e90c7ce47cbfcfcad3bc5'
+  ],
+  values: [
+    '0x6f357c6a820464ddfac1bec070cc14a8daf04129871d458f2ca94368aae8391311af6361697066733a2f2f516d597231564a4c776572673670456f73636468564775676f3339706136727963455a4c6a7452504466573834554178'
+  ]
 }
 */
 
-const encodedDataManyKeys = myERC725.encodeData({
-  LSP3Profile: {
-    hashFunction: 'keccak256(utf8)',
-    hash: '0x820464ddfac1bec070cc14a8daf04129871d458f2ca94368aae8391311af6361',
-    url: 'ipfs://QmYr1VJLwerg6pEoscdhVGugo39pa6rycEZLjtRPDfW84UAx',
-  },
-  'LSP3IssuedAssets[]': [
-    '0xD94353D9B005B3c0A9Da169b768a31C57844e490',
-    '0xDaea594E385Fc724449E3118B2Db7E86dFBa1826',
-  ],
-  LSP1UniversalReceiverDelegate: '0x1183790f29BE3cDfD0A102862fEA1a4a30b3AdAb',
-});
-/**
-{
-  LSP3Profile: {
-    value:
-      '0x6f357c6a820464ddfac1bec070cc14a8daf04129871d458f2ca94368aae8391311af6361697066733a2f2f516d597231564a4c776572673670456f73636468564775676f3339706136727963455a4c6a7452504466573834554178',
-    key: '0x5ef83ad9559033e6e941db7d7c495acdce616347d28e90c7ce47cbfcfcad3bc5',
+const encodedDataManyKeys = myERC725.encodeData([
+  {
+    keyName: 'LSP3Profile',
+    value: {
+      hashFunction: 'keccak256(utf8)',
+      hash: '0x820464ddfac1bec070cc14a8daf04129871d458f2ca94368aae8391311af6361',
+      url: 'ipfs://QmYr1VJLwerg6pEoscdhVGugo39pa6rycEZLjtRPDfW84UAx',
+    },
   },
-  'LSP3IssuedAssets[]': {
-    value: [[Object], [Object], [Object]],
-    key: '0x3a47ab5bd3a594c3a8995f8fa58d0876c96819ca4516bd76100c92462f2f9dc0',
+  {
+    keyName: 'LSP3IssuedAssets[]',
+    value: [
+      '0xD94353D9B005B3c0A9Da169b768a31C57844e490',
+      '0xDaea594E385Fc724449E3118B2Db7E86dFBa1826',
+    ],
   },
-  LSP1UniversalReceiverDelegate: {
-    value: '0x1183790f29be3cdfd0a102862fea1a4a30b3adab',
-    key: '0x0cfc51aec37c55a4d0b1a65c6255c4bf2fbdf6277f3cc0730c45b828b6db8b47',
+  {
+    keyName: 'LSP1UniversalReceiverDelegate',
+    value: '0x1183790f29BE3cDfD0A102862fEA1a4a30b3AdAb',
   },
+]);
+/**
+{
+  keys: [
+    '0x5ef83ad9559033e6e941db7d7c495acdce616347d28e90c7ce47cbfcfcad3bc5',
+    '0x3a47ab5bd3a594c3a8995f8fa58d0876c96819ca4516bd76100c92462f2f9dc0',
+    '0x3a47ab5bd3a594c3a8995f8fa58d087600000000000000000000000000000000',
+    '0x3a47ab5bd3a594c3a8995f8fa58d087600000000000000000000000000000001',
+    '0x0cfc51aec37c55a4d0b1a65c6255c4bf2fbdf6277f3cc0730c45b828b6db8b47'
+  ],
+  values: [
+    '0x6f357c6a820464ddfac1bec070cc14a8daf04129871d458f2ca94368aae8391311af6361697066733a2f2f516d597231564a4c776572673670456f73636468564775676f3339706136727963455a4c6a7452504466573834554178',
+    '0x0000000000000000000000000000000000000000000000000000000000000002',
+    '0xd94353d9b005b3c0a9da169b768a31c57844e490',
+    '0xdaea594e385fc724449e3118b2db7e86dfba1826',
+    '0x1183790f29be3cdfd0a102862fea1a4a30b3adab'
+  ]
 }
 */