Skip to content

Commit

Permalink
Merge pull request #198 from lukso-network/docs/lsp3
Browse files Browse the repository at this point in the history
docs: change reference of LSP3 to LSP3-Profile-Metadata
  • Loading branch information
CallumGrindle authored Aug 2, 2023
2 parents d9f1983 + 194a744 commit ff22867
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions docs/classes/universal-profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Deploys and **configures** a [Universal Profile](../../../standards/universal-pr

After, it will:

- upload metadata to IPFS and set the [LSP3 Universal Profile](../../../standards/universal-profile/lsp3-universal-profile-metadata) metadata,
- upload metadata to IPFS and set the [LSP3 Profile](../../../standards/universal-profile/lsp3-profile-metadata) metadata,
- attach the Universal Receiver Delegate to the ERC725 Account contract,
- set the Key Manager as the owner of the LSP0 ERC725 Account, and
- set all [LSP6 Permissions](../../../standards/universal-profile/lsp6-key-manager#-types-of-permissions) to the `controllerAddresses` except `DELEGATECALL`.
Expand Down Expand Up @@ -310,7 +310,7 @@ Deployment Complete
lspFactory.UniversalProfile.uploadProfileData(profileData [, options]);
```

Processes and uploads the [LSP3Profile Metadata](../../../standards/universal-profile/lsp3-universal-profile-metadata) to IPFS. The IPFS gateway can be set inside the `options` object.
Processes and uploads the [LSP3Profile Metadata](../../../standards/universal-profile/lsp3-profile-metadata) to IPFS. The IPFS gateway can be set inside the `options` object.

Will resize and upload passed images.

Expand All @@ -320,7 +320,7 @@ Available as a static or non-static method callable on the LSPFactory library in

#### 1. `profileData` - Object

Object containing the [LSP3 Metadata](../../../standards/universal-profile/lsp3-universal-profile-metadata) fields which will be processed and uploaded to IPFS.
Object containing the [LSP3 Metadata](../../../standards/universal-profile/lsp3-profile-metadata) fields which will be processed and uploaded to IPFS.

:::info
[Read more about how LSP3 Metadata is processed here](../deployment/universal-profile#uploading-lsp3-metadata-to-ipfs).
Expand Down Expand Up @@ -559,4 +559,4 @@ await UniversalProfile.uploadProfileData(
```

[all permissions]: ../../../../../standards/universal-profile/lsp6-key-manager#-address-permissions
[lsp3]: ../../../standards/universal-profile/lsp3-universal-profile-metadata
[lsp3]: ../../../standards/universal-profile/lsp3-profile-metadata
8 changes: 4 additions & 4 deletions docs/deployment/universal-profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@ This will deploy the following contracts:

After, it will:

- upload metadata to IPFS and set the [LSP3 Universal Profile](../../../standards/universal-profile/lsp3-universal-profile-metadata) metadata,
- upload metadata to IPFS and set the [LSP3 Profile](../../../standards/universal-profile/lsp3-profile-metadata) 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`.

These smart contracts linked with some [LSP3 Universal Profile Metadata](../../../standards/universal-profile/lsp3-universal-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) 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 `CHANGEPERMISSIONS` [LSP6 permissions](../../../standards/universal-profile/lsp6-key-manager#-types-of-permissions) in order to carry out the Universal Profile deployment.
Expand Down Expand Up @@ -207,9 +207,9 @@ An avatar can be set by passing the `avatar` property to the `lsp3Profile` objec

An avatar can be passed as an array where each element is a different file format of the same avatar. Each file format can be passed as a `File` object, or asset metadata object according to the [LSP2 ERC725Y JSON Schema standard](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-2-ERC725YJSONSchema.md#Array).

If an avatar file is passed as a `File` object, the file will uploaded to IPFS, converted to the correct asset metadata format and added to the [LSP3 Profile Metadata](https://docs.lukso.tech/standards/universal-profile/lsp3-universal-profile-metadata) Json.
If an avatar file is passed as a `File` object, the file will uploaded to IPFS, converted to the correct asset metadata format and added to the [LSP3 Profile Metadata](https://docs.lukso.tech/standards/universal-profile/lsp3-profile-metadata) Json.

Avatar files passed as a metadata objects will be set directly on the [LSP3 Profile Metadata](https://docs.lukso.tech/standards/universal-profile/lsp3-universal-profile-metadata) Json.
Avatar files passed as a metadata objects will be set directly on the [LSP3 Profile Metadata](https://docs.lukso.tech/standards/universal-profile/lsp3-profile-metadata) Json.

```javascript title='Setting LSP3 metadata to be uploaded with an avatar with two formats'
<input type="file" id="avatar">
Expand Down

0 comments on commit ff22867

Please sign in to comment.