sync main to release

docs/README.md

@@ -1,3 +1,52 @@
 # erc725.js docs
 
 The markdown files in this folder are published on the LUKSO docs portal: <https://docs.lukso.tech/tools/erc725js/getting-started>
+
+## Method docs template
+
+You can use the following example below as a template to document any new methods added the library.
+
+### methodName
+
+```js
+myErc725.methodName(param1, param2, [optionalParams]);
+```
+
+```js
+ERC725.methodName(param1, param2, [optionalParams]);
+```
+
+Describe your method and how it is intended to be used, the benefits it brings, and any specific behaviour that the functions has.
+
+#### Parameters
+
+| Name     | Type                                                                                                       | Description |
+| :------- | :--------------------------------------------------------------------------------------------------------- | :---------- |
+| `param1` | `string`                                                                                                   | ...         |
+| `param2` | `string` or <br/> `string[]` or <br/> `number` or <br/> `number[]` or <br/> `boolean` or <br/> `boolean[]` | ...         |
+
+#### Returns
+
+| Name | Type     | Description |
+| :--- | :------- | :---------- |
+|      | `string` | ...         |
+
+#### Examples
+
+```javascript
+import ERC725 from '@erc725/erc725.js';
+
+const myErc725 = new ERC725();
+
+myErc725.methodName('hello', 5);
+// show in comment the expected output of the function
+```
+
+This method is also available as a static method.
+
+```javascript
+import ERC725 from '@erc725/erc725.js';
+
+ERC725.methodName('hello', 5);
+// show in comment the expected output of the function
+```

src/index.test.ts

@@ -937,6 +937,34 @@ describe('Running @erc725/erc725.js tests...', () => {
         });
       });
     });
