Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

replace uploadMetaData by uploadProfileData #619

Merged
merged 2 commits into from
Sep 19, 2023
Merged

replace uploadMetaData by uploadProfileData #619

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
304e407
replace lsp-factory > universalProfile > uploadMetaData by uploadProf…
kalote Sep 7, 2023
e7ffca7
Merge branch 'main' into fix/uploadProfileData
Hugoo Sep 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/tools/lsp-factoryjs/deployment/universal-profile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,18 +312,18 @@ await lspFactory.UniversalProfile.deploy({

### Uploading LSP3 metadata to IPFS

You can upload your LSP3 metadata before deploying a Universal Profile using the `uploadMetaData()` 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) 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.uploadMetaData(lsp3Profile [, options]);
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).

The `uploadMetaData()` function is available as a static or non-static method to be called without instantiating an `LSPFactory` object.
The `uploadProfileData()` function is available as a static or non-static method to be called without instantiating an `LSPFactory` object.

```javascript title="Calling uploadMetaData on an LSPFactory instance"
await myLSPFactory.UniversalProfile.uploadMetaData(myLSP3MetaData);
```javascript title="Calling uploadProfileData on an LSPFactory instance"
await myLSPFactory.UniversalProfile.uploadProfileData(myLSP3MetaData);

/**
{
Expand All @@ -341,8 +341,8 @@ await myLSPFactory.UniversalProfile.uploadMetaData(myLSP3MetaData);
*/
```

```javascript title="Calling uploadMetaData on the uninstantiated class"
await UniversalProfile.uploadMetaData(myLSP3MetaData);
```javascript title="Calling uploadProfileData on the uninstantiated class"
await UniversalProfile.uploadProfileData(myLSP3MetaData);

> // same as above
```
Expand Down