+## Connect to a dApp
-
+:::success Request Handling
-
+The [Universal Profile Extension](/install-up-browser-extension) automatically manages incoming requests and returns the address of the connected [Universal Profile](../../standards/universal-profile/introduction.md). To get the conrolling EOAs of the [smart contract account](../../standards/universal-profile/lsp0-erc725account.md), you can manually [fetch it's controllers](../expert-guides/key-manager/get-controller-permissions.md).
-## Connect to a dApp
+:::
```js
import Web3 from 'web3';
@@ -50,3 +40,19 @@ async function connect() {
}
connect();
```
+
+
+:::success Request Handling
-
+
+
+
+
+
+:::info
+
+If you expect your users to have multiple browser wallets or extensions, we recommend installing [Web3 Onboard](https://onboard.blocknative.com/) by following our [Web3 Onboard Configuration](./web3-onboard.md). The library will allow users to manage multiple browser providers in parallel.
+
+:::
diff --git a/docs/learn/dapp-developer/read-profile-data.md b/docs/learn/dapp-developer/read-profile-data.md
index 8cfef0f79e..408d4a0907 100644
--- a/docs/learn/dapp-developer/read-profile-data.md
+++ b/docs/learn/dapp-developer/read-profile-data.md
@@ -54,7 +54,7 @@ npm install @erc725/erc725.js
+
+
-- `SupportedStandards:LSP3Profile` Verifies that the ERC725Y contract contains [LSP3UniversalProfile](../../standards/universal-profile/lsp3-profile-metadata) data keys
+- `SupportedStandards:LSP3Profile` Verifies that the ERC725Y contract contains [LSP3Profile](../../standards/universal-profile/lsp3-profile-metadata#supportedstandardslsp3profile) data keys
- `LSP3Profile` contains the JSON file with profile descriptions and images
- `LSP12IssuedAssets[]` contains assets the profile issued
- `LSP5ReceivedAssets[]` contains assets the profile received
@@ -74,7 +74,7 @@ The [`getData()`](../../tools/erc725js/classes/ERC725.md#getdata) function allow
```js
import { ERC725 } from '@erc725/erc725.js';
-import lsp3ProfileSchema from '@erc725/erc725.js/schemas/LSP3ProfileMetadata.json' assert { type: 'json' };
+import lsp3ProfileSchema from '@erc725/erc725.js/schemas/LSP3ProfileMetadata.json';
const erc725js = new ERC725(lsp3ProfileSchema, '', 'https://rpc.testnet.lukso.gateway.fm',
{
@@ -96,7 +96,7 @@ console.log(profileData);
```js
import { ERC725, ERC725JSONSchema } from '@erc725/erc725.js';
-import lsp3ProfileSchema from '@erc725/erc725.js/schemas/LSP3ProfileMetadata.json' assert { type: 'json' };
+import lsp3ProfileSchema from '@erc725/erc725.js/schemas/LSP3ProfileMetadata.json';
const erc725js = new ERC725(lsp3ProfileSchema as ERC725JSONSchema[], '', 'https://rpc.testnet.lukso.gateway.fm',
{
diff --git a/docs/learn/dapp-developer/standard-detection.md b/docs/learn/dapp-developer/standard-detection.md
index acc842f2f2..997c036ad4 100644
--- a/docs/learn/dapp-developer/standard-detection.md
+++ b/docs/learn/dapp-developer/standard-detection.md
@@ -43,7 +43,7 @@ Similar to the [Read Profile Data Guide](./read-profile-data.md), you can use th
```js
import { ERC725 } from '@erc725/erc725.js';
-import lsp3ProfileSchema from '@erc725/erc725.js/schemas/LSP3ProfileMetadata.json' assert { type: 'json' };
+import lsp3ProfileSchema from '@erc725/erc725.js/schemas/LSP3ProfileMetadata.json';
const erc725js = new ERC725(lsp3ProfileSchema, '', 'https://rpc.testnet.lukso.gateway.fm',
{
@@ -65,7 +65,7 @@ console.log(isLSP3);
```js
import { ERC725 } from '@erc725/erc725.js';
-import lsp9VaultSchema from '@erc725/erc725.js/schemas/LSP9Vault.json' assert { type: 'json' };
+import lsp9VaultSchema from '@erc725/erc725.js/schemas/LSP9Vault.json';
const erc725js = new ERC725(
lsp9VaultSchema,
@@ -90,7 +90,7 @@ console.log(isLSP9);
```js
import { ERC725 } from '@erc725/erc725.js';
-import lsp3ProfileSchema from '@erc725/erc725.js/schemas/LSP4DigitalAsset.json' assert { type: 'json' };
+import lsp3ProfileSchema from '@erc725/erc725.js/schemas/LSP4DigitalAsset.json';
const erc725js = new ERC725(
lsp3ProfileSchema,
@@ -133,7 +133,7 @@ A **[Universal Profile](../../standards/universal-profile/lsp3-profile-metadata.
```javascript
-import UniversalProfile from '@lukso/lsp-smart-contracts/artifacts/UniversalProfile.json' assert { type: 'json' };
+import UniversalProfile from '@lukso/lsp-smart-contracts/artifacts/UniversalProfile.json';
import { INTERFACE_IDS } from '@lukso/lsp-smart-contracts/dist/constants.cjs.js';
import Web3 from 'web3';
diff --git a/docs/learn/dapp-developer/transfer-lyx.md b/docs/learn/dapp-developer/transfer-lyx.md
index bdb60bc3de..a880effd27 100644
--- a/docs/learn/dapp-developer/transfer-lyx.md
+++ b/docs/learn/dapp-developer/transfer-lyx.md
@@ -74,6 +74,7 @@ await web3.eth.sendTransaction({
})
```
+
diff --git a/docs/learn/dapp-developer/web3-onboard.md b/docs/learn/dapp-developer/web3-onboard.md
new file mode 100644
index 0000000000..e9ae9dfaad
--- /dev/null
+++ b/docs/learn/dapp-developer/web3-onboard.md
@@ -0,0 +1,168 @@
+---
+sidebar_label: '🛳️ Connect Web3-Onboard'
+sidebar_position: 9
+---
+
+# Universal Profile Integration for Web3-Onboard
+
+The [Web3-Onboard](https://onboard.blocknative.com/) library is an open-source, framework-agnostic JavaScript tool to onboard users to Web3 apps. Developers can integrate it into their dApp to handle the routing for the different extensions and wallets, simultaneously docking onto the Ethereum provider.
+
+
+
+Our [Web3-Onboard configuration](https://github.com/lukso-network/web3-onboard-config) can be used to integrate the [Universal Profile Browser Extension](https://chrome.google.com/webstore/detail/universal-profiles/abpickdkkbnbcoepogfhkhennhfhehfn?hl) into Web3-Onboard's connection module. If the [Universal Profile Browser Extension](https://chrome.google.com/webstore/detail/universal-profiles/abpickdkkbnbcoepogfhkhennhfhehfn?hl) is not installed, the user will be taken to its download page.
+
+## Installation
+
+You can install Web3-Onboard on the dApp using the related [NPM package](https://www.npmjs.com/package/@lukso/web3-onboard-config)
+
+```shell
+npm i @web3-onboard/core @lukso/web3-onboard-config @web3-onboard/injected-wallets
+```
+
+## Setup
+
+After installation, you can proceed to configure your extension that you want to dock onto your dApp.
+
+:::caution Referral Links
+
+Be aware that anyone implementing Web3-Onboard can modify the download link to the extension.
+
+:::
+
+:::success
+
+The Web3-Onboard configuration and calls should be set up as a global `context` or `component`, accessible to every page or component of your application layout that is interacting with the blockchain.
+
+:::
+
+```js
+// Import the necessary components
+import Onboard, { OnboardAPI } from "@web3-onboard/core";
+import { ConnectModalOptions } from "@web3-onboard/core/dist/types";
+import injectedModule from "@web3-onboard/injected-wallets";
+import luksoModule from "@lukso/web3-onboard-config";
+
+// Initialize the LUKSO provider from this library
+const luksoProvider = luksoModule();
+
+// Define the download link for the extension
+const UP_BROWSER_EXTENSION_URL =
+ "https://chrome.google.com/webstore/detail/universal-profiles/abpickdkkbnbcoepogfhkhennhfhehfn?hl";
+
+// Set up the injected wallet interface
+const injectedWallets = injectedModule({
+ /**
+ * Add custom wallets here that you want
+ * to inject into Web3-Onboard
+ */
+ custom: [luksoProvider],
+
+ // OPTIONAL: Add sorting for supported wallets
+ sort: (wallets) => {
+ const sorted = wallets.reduce((sorted, wallet) => {
+ /**
+ * Universal Profiles will be placed at the
+ * top of the wallet connection screen
+ *
+ * Add other injected wallet names here
+ * to adjust their order
+ */
+ if (wallet.label === "Universal Profiles") {
+ sorted.unshift(wallet);
+ } else {
+ sorted.push(wallet);
+ }
+ return sorted;
+ }, []);
+ return sorted;
+ },
+
+ /**
+ * OPTIONAL: Specify wallets that should still be displayed
+ * in the list, even when unavailable in the browser
+ */
+ displayUnavailable: ["Universal Profiles"],
+});
+
+/**
+ * Define at least one blockchain network that is able to
+ * interact with the Universal Profile Browser Extension
+ */
+const supportedChains = [
+ // https://docs.lukso.tech/networks/mainnet/parameters
+ {
+ id: 42,
+ token: "LYX",
+ label: "LUKSO Mainnet",
+ rpcUrl: "https://rpc.lukso.gateway.fm/",
+ },
+ // https://docs.lukso.tech/networks/testnet/parameters
+ {
+ id: 4021,
+ token: "LYXt",
+ label: "LUKSO Testnet",
+ rpcUrl: "https://rpc.testnet.lukso.gateway.fm/",
+ },
+];
+
+/**
+ * OPTIONAL: Set up the app description of the
+ * Web3-Onboard connection window
+ */
+const appInfo = {
+ name: "My LUKSO App",
+ /**
+ * Pictures can either be a valid
+ * Image URL or SVG as string
+ *
+ * The icon shows behind the extension picture
+ * on the right side, while the connection
+ * is being established
+ */
+ icon: "/my_app_icon.svg",
+ /**
+ * The logo shows left of the wallet list,
+ * indicating the used app
+ */
+ logo: "",
+ description: "My LUKSO App using Web3-Onboard",
+ recommendedInjectedWallets: [
+ /**
+ * Add other injected wallets and their download links
+ * to directly take users to the installation screen
+ */
+ {
+ name: "Universal Profiles",
+ url: UP_BROWSER_EXTENSION_URL,
+ },
+ ],
+};
+
+// OPTIONAL: Set up global installation notices
+const connectionOptions: ConnectModalOptions = {
+ iDontHaveAWalletLink: UP_BROWSER_EXTENSION_URL,
+ removeWhereIsMyWalletWarning: true,
+};
+
+// Create the Web3-Onboard Component
+const web3OnboardComponent: OnboardAPI = Onboard({
+ wallets: [injectedWallets],
+ chains: supportedChains,
+
+ // OPTIONAL COMPONENTS:
+ appMetadata: appInfo,
+ connect: connectionOptions,
+});
+
+// Calling the connect functionality,
+const connectedWallets = await web3OnboardComponent.connectWallet();
+
+// Debug
+console.log(connectedWallets);
+```
+
+## Sample Implementations
+
+- Check our sample integration for NextJS on the [dApp Boilerplate](https://github.com/lukso-network/tools-dapp-boilerplate) repository.
+- Test Web3-Onboard in our sandbox environment using [up-test-dapp.lukso.tech](https://up-test-dapp.lukso.tech/).
+- Find further information in the [Web3-Onboard Documentation](https://onboard.blocknative.com/docs/getting-started).
diff --git a/docs/learn/expert-guides/key-manager/execute-relay-transactions.md b/docs/learn/expert-guides/key-manager/execute-relay-transactions.md
index a2d67ba038..95a3cba279 100644
--- a/docs/learn/expert-guides/key-manager/execute-relay-transactions.md
+++ b/docs/learn/expert-guides/key-manager/execute-relay-transactions.md
@@ -452,12 +452,12 @@ let encodedMessage = web3.utils.encodePacked(
{ value: chainId, type: 'uint256' }, // `0x0000000000000000000000000000000000000000000000000000000000001069`
// e.g: nonce nb 5
{ value: nonce, type: 'uint256' }, // `0x0000000000000000000000000000000000000000000000000000000000000005`
- // e.g: valid until 1st January 2025 at midnight (GMT).
+ // e.g: valid until 1st January 2025 at midnight (GMT).
// Timestamp = 1735689600
{ value: validityTimestamps, type: 'uint256' }, // `0x0000000000000000000000000000000000000000000000000000000067748580`
// e.g: not funding the contract with any LYX (0)
{ value: msgValue, type: 'uint256' }, // `0x0000000000000000000000000000000000000000000000000000000000000000`
- // e.g: execute(uint256,address,uint256,bytes)
+ // e.g: execute(uint256,address,uint256,bytes)
// send 3 LYX to address `0xcafecafecafecafeafecafecafecafeafecafecafecafeafecafecafecafe`
{ value: abiPayload, type: 'bytes' }, // `0x44c028fe0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000cafecafecafecafecafecafecafecafecafecafe00000000000000000000000000000000000000000000000029a2241af62c000000000000000000000000000000000000000000000000000000000000000000800000000000000000000000000000000000000000000000000000000000000000`
);
diff --git a/docs/learn/expert-guides/read-asset-data.md b/docs/learn/expert-guides/read-asset-data.md
index cfa983a459..c89a0fe866 100644
--- a/docs/learn/expert-guides/read-asset-data.md
+++ b/docs/learn/expert-guides/read-asset-data.md
@@ -66,7 +66,7 @@ If using erc725.js in a NodeJS environment you may need to install and import [`
```javascript title="read_assets.js"
// Import and network setup
import { ERC725 } from '@erc725/erc725.js';
-import UniversalProfileSchema from '@erc725/erc725.js/schemas/LSP3UniversalProfileMetadata.json';
+import LSP3ProfileSchema from '@erc725/erc725.js/schemas/LSP3ProfileMetadata.json';
import Web3 from 'web3';
// Static variables
@@ -80,7 +80,7 @@ const config = { ipfsGateway: IPFS_GATEWAY };
// Fetch the LSP5 data of the Universal Profile to get its owned assets
const profile = new ERC725(
- UniversalProfileSchema,
+ LSP3ProfileSchema,
SAMPLE_PROFILE_ADDRESS,
provider,
config,
@@ -106,7 +106,7 @@ If using erc725.js in a NodeJS environment you may need to install and import [`
```javascript title="read_assets.js"
// Import and network setup
import { ERC725 } from '@erc725/erc725.js';
-import UniversalProfileSchema from '@erc725/erc725.js/schemas/LSP3UniversalProfileMetadata.json';
+import LSP3ProfileSchema from '@erc725/erc725.js/schemas/LSP3ProfileMetadata.json';
import Web3 from 'web3';
// Static variables
@@ -120,7 +120,7 @@ const config = { ipfsGateway: IPFS_GATEWAY };
// Fetch the LSP1 data of the Universal Profile to get its Universal Receiver
const profile = new ERC725(
- UniversalProfileSchema,
+ LSP3ProfileSchema,
SAMPLE_PROFILE_ADDRESS,
provider,
config,
@@ -230,7 +230,7 @@ Below is the complete code snippet of this guide, with all the steps compiled to
```javascript title="read_assets.js"
// Import and network setup
import { ERC725 } from '@erc725/erc725.js';
-import UniversalProfileSchema from '@erc725/erc725.js/schemas/LSP3UniversalProfileMetadata.json';
+import LSP3ProfileSchema from '@erc725/erc725.js/schemas/LSP3ProfileMetadata.json';
import LSP4Schema from '@erc725/erc725.js/schemas/LSP4DigitalAsset.json';
import Web3 from 'web3';
@@ -245,7 +245,7 @@ const config = { ipfsGateway: IPFS_GATEWAY };
// Fetch the LSP5 data of the Universal Profile to get its owned assets
const profile = new ERC725(
- UniversalProfileSchema,
+ LSP3ProfileSchema,
SAMPLE_PROFILE_ADDRESS,
provider,
config,
@@ -295,7 +295,7 @@ console.log(ownedAssetsMetadata);
```javascript title="read_assets.js"
// Import and network setup
import { ERC725 } from '@erc725/erc725.js';
-import UniversalProfileSchema from '@erc725/erc725.js/schemas/LSP3UniversalProfileMetadata.json';
+import LSP3ProfileSchema from '@erc725/erc725.js/schemas/LSP3ProfileMetadata.json';
import LSP4Schema from '@erc725/erc725.js/schemas/LSP4DigitalAsset.json';
import Web3 from 'web3';
import LSP1MinimalABI from './lsp1_legacy_minimal_abi.json';
@@ -311,7 +311,7 @@ const config = { ipfsGateway: IPFS_GATEWAY };
// Fetch the LSP1 data of the Universal Profile to get its Universal Receiver
const profile = new ERC725(
- UniversalProfileSchema,
+ LSP3ProfileSchema,
SAMPLE_PROFILE_ADDRESS,
provider,
config,
diff --git a/docs/learn/expert-guides/vault/edit-vault-data.md b/docs/learn/expert-guides/vault/edit-vault-data.md
index 3772691586..fcd016ac43 100644
--- a/docs/learn/expert-guides/vault/edit-vault-data.md
+++ b/docs/learn/expert-guides/vault/edit-vault-data.md
@@ -28,23 +28,20 @@ Make sure you have the following dependencies installed before beginning this tu
- [`@lukso/lsp-smart-contracts`](https://github.com/lukso-network/lsp-smart-contracts/)
-
-```shell title="Install the dependencies"
+```shell
npm install web3 @lukso/lsp-smart-contracts
```
-
-```shell title="Install the dependencies"
+```shell
npm install ethers @lukso/lsp-smart-contracts
```
-
## Step 1 - Imports, constants and EOA
@@ -54,14 +51,13 @@ After that we need to store the address of our LSP9 Vault and our Universal Prof
Then we will initialize the EOA that we will further use.
-
-```typescript title="Imports, Constants & EOA"
+```typescript
import LSP1UniversalReceiverDelegateVault from '@lukso/lsp-smart-contracts/artifacts/LSP1UniversalReceiverDelegateVault.json';
import UniversalProfile from '@lukso/lsp-smart-contracts/artifacts/UniversalProfile.json';
import LSP9Vault from '@lukso/lsp-smart-contracts/artifacts/LSP9Vault.json';
-import { ERC725YDataKeys } from '@lukso/lsp-smart-contracts/constants.js';
+import { ERC725YDataKeys } from '@lukso/lsp-smart-contracts';
import Web3 from 'web3';
// constants
@@ -75,14 +71,13 @@ const myEOA = web3.eth.accounts.wallet.add(privateKey);
```
-
-```typescript title="Imports, Constants & EOA"
+```typescript
import LSP1UniversalReceiverDelegateVault from '@lukso/lsp-smart-contracts/artifacts/LSP1UniversalReceiverDelegateVault.json';
import UniversalProfile from '@lukso/lsp-smart-contracts/artifacts/UniversalProfile.json';
import LSP9Vault from '@lukso/lsp-smart-contracts/artifacts/LSP9Vault.json';
-import { ERC725YDataKeys } from '@lukso/lsp-smart-contracts/constants.js';
+import { ERC725YDataKeys } from '@lukso/lsp-smart-contracts';
import { ethers } from 'ethers';
// constants
@@ -98,7 +93,6 @@ const myEOA = new ethers.Wallet(privateKey).connect(provider);
```
-
## Step 2 - Deploying Universal Receiver Delegate (URD)
@@ -113,19 +107,17 @@ The **Universal Profile** and the **Vault** don't use the same implementation of
At this step we will create an instance of the Vault URD that we will further be used to deploy one.
-
-```typescript title="Contract instance of the LSP9 Vault URD"
+```typescript
// create an instance of the LSP1UniversalReceiverDelegateVault
const vaultURD = new web3.eth.Contract(LSP1UniversalReceiverDelegateVault.abi);
```
-
-```typescript title="Contract instance of the LSP9 Vault URD"
+```typescript
// create a LSP1UniversalReceiverDelegateVault Contract Factory
const vaultURDFactory = new ethers.ContractFactory(
LSP1UniversalReceiverDelegateVault.abi,
@@ -134,7 +126,6 @@ const vaultURDFactory = new ethers.ContractFactory(
```
-
### Send the contract deployment transaction
@@ -142,10 +133,9 @@ const vaultURDFactory = new ethers.ContractFactory(
Send the deployment transaction and in a few seconds you will get a new deployed Vault URD.
-
-```typescript title="Send the transaction for deploying a new LSP9 Vault URD"
+```typescript
// deploy the Universal Receiver Delegate Vault contract
await vaultURD
.deploy({
@@ -153,31 +143,28 @@ await vaultURD
})
.send({
from: myEOA.address,
- gas: 5_000_000,
+ gas: '5000000',
gasPrice: '1000000000',
});
```
-
-```typescript title="Send the transaction for deploying a new LSP9 Vault URD"
+```typescript
// deploy the Universal Receiver Delegate Vault contract
const vaultURD = await vaultURDFactory.connect(myEOA).deploy();
```
-
### Final code
-
-```typescript title="Deploy a new LSP9 Vault Universal Receive Delegate"
+```typescript
const deployVaultURD = async () => {
// create an instance of the LSP1UniversalReceiverDelegateVault
const vaultURD = new web3.eth.Contract(
@@ -192,7 +179,7 @@ const deployVaultURD = async () => {
})
.send({
from: myEOA.address,
- gas: 5_000_000,
+ gas: '5000000',
gasPrice: '1000000000',
})
.on('receipt', (receipt) => (vaultURDAddress = receipt.contractAddress));
@@ -205,10 +192,9 @@ const vaultURDAddress = await deployVaultURD();
```
-
-```typescript title="Deploy a new LSP9 Vault Universal Receive Delegate"
+```typescript
const deployVaultURD = async () => {
// create a LSP1UniversalReceiverDelegateVault Contract Factory
const vaultURDFactory = new ethers.ContractFactory(
@@ -219,7 +205,11 @@ const deployVaultURD = async () => {
// deploy the Universal Receiver Delegate Vault contract
const vaultURD = await vaultURDFactory.connect(myEOA).deploy();
- return vaultURD.target;
+ // get back the transaction data when deployed
+ const transactionReceipt = await vaultURD.deployTransaction.wait();
+
+ // return the address of the Vault URD
+ return transactionReceipt.contractAddress;
};
// deploy a new Vault URD and retrieve its address
@@ -227,7 +217,6 @@ const vaultURDAddress = await deployVaultURD();
```
-
## Step 3 - Setting the URD address in the storage
@@ -242,10 +231,9 @@ Firstly we need to create instances for the following contracts:
- [**Universal Profile**](../../../standards/universal-profile/lsp0-erc725account.md)
-
-```typescript title="Contract instances for the Universal Profile and Vault"
+```typescript
// create an instance of the LSP9Vault
const vault = new web3.eth.Contract(LSP9Vault.abi, vaultAddress);
// create an instance of the Universal Profile
@@ -256,10 +244,9 @@ const universalProfile = new web3.eth.Contract(
```
-
-```typescript title="Contract instances for the Universal Profile and Vault"
+```typescript
// create an instance of the LSP9Vault
const vault = new ethers.Contract(vaultAddress, LSP9Vault.abi);
// create an instance of the Universal Profile
@@ -270,7 +257,6 @@ const universalProfile = new ethers.Contract(
```
-
### Encode `setData(..)` calldata
@@ -278,10 +264,9 @@ const universalProfile = new ethers.Contract(
Secondly, we need to encode a calldata that will update the address of the Vault URD.
-
-```typescript title="Calldata for updating the LSP9 Vault URD"
+```typescript
// encode setData Calldata on the Vault
const setDataCalldata = await vault.methods
.setData(ERC725YDataKeys.LSP1.LSP1UniversalReceiverDelegate, vaultURDAddress)
@@ -289,10 +274,9 @@ const setDataCalldata = await vault.methods
```
-
-```typescript title="Calldata for updating the LSP9 Vault URD"
+```typescript
// encode setData Calldata on the Vault
const setDataCalldata = vault.interface.encodeFunctionData('setData', [
ERC725YDataKeys.LSP1.LSP1UniversalReceiverDelegate,
@@ -301,7 +285,6 @@ const setDataCalldata = vault.interface.encodeFunctionData('setData', [
```
-
### Update the Vault data
@@ -309,10 +292,9 @@ const setDataCalldata = vault.interface.encodeFunctionData('setData', [
Lastly, we need to send the transaction that will update the Vault data through the Universal Profile's `execute(..)`.
-
-```typescript title="Execute the calldata on the Universal Profile"
+```typescript
// execute the `setData(bytes32,bytes)` calldata that updates the Vault data
await universalProfile.methods
.execute(
@@ -331,7 +313,7 @@ await universalProfile.methods
-```typescript title="Execute the calldata on the Universal Profile"
+```typescript
// execute the `setData(bytes32,bytes)` calldata that updates the Vault data
await universalProfile.connect(myEOA).execute(
0, // OPERATION CALL
@@ -342,16 +324,14 @@ await universalProfile.connect(myEOA).execute(
```
-
### Final code
-
-```typescript title="Update Vault's URD to the one newly deployed"
+```typescript
const updateVaultURD = async (vaultURDAddress) => {
// create an instance of the LSP9Vault
const vault = new web3.eth.Contract(LSP9Vault.abi, vaultAddress);
@@ -388,10 +368,9 @@ await updateVaultURD(vaultURDAddress);
```
-
-```typescript title="Update Vault's URD to the one newly deployed"
+```typescript
const updateVaultURD = async (vaultURDAddress) => {
// create an instance of the LSP9Vault
const vault = new ethers.Contract(vaultAddress, LSP9Vault.abi);
@@ -421,20 +400,18 @@ await updateVaultURD(vaultURDAddress);
```
-
## Final code - Deploy & Update
-
```typescript title="Deploy new Vault URD and update Vault's URD"
import LSP1UniversalReceiverDelegateVault from '@lukso/lsp-smart-contracts/artifacts/LSP1UniversalReceiverDelegateVault.json';
import UniversalProfile from '@lukso/lsp-smart-contracts/artifacts/UniversalProfile.json';
import LSP9Vault from '@lukso/lsp-smart-contracts/artifacts/LSP9Vault.json';
-import { ERC725YDataKeys } from '@lukso/lsp-smart-contracts/constants.js';
+import { ERC725YDataKeys } from '@lukso/lsp-smart-contracts';
import Web3 from 'web3';
const web3 = new Web3('https://rpc.testnet.lukso.network');
@@ -459,7 +436,7 @@ const deployVaultURD = async () => {
})
.send({
from: myEOA.address,
- gas: 5_000_000,
+ gas: '5000000',
gasPrice: '1000000000',
})
.on('receipt', (receipt) => (vaultURDAddress = receipt.contractAddress));
@@ -505,14 +482,14 @@ await updateVaultURD(vaultURDAddress);
```
-
+
-```typescript title="Deploy new Vault URD and update Vault's URD"
+```typescript
import LSP1UniversalReceiverDelegateVault from '@lukso/lsp-smart-contracts/artifacts/LSP1UniversalReceiverDelegateVault.json';
import UniversalProfile from '@lukso/lsp-smart-contracts/artifacts/UniversalProfile.json';
import LSP9Vault from '@lukso/lsp-smart-contracts/artifacts/LSP9Vault.json';
-import { ERC725YDataKeys } from '@lukso/lsp-smart-contracts/constants.js';
+import { ERC725YDataKeys } from '@lukso/lsp-smart-contracts';
import { ethers } from 'ethers';
const provider = new ethers.providers.JsonRpcProvider(
@@ -571,7 +548,6 @@ await updateVaultURD(vaultURDAddress);
```
-
## Reading Data
diff --git a/docs/learn/expert-guides/web3-onboard.md b/docs/learn/expert-guides/web3-onboard.md
deleted file mode 100644
index aedcffbf50..0000000000
--- a/docs/learn/expert-guides/web3-onboard.md
+++ /dev/null
@@ -1,28 +0,0 @@
----
-sidebar_label: '🛳️ Connect Web3-Onboard'
-sidebar_position: 5
----
-
-# Connect users' wallets to your dApp with web3-onboard
-
-## The easiest way to connect a wallet 🚀
-
-
-
-Web3-onboard configuration allows the detection of the [Universal Profile (UP) Browser Extension](https://chrome.google.com/webstore/search/lukso%20blockchain), along with any other installed browser extensions. Developers can integrate it into their Dapp to handle the routing for the different browser extensions.
-
-Web3-onboard is an open-source, framework-agnostic JavaScript library to onboard users to web3 apps. This package can be used to integrate LUKSO [Universal Profiles Extension](https://chrome.google.com/webstore/detail/universal-profiles/abpickdkkbnbcoepogfhkhennhfhehfn?hl=en) support into web3-onboard's "Connect Wallet" modal. With this module, **the LUKSO Universal Profile Extension option will be shown even if the extension is not installed on the user's browser**. If selected the user will be taken to a download screen where they can install the extension.
-
-## Installation
-
-Developers can install web3-onboard in their Dapp using npm, from the [following package](https://www.npmjs.com/package/@lukso/web3-onboard-config). The implementation can be found in the [web3-onboard-config LUKSO GitHub repo](https://github.com/lukso-network/web3-onboard-config).
-
-```shell
-npm i @web3-onboard/core @lukso/web3-onboard-config @web3-onboard/injected-wallets
-```
-
-You can find a link to web3-onboard's official npm documentation here: [@web3-onboard/core official npm documentation](https://www.npmjs.com/package/@web3-onboard/core)
-
-## Where can I test it out?
-
-Users can experiment with LUKSO's web3-onboard implementation in a sandbox environment using [up-test-dapp.lukso.tech](https://up-test-dapp.lukso.tech/).
diff --git a/docs/learn/smart-contract-developers/retrieve-token-type.md b/docs/learn/smart-contract-developers/retrieve-token-type.md
index 76e09c15c9..6c19e5bacf 100644
--- a/docs/learn/smart-contract-developers/retrieve-token-type.md
+++ b/docs/learn/smart-contract-developers/retrieve-token-type.md
@@ -29,7 +29,7 @@ The `LSP4TokenType` is not changeable and it is set during the token's initializ
| Value | Type | Description |
| :---: | :----------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `0` | `Token` | Only valid for LSP7, meaning its a generic token, where the `LSP4Metadata` represents the token information. |
-| `1` | `NFT` | If the contract is LSP7 or LSP8, then the `LSP4Metadata` represents the information of a **single** NFT, that has multiple ownable amounts or IDs. If it's an LSP8, each individual token ID can have its own custom metadata specific for that toekn, but is not a different NFT. It is still the the same NFT but just has different metadata. Metadata can be set using `LSP8TokenIdType` and `LSP8MetadataTokenURI`. [See LSP8 for details](../../standards/tokens/LSP8-Identifiable-Digital-Asset.md). If its an LSP7 contract, the `decimals` function MUST return `0`. |
+| `1` | `NFT` | If the contract is LSP7 or LSP8, then the `LSP4Metadata` represents the information of a **single** NFT, that has multiple ownable amounts or IDs. If it's an LSP8, each individual token ID can have its own custom metadata specific for that token, but is not a different NFT. It is still the the same NFT but just has different metadata. Metadata can be set using `LSP8TokenIdType` and `LSP8MetadataTokenURI`. [See LSP8 for details](../../standards/tokens/LSP8-Identifiable-Digital-Asset.md). If its an LSP7 contract, the `decimals` function MUST return `0`. |
| `2` | `Collection` | Only valid for LSP8. The `LSP4Metadata` represents the information of a the collection, and each individual token ID represents its own NFT and MUST have its own metadata set using `LSP8TokenIdType` and `LSP8MetadataTokenURI`. [See LSP8 for details](../../standards/tokens/LSP8-Identifiable-Digital-Asset.md). |
## Implementation
diff --git a/docs/networks/advanced-guides/exit-validators.md b/docs/networks/advanced-guides/exit-validators.md
new file mode 100644
index 0000000000..d3f4b8227d
--- /dev/null
+++ b/docs/networks/advanced-guides/exit-validators.md
@@ -0,0 +1,54 @@
+---
+sidebar_label: 'Exit Validators'
+sidebar_position: 5
+---
+
+# Exit Validators
+
+In order to fully exit validator keys and all the staked LYX/LYXt, make sure to:
+
+- Have the latest [LUKSO CLI](https://github.com/lukso-network/tools-lukso-cli) installed. If not, you should [update your node](./update-the-node.md).
+- Have the Withdrawal Credential set. If not, you should [perform an withdrawal update](./withdrawal-update.md).
+
+If you are not using the LUKSO CLI, please check the [Further Reads](#further-reads) section below.
+
+## Perform the withdrawal
+
+After your node is synced up and running, you will be able to go through the complete exit process using the following command:
+
+```bash
+lukso validator exit
+```
+
+The exit setup will be different depending on your consensus client. Within [Prysm](https://docs.prylabs.network/docs/getting-started), you can select all or a specific number of validators by navigating the user interface in the terminal and selecting the public keys. For [Lighthouse](https://lighthouse-book.sigmaprime.io/intro.html), you have to input your validator and exit one at a time.
+
+:::info Exit Submission
+
+After the setup is completed, the validator exit credential is submitted to the blockchain without interruption. You can use `Ctrl+C` to stop the exit process anytime.
+
+:::
+
+## Check the withdrawal status
+
+A maximum of 16 validator keys can exit per block. Depending on the number of exits in the queue, the change might take several hours to be included in a block. If the exit is not showing up after several hours, consider re-doing the exit within the terminal.
+
+1. Open the Validator withdrawal page of the related network:
+ - [LUKSO Mainnet Validator withdrawals](https://explorer.consensus.mainnet.lukso.network/validators/withdrawals)
+ - [LUKSO Testnet Validator withdrawals](https://explorer.consensus.testnet.lukso.network/validators/withdrawals)
+2. Input your validator's public key or index as described in the [withdrawal Update Guide](./withdrawal-update.md)
+3. If the exit has been successfully submitted, the page will show an estimated exit time
+
+:::info
+
+Your validators stay active until the full withdrawal exit time. Ensure your node runs to this point to gain further rewards and fees. If your node is offline, you will get penalized and lose your stake.
+
+:::
+
+## Further Reads
+
+If you are using Dappnode or a custom client, please refer to the following sources:
+
+- [Exit Dappnode Validators](https://discourse.dappnode.io/t/how-to-exit-your-validator-from-the-ui/1745)
+- [Prysm Validator Exit Documentation](https://docs.prylabs.network/docs/wallet/exiting-a-validator)
+- [Lighthouse Withdrawal Guide](https://lighthouse-book.sigmaprime.io/voluntary-exit.html)
+- [How to exit Teku Validators](https://docs.teku.consensys.io/how-to/voluntarily-exit)
diff --git a/docs/networks/mainnet/parameters.md b/docs/networks/mainnet/parameters.md
index 9e4d47090d..47bc0f17ab 100644
--- a/docs/networks/mainnet/parameters.md
+++ b/docs/networks/mainnet/parameters.md
@@ -7,18 +7,19 @@ import AddNetworkButton from '../../../src/components/AddNetworkButton'
# Network Parameters
-| Setting | Value |
-| ------------------------ | ---------------------------------------------------------------------------------------------------- |
-| Network Name | Mainnet |
-| Genesis Fork Version | 0x42000001 |
-| Chain ID / Network ID | 42 |
-| Currency Symbol | LYX |
-| Execution Block Explorer | [https://explorer.execution.mainnet.lukso.network](https://explorer.execution.mainnet.lukso.network) |
-| Execution Status Page | [https://stats.execution.mainnet.lukso.network](https://stats.execution.mainnet.lukso.network) |
-| Consensus Block Explorer | [https://explorer.consensus.mainnet.lukso.network](https://explorer.consensus.mainnet.lukso.network) |
-| Consensus Status Page | [https://stats.consensus.mainnet.lukso.network](https://stats.consensus.mainnet.lukso.network) |
-| Launchpad | [https://deposit.mainnet.lukso.network](https://deposit.mainnet.lukso.network) |
-| Checkpoints | [https://checkpoints.mainnet.lukso.network](https://checkpoints.mainnet.lukso.network) |
+| Setting | Value |
+| ------------------------ | ------------------------------------------------------------------------------------------------------------ |
+| Network Name | Mainnet |
+| Genesis Fork Version | 0x42000001 |
+| Chain ID / Network ID | 42 |
+| Currency Symbol | LYX |
+| Execution Block Explorer | [https://explorer.execution.mainnet.lukso.network](https://explorer.execution.mainnet.lukso.network) |
+| Blockscout API | [https://explorer.execution.mainnet.lukso.network/api](https://explorer.execution.mainnet.lukso.network/api) |
+| Execution Status Page | [https://stats.execution.mainnet.lukso.network](https://stats.execution.mainnet.lukso.network) |
+| Consensus Block Explorer | [https://explorer.consensus.mainnet.lukso.network](https://explorer.consensus.mainnet.lukso.network) |
+| Consensus Status Page | [https://stats.consensus.mainnet.lukso.network](https://stats.consensus.mainnet.lukso.network) |
+| Launchpad | [https://deposit.mainnet.lukso.network](https://deposit.mainnet.lukso.network) |
+| Checkpoints | [https://checkpoints.mainnet.lukso.network](https://checkpoints.mainnet.lukso.network) |
The mainnet network configs are defined or the [`lukso-network/network-configs`](https://github.com/lukso-network/network-configs/tree/main/mainnet/shared) repo.
diff --git a/docs/networks/testnet/parameters.md b/docs/networks/testnet/parameters.md
index 1be8c943b4..0387bd51b2 100644
--- a/docs/networks/testnet/parameters.md
+++ b/docs/networks/testnet/parameters.md
@@ -9,21 +9,22 @@ The Public Testnet runs alongside the LUKSO mainnet for developers to test dApps
## Network Parameters
-| Setting | Value |
-| ------------------------ | ---------------------------------------------------------------------------------------------------- |
-| Network Name | Testnet |
-| Fork Version | 0x42010001 |
-| Chain ID / Network ID | 4201 |
-| Currency Symbol | LYXt |
-| RPC URL | [https://rpc.testnet.lukso.network](https://rpc.testnet.lukso.network) |
-| Websocket RPC URL | [wss://ws-rpc.testnet.lukso.network](wss://ws-rpc.testnet.lukso.network) |
-| Execution Block Explorer | [https://explorer.execution.testnet.lukso.network](https://explorer.execution.testnet.lukso.network) |
-| Execution Status Page | [https://stats.execution.testnet.lukso.network](https://stats.execution.testnet.lukso.network) |
-| Consensus Block Explorer | [https://explorer.consensus.testnet.lukso.network](https://explorer.consensus.testnet.lukso.network) |
-| Consensus Status Page | [https://stats.consensus.testnet.lukso.network](https://stats.consensus.testnet.lukso.network) |
-| Faucet | [https://faucet.testnet.lukso.network](https://faucet.testnet.lukso.network) |
-| Launchpad | [https://deposit.testnet.lukso.network](https://deposit.testnet.lukso.network) |
-| Checkpoints | [https://checkpoints.testnet.lukso.network](https://checkpoints.testnet.lukso.network) |
+| Setting | Value |
+| ------------------------ | ------------------------------------------------------------------------------------------------------------ |
+| Network Name | Testnet |
+| Fork Version | 0x42010001 |
+| Chain ID / Network ID | 4201 |
+| Currency Symbol | LYXt |
+| RPC URL | [https://rpc.testnet.lukso.network](https://rpc.testnet.lukso.network) |
+| Websocket RPC URL | [wss://ws-rpc.testnet.lukso.network](wss://ws-rpc.testnet.lukso.network) |
+| Execution Block Explorer | [https://explorer.execution.testnet.lukso.network](https://explorer.execution.testnet.lukso.network) |
+| Blockscout API | [https://explorer.execution.testnet.lukso.network/api](https://explorer.execution.testnet.lukso.network/api) |
+| Execution Status Page | [https://stats.execution.testnet.lukso.network](https://stats.execution.testnet.lukso.network) |
+| Consensus Block Explorer | [https://explorer.consensus.testnet.lukso.network](https://explorer.consensus.testnet.lukso.network) |
+| Consensus Status Page | [https://stats.consensus.testnet.lukso.network](https://stats.consensus.testnet.lukso.network) |
+| Faucet | [https://faucet.testnet.lukso.network](https://faucet.testnet.lukso.network) |
+| Launchpad | [https://deposit.testnet.lukso.network](https://deposit.testnet.lukso.network) |
+| Checkpoints | [https://checkpoints.testnet.lukso.network](https://checkpoints.testnet.lukso.network) |
The testnet network configs are defined or the [`lukso-network/network-configs`](https://github.com/lukso-network/network-configs/tree/main/testnet/shared) repo.
diff --git a/docs/standards/generic-standards/lsp2-json-schema.md b/docs/standards/generic-standards/lsp2-json-schema.md
index 6ffb1d2adb..f81eb795c5 100644
--- a/docs/standards/generic-standards/lsp2-json-schema.md
+++ b/docs/standards/generic-standards/lsp2-json-schema.md
@@ -137,7 +137,7 @@ The data being mapped can be words that have a specific meaning for the protocol
Below are some examples of the **Mapping** key type.
-- mapping to **words:** `SupportedStandards:LSP3UniversalProfile`, `SupportedStandards:LSP4DigitalAsset`, `SupportedStandards:LSP{N}{StandardName}`, etc...
+- mapping to **words:** `SupportedStandards:LSP3Profile`, `SupportedStandards:LSP4DigitalAsset`, `SupportedStandards:LSP{N}{StandardName}`, etc...
- mapping to **``**, like an `address`: `LSP5ReceivedAssetsMap:`
- mapping to **``**, like a `bytes32`: `LSP8MetadataAddress:`
@@ -145,8 +145,8 @@ Below are some examples of the **Mapping** key type.
```json
{
- "name": "SupportedStandards:LSP3UniversalProfile",
- "key": "0xeafec4d89fa9619884b60000abe425d64acd861a49b8ddf5c0b6962110481f38",
+ "name": "SupportedStandards:LSP3Profile",
+ "key": "0xeafec4d89fa9619884b600005ef83ad9559033e6e941db7d7c495acdce616347",
"keyType": "Mapping",
"valueType": "bytes4",
"valueContent": "0xabe425d6"
diff --git a/docs/standards/tokens/LSP7-Digital-Asset.md b/docs/standards/tokens/LSP7-Digital-Asset.md
index 5edd48092c..c3d2bd3f5a 100644
--- a/docs/standards/tokens/LSP7-Digital-Asset.md
+++ b/docs/standards/tokens/LSP7-Digital-Asset.md
@@ -31,7 +31,7 @@ Fungible assets such as **[ERC20](https://eips.ethereum.org/EIPS/eip-20)**, **[E
LSP7-DigitalAsset is an interface standard which describes a set of methods that fungible asset contracts should implement which other contracts and clients can call.
-This standard was based on **[ERC20](https://eips.ethereum.org/EIPS/eip-20)** and **[ERC777](https://eips.ethereum.org/EIPS/eip-777)** with additional features mentioned below:
+This standard was based on the ideas of **[ERC20](https://eips.ethereum.org/EIPS/eip-20)** and **[ERC777](https://eips.ethereum.org/EIPS/eip-777)**. While it does not integrate all the functionality from [ERC777](https://eips.ethereum.org/EIPS/eip-777), LSP7 comes with the additional features mentioned below:
### Divisible _vs_ Non-Divisible
diff --git a/docs/standards/universal-profile/lsp3-profile-metadata.md b/docs/standards/universal-profile/lsp3-profile-metadata.md
index 108a70be9a..47394557aa 100644
--- a/docs/standards/universal-profile/lsp3-profile-metadata.md
+++ b/docs/standards/universal-profile/lsp3-profile-metadata.md
@@ -28,19 +28,19 @@ Make sure to understand the **[ERC725Y Generic Key/Value Store](../lsp-backgroun
:::
-### `SupportedStandards:LSP3UniversalProfile`
+### `SupportedStandards:LSP3Profile`
```json
{
- "name": "SupportedStandards:LSP3UniversalProfile",
- "key": "0xeafec4d89fa9619884b60000abe425d64acd861a49b8ddf5c0b6962110481f38",
+ "name": "SupportedStandards:LSP3Profile",
+ "key": "0xeafec4d89fa9619884b600005ef83ad9559033e6e941db7d7c495acdce616347",
"keyType": "Mapping",
"valueType": "bytes4",
- "valueContent": "0xabe425d6"
+ "valueContent": "0x5ef83ad9"
}
```
-This data key is used to know if the contract represents a **Universal Profile**.
+This data key is used to know if the contract contains some metadata to display as a profile.
### `LSP3Profile`
diff --git a/docs/standards/universal-profile/lsp6-key-manager.md b/docs/standards/universal-profile/lsp6-key-manager.md
index 28a561ba7c..363ab35e4e 100644
--- a/docs/standards/universal-profile/lsp6-key-manager.md
+++ b/docs/standards/universal-profile/lsp6-key-manager.md
@@ -886,7 +886,7 @@ The relay transactions are signed using the [**version 0 of EIP191**](https://gi
### Out of order execution
-Since the Key Manager offers **relay execution** via signed message, it's important to provide security measurements to ensure that the signed message can't be repeated once executed. **[Nonces](https://www.techtarget.com/searchsecurity/definition/nonce#:~:text=A%20nonce%20is%20a%20random,to%20as%20a%20cryptographic%20nonce.)** existed to solve this problem, but with the following drawback:
+Since the Key Manager offers **relay execution** via signed message, it's important to provide security measurements to ensure that the signed message can't be repeated once executed. **[Nonces](https://www.techtarget.com/searchsecurity/definition/nonce#:~:text=A%20nonce%20is%20a%20random,to%20as%20a%20cryptographic%20nonce.)** exist to solve this problem, but with the following drawback:
- Signed messages with sequential nonces should be **executed in order**, meaning a signed message with nonce 4 can't be executed before the signed message with nonce 3. This is a critical problem which can limit the usage of relay execution.
diff --git a/docs/tools/erc725js/classes/ERC725.md b/docs/tools/erc725js/classes/ERC725.md
index bca09a3409..8bce7c8ecf 100644
--- a/docs/tools/erc725js/classes/ERC725.md
+++ b/docs/tools/erc725js/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
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([ +
string[ ] or
number or
number[ ] or
boolean or
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 @@ -1450,8 +1603,8 @@ Either a string of the hexadecimal `interfaceID` as defined by [ERC165](https:// | `LSP1UniversalReceiver` | [LSP-1: Universal Receiver](https://docs.lukso.tech/standards/generic-standards/lsp1-universal-receiver) | | `LSP1UniversalReceiverDelegate` | [LSP-1: Universal Receiver Delegate](https://docs.lukso.tech/standards/universal-profile/lsp1-universal-receiver-delegate) | | `LSP6KeyManager` | [LSP-6: Key Manager](https://docs.lukso.tech/standards/universal-profile/lsp6-key-manager) | -| `LSP7DigitalAsset` | [LSP-7: Digital Asset](https://docs.lukso.tech/standards/tokens/LSP7-Digital-Asset) | -| `LSP8IdentifiableDigitalAsset` | [LSP-8: Identifiable Digital Asset](https://docs.lukso.tech/standards/tokens/LSP8-Identifiable-Digital-Asset) | +| `LSP7DigitalAsset` | [LSP-7: Digital Asset](https://docs.lukso.tech/standards/nft-2.0/LSP7-Digital-Asset) | +| `LSP8IdentifiableDigitalAsset` | [LSP-8: Identifiable Digital Asset](https://docs.lukso.tech/standards/nft-2.0/LSP8-Identifiable-Digital-Asset) | | `LSP9Vault` | [LSP-9: Vault](https://docs.lukso.tech/standards/universal-profile/lsp9-vault) | :::info diff --git a/docs/tools/erc725js/getting-started.md b/docs/tools/erc725js/getting-started.md index 68abf9ff5e..1cb5477980 100644 --- a/docs/tools/erc725js/getting-started.md +++ b/docs/tools/erc725js/getting-started.md @@ -29,7 +29,6 @@ If you install it on the backend side, you may need to also install [`isomorphic ```js import { ERC725 } from '@erc725/erc725.js'; -import Web3 from 'web3'; // Part of LSP3-UniversalProfile Schema // https://github.com/lukso-network/LIPs/blob/master/LSPs/LSP-3-UniversalProfile.md diff --git a/docs/tools/lsp-factoryjs/deployment/digital-asset.md b/docs/tools/lsp-factoryjs/deployment/digital-asset.md index 53c38f7f17..c1cf203f9c 100644 --- a/docs/tools/lsp-factoryjs/deployment/digital-asset.md +++ b/docs/tools/lsp-factoryjs/deployment/digital-asset.md @@ -36,10 +36,10 @@ The [LSP7] standard can be useful for NFT collections where you want all tokens ```javascript await lspFactory.LSP7DigitalAsset.deploy({ - isNFT: true, - controllerAddress: '0x56fE4E7dc2bc0b6397E4609B07b4293482E3F72B', - name: 'MYTOKEN', - symbol: 'DEMO', + isNFT: true, + controllerAddress: '0x56fE4E7dc2bc0b6397E4609B07b4293482E3F72B', + name: 'MYTOKEN' + symbol: 'DEMO', }); ``` diff --git a/docs/tools/lsp-factoryjs/deployment/universal-profile.md b/docs/tools/lsp-factoryjs/deployment/universal-profile.md index 7b1fe0be7f..b6d4b356f7 100644 --- a/docs/tools/lsp-factoryjs/deployment/universal-profile.md +++ b/docs/tools/lsp-factoryjs/deployment/universal-profile.md @@ -5,7 +5,7 @@ title: Universal Profile # Deploying a Universal Profile -LSPFactory allows you to quickly deploy and configure a Universal Profile consisting of an [LSP0 ERC725 Account](../../../standards/universal-profile/lsp0-erc725account), an [LSP6 Key Manager](../../../standards/universal-profile/lsp6-key-manager), and an [LSP1-UniversalReceiver](../../../standards/generic-standards/lsp1-universal-receiver.md) smart contract: +LSPFactory allows you to quickly deploy and configure a Universal Profile consisting of an [LSP0 ERC725 Account](../../../standards/universal-profile/lsp0-erc725account.md), an [LSP6 Key Manager](../../../standards/universal-profile/lsp6-key-manager.md), and an [LSP1-UniversalReceiver](../../../standards/generic-standards/lsp1-universal-receiver.md) smart contract: ```javascript await lspFactory.UniversalProfile.deploy(profileProperties [, options]); @@ -13,21 +13,21 @@ await lspFactory.UniversalProfile.deploy(profileProperties [, options]); This will deploy the following contracts: -- [LSP0 ERC725 Account](../../../standards/universal-profile/lsp0-erc725account) -- [LSP6 Key Manager](../../../standards/universal-profile/lsp6-key-manager) +- [LSP0 ERC725 Account](../../../standards/universal-profile/lsp0-erc725account.md) +- [LSP6 Key Manager](../../../standards/universal-profile/lsp6-key-manager.md) - And link to a pre-deployed [LSP1 Universal Receiver](../../../standards/generic-standards/lsp1-universal-receiver.md) After, it will: -- upload metadata to IPFS and set the [LSP3 Profile](../../../standards/universal-profile/lsp3-profile-metadata) metadata, +- upload metadata to IPFS and set the [LSP3 Profile](../../../standards/universal-profile/lsp3-profile-metadata.md) metadata, - attach the Universal Receiver Delegate to the ERC725 Account, - set the Key Manager as the owner of the ERC725 Account, and -- set all [permissions](../../../standards/universal-profile/lsp6-key-manager#-types-of-permissions) for the `controllerAddresses` except `DELEGATECALL`. +- set all [permissions](../../../standards/universal-profile/lsp6-key-manager#-types-of-permissions.md) for the `controllerAddresses` except `DELEGATECALL`. -These smart contracts linked with some [LSP3 Profile Metadata](../../../standards/universal-profile/lsp3-profile-metadata) form a Universal Profile. The metadata is the 'face' of your profile and contains information such as your name, description, and profile image. +These smart contracts linked with some [LSP3 Profile Metadata](../../../standards/universal-profile/lsp3-profile-metadata.md) form a Universal Profile. The metadata is the 'face' of your profile and contains information such as your name, description, and profile image. :::caution -The deployment key passed to LSPFactory will be given `CHANGEOWNER` and `EDITPERMISSIONS` [LSP6 permissions](../../../standards/universal-profile/lsp6-key-manager#-types-of-permissions) in order to carry out the Universal Profile deployment. +The deployment key passed to LSPFactory will be given `CHANGEOWNER` and `EDITPERMISSIONS` [LSP6 permissions](../../../standards/universal-profile/lsp6-key-manager#-types-of-permissions.md) in order to carry out the Universal Profile deployment. These permisisons are revoked as the final step of deployment. It is important this step is completed correctly to avoid security risks. @@ -64,13 +64,13 @@ await lspFactory.UniversalProfile.deploy({ ``` :::info Info -Profile Metadata can be passed as either a JSON object containing the [LSP3Metadata](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-3-UniversalProfile-Metadata.md#lsp3profile) you want to upload or a URL of your previously uploaded metadata. +Profile Metadata can be passed as either a JSON object containing the [LSP3Metadata](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-3-Profile-Metadata.md) you want to upload or a URL of your previously uploaded metadata. ::: If an LSP3MetaData object is passed, LSPFactory will process and upload your metadata to IPFS. :::info -See [Upload Options](././universal-profile#ipfs-upload-options) for details on how to specify a custom IPFS gateway. +See [Upload Options](././universal-profile#ipfs-upload-options.md) for details on how to specify a custom IPFS gateway. ::: ```javascript title='Uploading an LSP3 metadata automatically' @@ -320,13 +320,13 @@ await lspFactory.UniversalProfile.deploy({ ### Uploading LSP3 metadata to IPFS -You can upload your LSP3 metadata before deploying a Universal Profile using the `uploadProfileData()` method. The function uses the same [`lsp3Profile` object schema](./universal-profile#adding-lsp3-metadata) defined above when deploying a Universal Profile. Returns an object containing the IPFS upload location of your metadata and your `lsp3Metdata` as a javascript object. +You can upload your LSP3 metadata before deploying a Universal Profile using the `uploadProfileData()` method. The function uses the same [`lsp3Profile` object schema](./universal-profile#adding-lsp3-metadata.md) defined above when deploying a Universal Profile. Returns an object containing the IPFS upload location of your metadata and your `lsp3Metdata` as a javascript object. ```javascript await myLSPFactory.UniversalProfile.uploadProfileData(lsp3Profile [, options]); ``` -To upload using a custom IPFS gateway, pass the `options` object. The field is the same `options` object used when deploying a Universal Profile. [Read more](./universal-profile#ipfs-upload-options). +To upload using a custom IPFS gateway, pass the `options` object. The field is the same `options` object used when deploying a Universal Profile. [Read more](./universal-profile#ipfs-upload-options.md). The `uploadProfileData()` function is available as a static or non-static method to be called without instantiating an `LSPFactory` object. diff --git a/docs/tools/lsp-smart-contracts/constants.md b/docs/tools/lsp-smart-contracts/constants.md index 95487e5d30..4e8e749448 100644 --- a/docs/tools/lsp-smart-contracts/constants.md +++ b/docs/tools/lsp-smart-contracts/constants.md @@ -4,21 +4,42 @@ sidebar_position: 4 # Constants -The [`constants.js`](https://github.com/lukso-network/lsp-smart-contracts/blob/develop/constants.js) file exposes many useful variables. +The [`constants.ts`](https://github.com/lukso-network/lsp-smart-contracts/blob/develop/constants.ts) file exposes many useful variables. -```javascript +```ts import { INTERFACE_IDS, ERC1271, OPERATIONS, SupportedStandards, ERC725YDataKeys, - BasicUPSetup_Schema, PERMISSIONS, ALL_PERMISSIONS, - Errors, - EventSignatures, -} from '@lukso/lsp-smart-contracts/constants.js'; + LSP8_TOKEN_ID_TYPES, + LSP25_VERSION, + ErrorSelectors, + EventSigHashes, + FunctionSelectors, + ContractsDocs, + StateVariables, +} from '@lukso/lsp-smart-contracts'; +``` + +The following additional typescript types are also available, including types for the JSON format of the LSP3 Profile and LSP4 Digital Asset metadata. + +```ts +import { + LSP2ArrayKey, + LSPSupportedStandard, + LSP6PermissionName, + LSP3ProfileMetadataJSON, + LSP3ProfileMetadata, + LSP4DigitalAssetMetadataJSON, + LSP4DigitalAssetMetadata, + ImageMetadata, + LinkMetadata, + AssetMetadata, +} from '@lukso/lsp-smart-contracts'; ``` You can find the [interface IDs](../../contracts/interface-ids) of the smart contracts in or more information in the [`README.md`](https://github.com/lukso-network/lsp-smart-contracts/blob/develop/README.md). diff --git a/docusaurus.config.js b/docusaurus.config.js index bcc4605f06..7f7adefa4a 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -226,7 +226,7 @@ export default { }, { from: '/guides/browser-extension/web3-onboard', - to: '/learn/expert-guides/web3-onboard', + to: '/learn/dapp-developer/web3-onboard', }, { from: '/guides/browser-extension/install-browser-extension', diff --git a/scripts/tools-sync.sh b/scripts/tools-sync.sh index 629cc38937..05a9d17275 100644 --- a/scripts/tools-sync.sh +++ b/scripts/tools-sync.sh @@ -13,7 +13,7 @@ rsync -av --progress erc725.js/docs/. ../docs/tools/erc725js --exclude technical # Pull lsp-factory repo -git clone --depth 1 --branch main https://github.com/lukso-network/tools-lsp-factory.git +git clone --depth 1 --branch develop https://github.com/lukso-network/tools-lsp-factory.git # Copy Docs rsync -av --progress tools-lsp-factory/docs/. ../docs/tools/lsp-factoryjs --exclude=technical-reference diff --git a/src/pages/index.js b/src/pages/index.js index 4a01df20d4..ee12d4043d 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -25,13 +25,6 @@ function Index() { text="START BUILDING WITH LUKSO STANDARDS" />
-
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([ +
+
+
+---
+
+## 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 Encode array length
+ +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'], +} +*/ +``` + +string[ ] or
number or
number[ ] or
boolean or
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 @@ -1450,8 +1603,8 @@ Either a string of the hexadecimal `interfaceID` as defined by [ERC165](https:// | `LSP1UniversalReceiver` | [LSP-1: Universal Receiver](https://docs.lukso.tech/standards/generic-standards/lsp1-universal-receiver) | | `LSP1UniversalReceiverDelegate` | [LSP-1: Universal Receiver Delegate](https://docs.lukso.tech/standards/universal-profile/lsp1-universal-receiver-delegate) | | `LSP6KeyManager` | [LSP-6: Key Manager](https://docs.lukso.tech/standards/universal-profile/lsp6-key-manager) | -| `LSP7DigitalAsset` | [LSP-7: Digital Asset](https://docs.lukso.tech/standards/tokens/LSP7-Digital-Asset) | -| `LSP8IdentifiableDigitalAsset` | [LSP-8: Identifiable Digital Asset](https://docs.lukso.tech/standards/tokens/LSP8-Identifiable-Digital-Asset) | +| `LSP7DigitalAsset` | [LSP-7: Digital Asset](https://docs.lukso.tech/standards/nft-2.0/LSP7-Digital-Asset) | +| `LSP8IdentifiableDigitalAsset` | [LSP-8: Identifiable Digital Asset](https://docs.lukso.tech/standards/nft-2.0/LSP8-Identifiable-Digital-Asset) | | `LSP9Vault` | [LSP-9: Vault](https://docs.lukso.tech/standards/universal-profile/lsp9-vault) | :::info diff --git a/docs/tools/erc725js/getting-started.md b/docs/tools/erc725js/getting-started.md index 68abf9ff5e..1cb5477980 100644 --- a/docs/tools/erc725js/getting-started.md +++ b/docs/tools/erc725js/getting-started.md @@ -29,7 +29,6 @@ If you install it on the backend side, you may need to also install [`isomorphic ```js import { ERC725 } from '@erc725/erc725.js'; -import Web3 from 'web3'; // Part of LSP3-UniversalProfile Schema // https://github.com/lukso-network/LIPs/blob/master/LSPs/LSP-3-UniversalProfile.md diff --git a/docs/tools/lsp-factoryjs/deployment/digital-asset.md b/docs/tools/lsp-factoryjs/deployment/digital-asset.md index 53c38f7f17..c1cf203f9c 100644 --- a/docs/tools/lsp-factoryjs/deployment/digital-asset.md +++ b/docs/tools/lsp-factoryjs/deployment/digital-asset.md @@ -36,10 +36,10 @@ The [LSP7] standard can be useful for NFT collections where you want all tokens ```javascript await lspFactory.LSP7DigitalAsset.deploy({ - isNFT: true, - controllerAddress: '0x56fE4E7dc2bc0b6397E4609B07b4293482E3F72B', - name: 'MYTOKEN', - symbol: 'DEMO', + isNFT: true, + controllerAddress: '0x56fE4E7dc2bc0b6397E4609B07b4293482E3F72B', + name: 'MYTOKEN' + symbol: 'DEMO', }); ``` diff --git a/docs/tools/lsp-factoryjs/deployment/universal-profile.md b/docs/tools/lsp-factoryjs/deployment/universal-profile.md index 7b1fe0be7f..b6d4b356f7 100644 --- a/docs/tools/lsp-factoryjs/deployment/universal-profile.md +++ b/docs/tools/lsp-factoryjs/deployment/universal-profile.md @@ -5,7 +5,7 @@ title: Universal Profile # Deploying a Universal Profile -LSPFactory allows you to quickly deploy and configure a Universal Profile consisting of an [LSP0 ERC725 Account](../../../standards/universal-profile/lsp0-erc725account), an [LSP6 Key Manager](../../../standards/universal-profile/lsp6-key-manager), and an [LSP1-UniversalReceiver](../../../standards/generic-standards/lsp1-universal-receiver.md) smart contract: +LSPFactory allows you to quickly deploy and configure a Universal Profile consisting of an [LSP0 ERC725 Account](../../../standards/universal-profile/lsp0-erc725account.md), an [LSP6 Key Manager](../../../standards/universal-profile/lsp6-key-manager.md), and an [LSP1-UniversalReceiver](../../../standards/generic-standards/lsp1-universal-receiver.md) smart contract: ```javascript await lspFactory.UniversalProfile.deploy(profileProperties [, options]); @@ -13,21 +13,21 @@ await lspFactory.UniversalProfile.deploy(profileProperties [, options]); This will deploy the following contracts: -- [LSP0 ERC725 Account](../../../standards/universal-profile/lsp0-erc725account) -- [LSP6 Key Manager](../../../standards/universal-profile/lsp6-key-manager) +- [LSP0 ERC725 Account](../../../standards/universal-profile/lsp0-erc725account.md) +- [LSP6 Key Manager](../../../standards/universal-profile/lsp6-key-manager.md) - And link to a pre-deployed [LSP1 Universal Receiver](../../../standards/generic-standards/lsp1-universal-receiver.md) After, it will: -- upload metadata to IPFS and set the [LSP3 Profile](../../../standards/universal-profile/lsp3-profile-metadata) metadata, +- upload metadata to IPFS and set the [LSP3 Profile](../../../standards/universal-profile/lsp3-profile-metadata.md) metadata, - attach the Universal Receiver Delegate to the ERC725 Account, - set the Key Manager as the owner of the ERC725 Account, and -- set all [permissions](../../../standards/universal-profile/lsp6-key-manager#-types-of-permissions) for the `controllerAddresses` except `DELEGATECALL`. +- set all [permissions](../../../standards/universal-profile/lsp6-key-manager#-types-of-permissions.md) for the `controllerAddresses` except `DELEGATECALL`. -These smart contracts linked with some [LSP3 Profile Metadata](../../../standards/universal-profile/lsp3-profile-metadata) form a Universal Profile. The metadata is the 'face' of your profile and contains information such as your name, description, and profile image. +These smart contracts linked with some [LSP3 Profile Metadata](../../../standards/universal-profile/lsp3-profile-metadata.md) form a Universal Profile. The metadata is the 'face' of your profile and contains information such as your name, description, and profile image. :::caution -The deployment key passed to LSPFactory will be given `CHANGEOWNER` and `EDITPERMISSIONS` [LSP6 permissions](../../../standards/universal-profile/lsp6-key-manager#-types-of-permissions) in order to carry out the Universal Profile deployment. +The deployment key passed to LSPFactory will be given `CHANGEOWNER` and `EDITPERMISSIONS` [LSP6 permissions](../../../standards/universal-profile/lsp6-key-manager#-types-of-permissions.md) in order to carry out the Universal Profile deployment. These permisisons are revoked as the final step of deployment. It is important this step is completed correctly to avoid security risks. @@ -64,13 +64,13 @@ await lspFactory.UniversalProfile.deploy({ ``` :::info Info -Profile Metadata can be passed as either a JSON object containing the [LSP3Metadata](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-3-UniversalProfile-Metadata.md#lsp3profile) you want to upload or a URL of your previously uploaded metadata. +Profile Metadata can be passed as either a JSON object containing the [LSP3Metadata](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-3-Profile-Metadata.md) you want to upload or a URL of your previously uploaded metadata. ::: If an LSP3MetaData object is passed, LSPFactory will process and upload your metadata to IPFS. :::info -See [Upload Options](././universal-profile#ipfs-upload-options) for details on how to specify a custom IPFS gateway. +See [Upload Options](././universal-profile#ipfs-upload-options.md) for details on how to specify a custom IPFS gateway. ::: ```javascript title='Uploading an LSP3 metadata automatically' @@ -320,13 +320,13 @@ await lspFactory.UniversalProfile.deploy({ ### Uploading LSP3 metadata to IPFS -You can upload your LSP3 metadata before deploying a Universal Profile using the `uploadProfileData()` method. The function uses the same [`lsp3Profile` object schema](./universal-profile#adding-lsp3-metadata) defined above when deploying a Universal Profile. Returns an object containing the IPFS upload location of your metadata and your `lsp3Metdata` as a javascript object. +You can upload your LSP3 metadata before deploying a Universal Profile using the `uploadProfileData()` method. The function uses the same [`lsp3Profile` object schema](./universal-profile#adding-lsp3-metadata.md) defined above when deploying a Universal Profile. Returns an object containing the IPFS upload location of your metadata and your `lsp3Metdata` as a javascript object. ```javascript await myLSPFactory.UniversalProfile.uploadProfileData(lsp3Profile [, options]); ``` -To upload using a custom IPFS gateway, pass the `options` object. The field is the same `options` object used when deploying a Universal Profile. [Read more](./universal-profile#ipfs-upload-options). +To upload using a custom IPFS gateway, pass the `options` object. The field is the same `options` object used when deploying a Universal Profile. [Read more](./universal-profile#ipfs-upload-options.md). The `uploadProfileData()` function is available as a static or non-static method to be called without instantiating an `LSPFactory` object. diff --git a/docs/tools/lsp-smart-contracts/constants.md b/docs/tools/lsp-smart-contracts/constants.md index 95487e5d30..4e8e749448 100644 --- a/docs/tools/lsp-smart-contracts/constants.md +++ b/docs/tools/lsp-smart-contracts/constants.md @@ -4,21 +4,42 @@ sidebar_position: 4 # Constants -The [`constants.js`](https://github.com/lukso-network/lsp-smart-contracts/blob/develop/constants.js) file exposes many useful variables. +The [`constants.ts`](https://github.com/lukso-network/lsp-smart-contracts/blob/develop/constants.ts) file exposes many useful variables. -```javascript +```ts import { INTERFACE_IDS, ERC1271, OPERATIONS, SupportedStandards, ERC725YDataKeys, - BasicUPSetup_Schema, PERMISSIONS, ALL_PERMISSIONS, - Errors, - EventSignatures, -} from '@lukso/lsp-smart-contracts/constants.js'; + LSP8_TOKEN_ID_TYPES, + LSP25_VERSION, + ErrorSelectors, + EventSigHashes, + FunctionSelectors, + ContractsDocs, + StateVariables, +} from '@lukso/lsp-smart-contracts'; +``` + +The following additional typescript types are also available, including types for the JSON format of the LSP3 Profile and LSP4 Digital Asset metadata. + +```ts +import { + LSP2ArrayKey, + LSPSupportedStandard, + LSP6PermissionName, + LSP3ProfileMetadataJSON, + LSP3ProfileMetadata, + LSP4DigitalAssetMetadataJSON, + LSP4DigitalAssetMetadata, + ImageMetadata, + LinkMetadata, + AssetMetadata, +} from '@lukso/lsp-smart-contracts'; ``` You can find the [interface IDs](../../contracts/interface-ids) of the smart contracts in or more information in the [`README.md`](https://github.com/lukso-network/lsp-smart-contracts/blob/develop/README.md). diff --git a/docusaurus.config.js b/docusaurus.config.js index bcc4605f06..7f7adefa4a 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -226,7 +226,7 @@ export default { }, { from: '/guides/browser-extension/web3-onboard', - to: '/learn/expert-guides/web3-onboard', + to: '/learn/dapp-developer/web3-onboard', }, { from: '/guides/browser-extension/install-browser-extension', diff --git a/scripts/tools-sync.sh b/scripts/tools-sync.sh index 629cc38937..05a9d17275 100644 --- a/scripts/tools-sync.sh +++ b/scripts/tools-sync.sh @@ -13,7 +13,7 @@ rsync -av --progress erc725.js/docs/. ../docs/tools/erc725js --exclude technical # Pull lsp-factory repo -git clone --depth 1 --branch main https://github.com/lukso-network/tools-lsp-factory.git +git clone --depth 1 --branch develop https://github.com/lukso-network/tools-lsp-factory.git # Copy Docs rsync -av --progress tools-lsp-factory/docs/. ../docs/tools/lsp-factoryjs --exclude=technical-reference diff --git a/src/pages/index.js b/src/pages/index.js index 4a01df20d4..ee12d4043d 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -25,13 +25,6 @@ function Index() { text="START BUILDING WITH LUKSO STANDARDS" />
-