Merge branch 'develop' into feat/value-type-support

ERC725Alliance · Nov 24, 2023 · 83344f8 · 83344f8
2 parents ca1c9da + 3a6be55
commit 83344f8
Show file tree

Hide file tree

Showing 6 changed files with 348 additions and 114 deletions.
diff --git a/docs/classes/ERC725.md b/docs/classes/ERC725.md
@@ -342,6 +342,67 @@ myErc725.decodePermissions('0x00000000000000000000000000000000000000000000000000
 
 ---
 
+## decodeValueType
+
+```js
+myErc725.decodeValueType(type, data);
+```
+
+```js
+ERC725.decodeValueType(type, data);
+```
+
+Decode some data according to a provided value type.
+
+#### Parameters
+
+| Name   | Type   | Description                                                                   |
+| :----- | :----- | :---------------------------------------------------------------------------- |
+| `type` | string | The value type to decode the data (i.e. `uint256`, `bool`, `bytes4`, etc...). |
+| `data` | string | A hex encoded string starting with `0x` to decode                             |
+
+#### Returns
+
+| Name           | Type                   | Description                          |
+| :------------- | :--------------------- | :----------------------------------- |
+| `decodedValue` | string or <br/> number | A value decoded according to `type`. |
+
+#### Examples
+
+```javascript
+myErc725.decodeValueType('uint128', '0x0000000000000000000000000000000a');
+// 10
+
+myErc725.decodeValueType('bool', '0x01');
+// true
+
+myErc725.decodeValueType('string', '0x48656c6c6f21');
+// 'Hello!';
+
+// also available for ABI encoded array + CompactBytesArray
+myErc725.decodeValueType(
+  'uint256[]',
+  '0x00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000003000000000000000000000000000000000000000000000000000000000000000a0000000000000000000000000000000000000000000000000000000000000014000000000000000000000000000000000000000000000000000000000000001e',
+);
+// [ 10, 20, 30 ]
+
+myErc725.decodeValueType(
+  'uint256[CompactBytesArray]'',
+  '0x0020000000000000000000000000000000000000000000000000000000000000000500200000000000000000000000000000000000000000000000000000000000000008'
+)
+// [ 5, 8 ]
+```
+
+This method is also available as a static method:
+
+```js
+ERC725.decodeValueType(
+  'uint256',
+  '0x000000000000000000000000000000000000000000000000000000000000002a',
+);
+// 42
+```
+
 ## encodeData
 
 ```js
@@ -615,6 +676,178 @@ myErc725.encodeData([
 
 </details>
 
+<details>
+    <summary>Encode array length</summary>
+
+If the key is of type Array and you pass an integer as a value (for instance, the array length), it will be encoded accordingly.
+
+```javascript title="Encode the length of an array"
+myErc725.encodeData([
+  {
+    keyName: 'LSP3IssuedAssets[]',
+    value: 5,
+  },
+]);
+/**
+{
+  keys: [
+    '0x3a47ab5bd3a594c3a8995f8fa58d0876c96819ca4516bd76100c92462f2f9dc0',
+  ],
+  values: ['0x00000000000000000000000000000005'],
+}
+*/
+```
+
+</details>
+
+---
+
+## encodePermissions
+
+```js
+ERC725.encodePermissions(permissions);
+```
+
+Encodes permissions into a hexadecimal string as defined by the [LSP6 KeyManager Standard](https://docs.lukso.tech/standards/universal-profile/lsp6-key-manager).
+
+:::info
+
+`encodePermissions` is available as either a static or non-static method so can be called without instantiating an ERC725 object.
+
+:::
+
+#### Parameters
+
+##### 1. `permissions` - Object
+
+An object with [LSP6 KeyManager Permissions] as keys and a `boolean` as value. Any ommited permissions will default to `false`.
+
+#### Returns
+
+| Type   | Description                                                                               |
+| :----- | :---------------------------------------------------------------------------------------- |
+| string | The permissions encoded as a hexadecimal string defined by the [LSP6 KeyManager Standard] |
+
+#### Example
+
+```javascript title="Encoding permissions"
+ERC725.encodePermissions({
+  CHANGEOWNER: false,
+  ADDCONTROLLER: false,
+  EDITPERMISSIONS: false,
+  ADDEXTENSIONS: false,
+  CHANGEEXTENSIONS: true,
+  ADDUNIVERSALRECEIVERDELEGATE: false,
+  CHANGEUNIVERSALRECEIVERDELEGATE: false,
+  REENTRANCY: false,
+  SUPER_TRANSFERVALUE: true,
+  TRANSFERVALUE: true,
+  SUPER_CALL: false,
+  CALL: true,
+  SUPER_STATICCALL: false,
+  STATICCALL: false,
+  SUPER_DELEGATECALL: false,
+  DELEGATECALL: false,
+  DEPLOY: false,
+  SUPER_SETDATA: false,
+  SETDATA: false,
+  ENCRYPT: false,
+  DECRYPT: false,
+  SIGN: false,
+  EXECUTE_RELAY_CALL: false
+}),
+// '0x0000000000000000000000000000000000000000000000000000000000000110'
+
+// Any ommited Permissions will default to false
+ERC725.encodePermissions({
+  ADDCONTROLLER: true,
+  ADDEXTENSIONS: true,
+}),
+// '0x000000000000000000000000000000000000000000000000000000000000000a'
+ERC725.encodePermissions({
+  EDITPERMISSIONS: true,
+  CHANGEEXTENSIONS: true,
+  CHANGEUNIVERSALRECEIVERDELEGATE: true,
+  SETDATA: true,
+}),
+// '0x0000000000000000000000000000000000000000000000000000000000040054'
+
+
+// This method is also available on the instance:
+myErc725.encodePermissions({
+  EDITPERMISSIONS: true,
+  SETDATA: true,
+}),
+```
+
+---
+
+## encodeValueType
+
+```js
+myErc725.encodeValueType(type, value);
+```
+
+```js
+ERC725.encodeValueType(type, value);
+```
+
+#### Parameters
+
+| Name    | Type                                                                                                       | Description                                                                    |
+| :------ | :--------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------- |
+| `type`  | string                                                                                                     | The value type to encode the value (i.e. `uint256`, `bool`, `bytes4`, etc...). |
+| `value` | string or <br/> string[&nbsp;] or <br/> number or <br/> number[&nbsp;] or <br/> boolean or <br/> boolean[] | The value that should be encoded as `type`                                     |
+
+#### Returns
+
+| Name               | Type   | Description                                              |
+| :----------------- | :----- | :------------------------------------------------------- |
+| `encodedValueType` | string | A hex string representing the `value` encoded as `type`. |
+
+After the `value` is encoded, the hex string can be used to be stored inside the ERC725Y smart contract.
+
+#### Examples
+
+```javascript
+myErc725.encodeValueType('uint256', 5);
+// '0x0000000000000000000000000000000000000000000000000000000000000005'
+
+myErc725.encodeValueType('bool', true);
+// '0x01'
+
+// the word `boolean` (Name of the Typescript type) is also available
+myErc725.encodeValueType('boolean', true);
+// '0x01'
+
+// `bytesN` type will pad on the right if the value contains less than N bytes
+myErc725.encodeValueType('bytes4', '0xcafe');
+// '0xcafe0000'
+myErc725.encodeValueType('bytes32', '0xcafe');
+// '0xcafe000000000000000000000000000000000000000000000000000000000000'
+
+// `bytesN` type will throw an error if the value contains more than N bytes
+myERC725.encodeValueType('bytes4', '0xcafecafebeef');
+// Error: Can't convert 0xcafecafebeef to bytes4. Too many bytes, expected at most 4 bytes, received 6.
+
+// Can also be used to encode arrays as `CompactBytesArray`
+myERC725.encodeValueType('uint256[CompactBytesArray]', [1, 2, 3]);
+// '0x002000000000000000000000000000000000000000000000000000000000000000010020000000000000000000000000000000000000000000000000000000000000000200200000000000000000000000000000000000000000000000000000000000000003'
+
+myERC725.encodeValueType('bytes[CompactBytesArray]', [
+  '0xaaaaaaaa',
+  '0xbbbbbbbbbbbbbbbbbb',
+]);
+// '0x0004aaaaaaaa0009bbbbbbbbbbbbbbbbbb'
+```
+
+This method is also available as a static method.
+
+```javascript
+ERC725.encodeValueType('string', 'Hello');
+// '0x48656c6c6f'
+```
+
 ---
 
 ## encodeKeyName
@@ -766,86 +999,6 @@ myErc725.decodeMappingKey(
 
 ---
 
-## encodePermissions
-
-```js
-ERC725.encodePermissions(permissions);
-```
-
-Encodes permissions into a hexadecimal string as defined by the [LSP6 KeyManager Standard](https://docs.lukso.tech/standards/universal-profile/lsp6-key-manager).
-
-:::info
-
-`encodePermissions` is available as either a static or non-static method so can be called without instantiating an ERC725 object.
-
-:::
-
-#### Parameters
-
-##### 1. `permissions` - Object
-
-An object with [LSP6 KeyManager Permissions] as keys and a `boolean` as value. Any ommited permissions will default to `false`.
-
-#### Returns
-
-| Type   | Description                                                                               |
-| :----- | :---------------------------------------------------------------------------------------- |
-| string | The permissions encoded as a hexadecimal string defined by the [LSP6 KeyManager Standard] |
-
-#### Example
-
-```javascript title="Encoding permissions"
-ERC725.encodePermissions({
-  CHANGEOWNER: false,
-  ADDCONTROLLER: false,
-  EDITPERMISSIONS: false,
-  ADDEXTENSIONS: false,
-  CHANGEEXTENSIONS: true,
-  ADDUNIVERSALRECEIVERDELEGATE: false,
-  CHANGEUNIVERSALRECEIVERDELEGATE: false,
-  REENTRANCY: false,
-  SUPER_TRANSFERVALUE: true,
-  TRANSFERVALUE: true,
-  SUPER_CALL: false,
-  CALL: true,
-  SUPER_STATICCALL: false,
-  STATICCALL: false,
-  SUPER_DELEGATECALL: false,
-  DELEGATECALL: false,
-  DEPLOY: false,
-  SUPER_SETDATA: false,
-  SETDATA: false,
-  ENCRYPT: false,
-  DECRYPT: false,
-  SIGN: false,
-  EXECUTE_RELAY_CALL: false
-}),
-// '0x0000000000000000000000000000000000000000000000000000000000000110'
-
-// Any ommited Permissions will default to false
-ERC725.encodePermissions({
-  ADDCONTROLLER: true,
-  ADDEXTENSIONS: true,
-}),
-// '0x000000000000000000000000000000000000000000000000000000000000000a'
-ERC725.encodePermissions({
-  EDITPERMISSIONS: true,
-  CHANGEEXTENSIONS: true,
-  CHANGEUNIVERSALRECEIVERDELEGATE: true,
-  SETDATA: true,
-}),
-// '0x0000000000000000000000000000000000000000000000000000000000040054'
-
-
-// This method is also available on the instance:
-myErc725.encodePermissions({
-  EDITPERMISSIONS: true,
-  SETDATA: true,
-}),
-```
-
----
-
 ## fetchData
 
 ```js