Merge pull request #135 from lukso-network/develop

chore: release v2.3.1
lukso-network · Jun 22, 2022 · 5d50fdb · 5d50fdb
2 parents 4acd545 + 53fec59
commit 5d50fdb
Show file tree

Hide file tree

Showing 12 changed files with 1,034 additions and 7,884 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [2.3.1](https://github.com/lukso-network/tools-lsp-factory/compare/v2.3.0...v2.3.1) (2022-06-22)
+
+### Features
+
+* add base contract addresses on L16 ([89c1358](https://github.com/lukso-network/tools-lsp-factory/commit/89c13585224ae8e4767111e3806316ed133f44e1))
+
 ## [2.3.0](https://github.com/lukso-network/tools-lsp-factory/compare/v2.2.0...v2.3.0) (2022-05-30)
 
 

diff --git a/README.md b/README.md
@@ -35,39 +35,32 @@ const lspFactory = new LSPFactory(provider, {
 const myContracts = await lspFactory.UniversalProfile.deploy({
   controllerAddresses: ['0x...'], // Address which will controll the UP
   lsp3Profile: {
-    json: {
-      LSP3Profile: {
-        name: 'My Universal Profile',
-        description: 'My cool Universal Profile',
-        profileImage: [
-          {
-            width: 500,
-            height: 500,
-            hashFunction: 'keccak256(bytes)',
-            // bytes32 hex string of the image hash
-            hash: '0xfdafad027ecfe57eb4ad047b938805d1dec209d6e9f960fc320d7b9b11cbed14',
-            url: 'ipfs://QmPLqMFHxiUgYAom3Zg4SiwoxDaFcZpHXpCmiDzxrtjSGp',
-          },
-        ],
-        backgroundImage: [
-          {
-            width: 500,
-            height: 500,
-            hashFunction: 'keccak256(bytes)',
-            // bytes32 hex string of the image hash
-            hash: '0xfdafad027ecfe57eb4ad047b938805d1dec209d6e9f960fc320d7b9b11cbed14',
-            url: 'ipfs://QmPLqMFHxiUgYAom3Zg4SiwoxDaFcZpHXpCmiDzxrtjSGp',
-          },
-        ],
-        tags: ['Fashion', 'Design'],
-        links: [{ title: 'My Website', url: 'www.my-website.com' }],
+    name: 'My Universal Profile',
+    description: 'My cool Universal Profile',
+    profileImage: [
+      {
+        width: 500,
+        height: 500,
+        hashFunction: 'keccak256(bytes)',
+        hash: '0xfdafad027ecfe57eb4ad047b938805d1dec209d6e9f960fc320d7b9b11cbed14',
+        url: 'ipfs://QmPLqMFHxiUgYAom3Zg4SiwoxDaFcZpHXpCmiDzxrtjSGp',
       },
-    },
-    url: '',
+    ],
+    backgroundImage: [
+      {
+        width: 500,
+        height: 500,
+        hashFunction: 'keccak256(bytes)',
+        hash: '0xfdafad027ecfe57eb4ad047b938805d1dec209d6e9f960fc320d7b9b11cbed14',
+        url: 'ipfs://QmPLqMFHxiUgYAom3Zg4SiwoxDaFcZpHXpCmiDzxrtjSGp',
+      },
+    ],
+    tags: ['Fashion', 'Design'],
+    links: [{ title: 'My Website', url: 'www.my-website.com' }],
   },
 });
 
-const myUPAddress = myContracts.ERC725Account.address;
+const myUPAddress = myContracts.LSP0ERC725Account.address;
 ```
 
 ### Using Deployment events

diff --git a/docs/classes/lsp7-digital-asset.md b/docs/classes/lsp7-digital-asset.md
@@ -13,6 +13,12 @@ lspFactory.LSP7DigitalAsset.deploy(digitalAssetProperties [, options]);
 
 Deploys a mintable [LSP7 Digital Asset](../../../standards/nft-2.0/LSP7-Digital-Asset).
 
+:::info
+By default LSPFactory deploys the [`Mintable`](https://github.com/lukso-network/lsp-smart-contracts/blob/develop/contracts/LSP7DigitalAsset/presets/LSP7Mintable.sol) implementation of LSP7 digital assets. To call the `mint` function import the `LSP7Mintable` abi from the [lsp-smart-contracts library](https://github.com/lukso-network/lsp-smart-contracts).
+
+:::
+
+
 ### Parameters
 
 #### 1. `digitalAssetProperties` - Object

diff --git a/docs/classes/lsp8-identifiable-digital-asset.md b/docs/classes/lsp8-identifiable-digital-asset.md
@@ -3,7 +3,7 @@ sidebar_position: 4
 title: LSP8IdentifiableDigitalAsset
 ---
 
-# LSP8IdentifiableDigtialAsset
+# LSP8IdentifiableDigitalAsset
 
 ## deploy
 
@@ -13,6 +13,11 @@ lspFactory.LSP8IdentifiableDigitalAsset.deploy(digitalAssetProperties [, options
 
 Deploys a mintable [LSP8 Identifiable Digital Asset](../../../standards/nft-2.0/LSP8-Identifiable-Digital-Asset).
 
+:::info
+By default LSPFactory deploys the [`Mintable`](https://github.com/lukso-network/lsp-smart-contracts/blob/develop/contracts/LSP8IdentifiableDigitalAsset/presets/LSP8Mintable.sol) implementation of LSP8 digital assets. To call the `mint` function import the `LSP8Mintable` abi from the [lsp-smart-contracts library](https://github.com/lukso-network/lsp-smart-contracts).
+
+:::
+
 ### Parameters
 
 #### 1. `digitalAssetProperties` - Object

diff --git a/docs/deployment/digital-asset.md b/docs/deployment/digital-asset.md
@@ -7,18 +7,23 @@ title: Digital Asset
 
 LSPFactory enables developers to easily deploy [LSP7] and [LSP8] Digital Asset smart contracts for their [fungible token](./digital-asset.md#fungible-token) or [NFT 2.0](./digital-asset.md#deploying-nft-20) use cases.
 
-To deploy an [LSP7] Digital Asset:
+To deploy a mintable [LSP7] Digital Asset:
 
 ```javascript
 await lspFactory.LSP7DigitalAsset.deploy(digitalAssetProperties [, options]);
 ```
 
-To deploy an LSP8 Identifiable Digital Asset:
+To deploy a mintable LSP8 Identifiable Digital Asset:
 
 ```javascript
 await lspFactory.LSP8IdentifiableDigitalAsset.deploy(digitalAssetProperties [, options]);
 ```
 
+:::info
+By default LSPFactory deploys the [`Mintable`](https://github.com/lukso-network/lsp-smart-contracts/blob/develop/contracts/LSP7DigitalAsset/presets/LSP7Mintable.sol) implementation of LSP7 and LSP8 digital assets. To call the `mint` function import the `LSP7Mintable` or `LSP8Mintable` abi from the [lsp-smart-contracts library](https://github.com/lukso-network/lsp-smart-contracts).
+
+:::
+
 ## Deploying an NFT 2.0
 
 The [LSP7](./digital-asset.md#lsp7-nft-20) and [LSP8](./digital-asset.md#lsp8-nft-20) Digital Assets standards can both be used for NFT 2.0 contracts.