@lukso/lsp8-contracts 0.15.0 → 0.16.3

package/README.md

@@ -4,13 +4,15 @@ Package for the LSP8 Identifiable Digital Asset Standard.
 
 ## Installation
 
-```bash
+```console
 npm install @lukso/lsp8-contracts
 ```
 
 ## Available Constants & Types
 
-The `@lukso/lsp8-contracts` npm package contains useful constants such as InterfaceIds or ERC725Y Data Keys related to the LSP8 Standard. You can import and access them as follow:
+The `@lukso/lsp8-contracts` npm package contains useful constants such as interface IDs or ERC725Y data keys related to the LSP8 Standard. You can import and access them as follows.
+
+In Javascript.
 
 ```js
 import {
@@ -21,3 +23,48 @@ import {
   LSP8_TOKEN_ID_FORMAT,
 } from "@lukso/lsp8-contracts";
 ```
+
+In Solidity.
+
+<!-- prettier-ignore -->
+```solidity
+import {
+  _INTERFACEID_LSP8,
+  _INTERFACEID_LSP8_V0_12_0,
+  _INTERFACEID_LSP8_V0_14_0,
+  _LSP8_TOKENID_FORMAT_KEY,
+  _LSP8_TOKEN_METADATA_BASE_URI,
+  _LSP8_REFERENCE_CONTRACT,
+  _TYPEID_LSP8_TOKENSSENDER,
+  _TYPEID_LSP8_TOKENSRECIPIENT,
+  _TYPEID_LSP8_TOKENOPERATOR,
+  _LSP8_TOKENID_FORMAT_NUMBER,
+  _LSP8_TOKENID_FORMAT_STRING,
+  _LSP8_TOKENID_FORMAT_ADDRESS,
+  _LSP8_TOKENID_FORMAT_UNIQUE_ID,
+  _LSP8_TOKENID_FORMAT_HASH,
+  _LSP8_TOKENID_FORMAT_MIXED_DEFAULT_NUMBER,
+  _LSP8_TOKENID_FORMAT_MIXED_DEFAULT_STRING,
+  _LSP8_TOKENID_FORMAT_MIXED_DEFAULT_ADDRESS,
+  _LSP8_TOKENID_FORMAT_MIXED_DEFAULT_UNIQUE_ID,
+  _LSP8_TOKENID_FORMAT_MIXED_DEFAULT_HASH
+} from "@lukso/lsp8-contracts/contracts/LSP8Constants.sol";
+```
+
+## Typescript types
+
+You can also import the [type-safe ABI](https://abitype.dev/) from the `/abi` path.
+
+```ts
+import {
+    // standard version
+    lsp8IdentifiableDigitalAssetAbi,
+    lsp8CappedSupplyAbi,
+    lsp8MintableAbi,
+    lsp8VotesAbi
+    // proxy version
+    lsp8CappedSupplyInitAbstractAbi,
+    lsp8IdentifiableDigitalAssetInitAbstractAbi,
+    lsp8MintableInitAbi,
+ } from '@lukso/lsp8-contracts/abi';
+```

package/contracts/ILSP8IdentifiableDigitalAsset.sol

@@ -1,16 +1,10 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.4;
 
-// interfaces
-import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
-import {
-    IERC725Y
-} from "@erc725/smart-contracts/contracts/interfaces/IERC725Y.sol";
-
 /**
  * @title Interface of the LSP8 - Identifiable Digital Asset standard, a non-fungible digital asset.
  */
-interface ILSP8IdentifiableDigitalAsset is IERC165, IERC725Y {
+interface ILSP8IdentifiableDigitalAsset {
     // --- Events
 
     /**
@@ -254,7 +248,7 @@ interface ILSP8IdentifiableDigitalAsset is IERC165, IERC725Y {
      * @param from The address that owns the given `tokenId`.
      * @param to The address that will receive the `tokenId`.
      * @param tokenId The token ID to transfer.
-     * @param force When set to `true`, the `to` address CAN be any addres.
+     * @param force When set to `true`, the `to` address CAN be any address.
      * When set to `false`, the `to` address MUST be a contract that supports the LSP1 UniversalReceiver standard.
      * @param data Any additional data the caller wants included in the emitted event, and sent in the hooks of the `from` and `to` addresses.
      *

package/contracts/LSP8Constants.sol

@@ -4,6 +4,10 @@ pragma solidity ^0.8.4;
 // --- ERC165 interface ids
 bytes4 constant _INTERFACEID_LSP8 = 0x3a271706;
 
+bytes4 constant _INTERFACEID_LSP8_V0_12_0 = 0x30dc5278;
+
+bytes4 constant _INTERFACEID_LSP8_V0_14_0 = 0xecad9f75;
+
 // --- ERC725Y Data Keys
 
 // keccak256('LSP8TokenIdFormat')