+
+    describe('for tuples', () => {
+      it('encode `(bytes4,uint128)`', () => {
+        const schema = {
+          name: 'LSP4CreatorsMap:<address>',
+          key: '0x6de85eaf5d982b4e5da00000<address>',
+          keyType: 'Mapping',
+          valueType: '(bytes4,uint128)',
+          valueContent: '(Bytes4,Number)',
+        };
+
+        const expectedEncodedValue =
+          '0xb3c4928f00000000000000000000000000000005';
+
+        const result = ERC725.encodeData(
+          [
+            {
+              keyName: 'LSP4CreatorsMap:<address>',
+              dynamicKeyParts: address,
+              value: ['0xb3c4928f', 5],
+            },
+          ],
+          [schema],
+        );
+
+        assert.equal(result.values[0], expectedEncodedValue);
+      });
+    });
   });
 
   describe('Testing utility encoding & decoding functions', () => {
@@ -1880,6 +1908,17 @@ describe('encodeKeyName', () => {
       '0x31145577efe228036af40000a4fbbfe353124e6fa6bb7f8e088a9269df552ea2',
     );
   });
+
+  it('works for Array keys with index as `dynamicKeyParts', () => {
+    assert.deepStrictEqual(
+      encodeKeyName('MusicPlaylist[]', 2),
+      '0x03573598507fc76d82171baa336b7fd700000000000000000000000000000002',
+    );
+    assert.deepStrictEqual(
+      erc725Instance.encodeKeyName('MusicPlaylist[]', 2),
+      '0x03573598507fc76d82171baa336b7fd700000000000000000000000000000002',
+    );
+  });
 });
 
 describe('supportsInterface', () => {

src/index.ts

@@ -17,6 +17,7 @@
  * @author Robert McLeod <@robertdavid010>
  * @author Fabian Vogelsteller <[email protected]>
  * @author Hugo Masclet <@Hugoo>
+ * @author Jean Cavallera <@CJ42>
  * @date 2020
  */
 
@@ -30,12 +31,18 @@ import {
   convertIPFSGatewayUrl,
   generateSchemasFromDynamicKeys,
   duplicateMultiTypeERC725SchemaEntry,
+  getVerificationMethod,
+  isDataAuthentic,
 } from './lib/utils';
 
 import { getSchema } from './lib/schemaParser';
 import { isValidSignature } from './lib/isValidSignature';
 
-import { DEFAULT_GAS_VALUE } from './constants/constants';
+import {
+  DEFAULT_GAS_VALUE,
+  SUPPORTED_VERIFICATION_METHODS,
+  SUPPORTED_VERIFICATION_METHOD_STRINGS,
+} from './constants/constants';
 import { encodeKeyName, isDynamicKeyName } from './lib/encodeKeyName';
 
 // Types
@@ -67,9 +74,14 @@ import {
   encodeValueContent,
   decodeValueContent,
 } from './lib/encoder';
-import { internalSupportsInterface, checkPermissions } from './lib/detector';
+import { internalSupportsInterface } from './lib/detector';
 import { decodeMappingKey } from './lib/decodeMappingKey';
-import { encodePermissions, decodePermissions } from './lib/permissions';
+import {
+  encodePermissions,
+  decodePermissions,
+  checkPermissions,
+  mapPermission,
+} from './lib/permissions';
 import { AssetURLEncode } from './types/encodeData';
 import { URLDataToEncode, URLDataWithHash, Verification } from './types';
 
@@ -82,7 +94,12 @@ export {
 };
 
 export { ERC725Config, KeyValuePair, ProviderTypes } from './types';
-export { encodeData, encodeArrayKey } from './lib/utils';
+export {
+  encodeData,
+  encodeArrayKey,
+  getVerificationMethod,
+  isDataAuthentic,
+} from './lib/utils';
 export { decodeData } from './lib/decodeData';
 export { encodeKeyName, isDynamicKeyName } from './lib/encodeKeyName';
 export { decodeMappingKey } from './lib/decodeMappingKey';
@@ -95,8 +112,12 @@ export {
   decodeValueContent,
 } from './lib/encoder';
 export { getDataFromExternalSources } from './lib/getDataFromExternalSources';
-export { encodePermissions, decodePermissions } from './lib/permissions';
-export { checkPermissions } from './lib/detector';
+export {
+  encodePermissions,
+  decodePermissions,
+  checkPermissions,
+  mapPermission,
+} from './lib/permissions';
 export { getSchema } from './lib/schemaParser';
 
 // PRIVATE FUNCTION
@@ -502,50 +523,6 @@ export class ERC725 {
     );
   }
 
-  /**
-   * Encode permissions into a hexadecimal string as defined by the LSP6 KeyManager Standard.
-   *
-   * @link https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-6-KeyManager.md LSP6 KeyManager Standard.
-   * @param permissions The permissions you want to specify to be included or excluded. Any ommitted permissions will default to false.
-   * @returns {*} The permissions encoded as a hexadecimal string as defined by the LSP6 Standard.
-   */
-  static encodePermissions(permissions: Permissions): string {
-    return encodePermissions(permissions);
-  }
-
-  /**
-   * Encode permissions into a hexadecimal string as defined by the LSP6 KeyManager Standard.
-   *
-   * @link https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-6-KeyManager.md LSP6 KeyManager Standard.
-   * @param permissions The permissions you want to specify to be included or excluded. Any ommitted permissions will default to false.
-   * @returns {*} The permissions encoded as a hexadecimal string as defined by the LSP6 Standard.
-   */
-  encodePermissions(permissions: Permissions): string {
-    return encodePermissions(permissions);
-  }
-
-  /**
-   * Decodes permissions from hexadecimal as defined by the LSP6 KeyManager Standard.
-   *
-   * @link https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-6-KeyManager.md LSP6 KeyManager Standard.
-   * @param permissionHex The permission hexadecimal value to be decoded.
-   * @returns Object specifying whether default LSP6 permissions are included in provided hexademical string.
-   */
-  static decodePermissions(permissionHex: string) {
-    return decodePermissions(permissionHex);
-  }
-
-  /**
-   * Decodes permissions from hexadecimal as defined by the LSP6 KeyManager Standard.
-   *
-   * @link https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-6-KeyManager.md LSP6 KeyManager Standard.
-   * @param permissionHex The permission hexadecimal value to be decoded.
-   * @returns Object specifying whether default LSP6 permissions are included in provided hexademical string.
-   */
-  decodePermissions(permissionHex: string) {
-    return decodePermissions(permissionHex);
-  }
-
   /**
    * Hashes a key name for use on an ERC725Y contract according to LSP2 ERC725Y JSONSchema standard.
    *
@@ -634,6 +611,53 @@ export class ERC725 {
     return supportsInterface(interfaceIdOrName, options);
   }
 
+  // Permissions related functions
+  // -----------------------------
+
+  /**
+   * Encode permissions into a hexadecimal string as defined by the LSP6 KeyManager Standard.
+   *
+   * @link https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-6-KeyManager.md LSP6 KeyManager Standard.
+   * @param permissions The permissions you want to specify to be included or excluded. Any ommitted permissions will default to false.
+   * @returns {*} The permissions encoded as a hexadecimal string as defined by the LSP6 Standard.
+   */
+  static encodePermissions(permissions: Permissions): string {
+    return encodePermissions(permissions);
+  }
+
+  /**
+   * Encode permissions into a hexadecimal string as defined by the LSP6 KeyManager Standard.
+   *
+   * @link https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-6-KeyManager.md LSP6 KeyManager Standard.
+   * @param permissions The permissions you want to specify to be included or excluded. Any ommitted permissions will default to false.
+   * @returns {*} The permissions encoded as a hexadecimal string as defined by the LSP6 Standard.
+   */
+  encodePermissions(permissions: Permissions): string {
+    return encodePermissions(permissions);
+  }
+
+  /**
+   * Decodes permissions from hexadecimal as defined by the LSP6 KeyManager Standard.
+   *
+   * @link https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-6-KeyManager.md LSP6 KeyManager Standard.
+   * @param permissionHex The permission hexadecimal value to be decoded.
+   * @returns Object specifying whether default LSP6 permissions are included in provided hexademical string.
+   */
+  static decodePermissions(permissionHex: string) {
+    return decodePermissions(permissionHex);
+  }
+
+  /**
+   * Decodes permissions from hexadecimal as defined by the LSP6 KeyManager Standard.
+   *
+   * @link https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-6-KeyManager.md LSP6 KeyManager Standard.
+   * @param permissionHex The permission hexadecimal value to be decoded.
+   * @returns Object specifying whether default LSP6 permissions are included in provided hexademical string.
+   */
+  decodePermissions(permissionHex: string) {
+    return decodePermissions(permissionHex);
+  }
+
   /**
    * Check if the required permissions are included in the granted permissions as defined by the LSP6 KeyManager Standard.
    *
@@ -664,27 +688,16 @@ export class ERC725 {
     return checkPermissions(requiredPermissions, grantedPermissions);
   }
 
-  encodeDataSourceWithHash(
-    verification: undefined | Verification,
-    dataSource: string,
-  ): string {
-    return encodeDataSourceWithHash(verification, dataSource);
+  static mapPermission(permission: string): string | null {
+    return mapPermission(permission);
   }
 
-  static encodeDataSourceWithHash(
-    verification: undefined | Verification,
-    dataSource: string,
-  ): string {
-    return encodeDataSourceWithHash(verification, dataSource);
+  mapPermission(permission: string): string | null {
+    return mapPermission(permission);
   }
 
-  decodeDataSourceWithHash(value: string): URLDataWithHash {
-    return decodeDataSourceWithHash(value);
-  }
-
-  static decodeDataSourceWithHash(value: string): URLDataWithHash {
-    return decodeDataSourceWithHash(value);
-  }
+  // Encoding methods
+  // ----------------
 
   /**
    * @param type The valueType to encode the value as
@@ -745,6 +758,65 @@ export class ERC725 {
   ): string | URLDataWithHash | number | boolean | null {
     return decodeValueContent(valueContent, value);
   }
+
+  // External Data Source utilities (`VerifiableURI` and `JSONURI`)
+  // ----------------------------------------------------------------
+
+  encodeDataSourceWithHash(
+    verification: undefined | Verification,
+    dataSource: string,
+  ): string {
+    return encodeDataSourceWithHash(verification, dataSource);
+  }
+
+  static encodeDataSourceWithHash(
+    verification: undefined | Verification,
+    dataSource: string,
+  ): string {
+    return encodeDataSourceWithHash(verification, dataSource);
+  }
+
+  decodeDataSourceWithHash(value: string): URLDataWithHash {
+    return decodeDataSourceWithHash(value);
+  }
+
+  static decodeDataSourceWithHash(value: string): URLDataWithHash {
+    return decodeDataSourceWithHash(value);
+  }
+
+  static getVerificationMethod(nameOrSig: string):
+    | {
+        method: (data: string | object | Uint8Array | null) => string;
+        name: SUPPORTED_VERIFICATION_METHOD_STRINGS;
+        sig: SUPPORTED_VERIFICATION_METHODS;
+      }
+    | undefined {
+    return getVerificationMethod(nameOrSig);
+  }
+
+  getVerificationMethod(nameOrSig: string):
+    | {
+        method: (data: string | object | Uint8Array | null) => string;
+        name: SUPPORTED_VERIFICATION_METHOD_STRINGS;
+        sig: SUPPORTED_VERIFICATION_METHODS;
+      }
+    | undefined {
+    return getVerificationMethod(nameOrSig);
+  }
+
+  static isDataAuthentic(
+    data: string | Uint8Array,
+    verificationOptions: Verification,
+  ): boolean {
+    return isDataAuthentic(data, verificationOptions);
+  }
+
+  isDataAuthentic(
+    data: string | Uint8Array,
+    verificationOptions: Verification,
+  ): boolean {
+    return isDataAuthentic(data, verificationOptions);
+  }
 }
 
 export default ERC725;