@lukso/lsp8-contracts 0.15.0-rc.0

package/contracts/presets/LSP8Mintable.sol

@@ -0,0 +1,60 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.12;
+
+// interfaces
+import {ILSP8Mintable} from "./ILSP8Mintable.sol";
+
+// modules
+import {
+    LSP8IdentifiableDigitalAsset
+} from "../LSP8IdentifiableDigitalAsset.sol";
+
+/**
+ * @title LSP8IdentifiableDigitalAsset deployable preset contract with a public {mint} function callable only by the contract {owner}.
+ */
+contract LSP8Mintable is LSP8IdentifiableDigitalAsset, ILSP8Mintable {
+    /**
+     * @notice Deploying a `LSP8Mintable` token contract with: token name = `name_`, token symbol = `symbol_`, and
+     * address `newOwner_` as the token contract owner.
+     *
+     * @param name_ The name of the token.
+     * @param symbol_ The symbol of the token.
+     * @param newOwner_ The owner of the token contract.
+     * @param lsp4TokenType_ The type of token this digital asset contract represents (`0` = Token, `1` = NFT, `2` = Collection).
+     * @param lsp8TokenIdFormat_ The format of tokenIds (= NFTs) that this contract will create.
+     */
+    constructor(
+        string memory name_,
+        string memory symbol_,
+        address newOwner_,
+        uint256 lsp4TokenType_,
+        uint256 lsp8TokenIdFormat_
+    )
+        LSP8IdentifiableDigitalAsset(
+            name_,
+            symbol_,
+            newOwner_,
+            lsp4TokenType_,
+            lsp8TokenIdFormat_
+        )
+    {}
+
+    /**
+     * @notice Minting tokenId `tokenId` for address `to` with the additional data `data` (Note: allow non-LSP1 recipient is set to `force`).
+     *
+     * @dev Public {_mint} function only callable by the {owner}.
+     *
+     * @param to The address that will receive the minted `tokenId`.
+     * @param tokenId The tokenId to mint.
+     * @param force Set to `false` to ensure that you are minting for a recipient that implements LSP1, `false` otherwise for forcing the minting.
+     * @param data Any addition data to be sent alongside the minting.
+     */
+    function mint(
+        address to,
+        bytes32 tokenId,
+        bool force,
+        bytes memory data
+    ) public virtual override onlyOwner {
+        _mint(to, tokenId, force, data);
+    }
+}

package/contracts/presets/LSP8MintableInit.sol

@@ -0,0 +1,43 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.12;
+
+// modules
+import {LSP8MintableInitAbstract} from "./LSP8MintableInitAbstract.sol";
+
+/**
+ * @dev LSP8IdentifiableDigitalAsset deployable preset contract (proxy version) with a public {mint} function callable only by the contract {owner}.
+ */
+contract LSP8MintableInit is LSP8MintableInitAbstract {
+    /**
+     * @dev initialize (= lock) base implementation contract on deployment
+     */
+    constructor() {
+        _disableInitializers();
+    }
+
+    /**
+     * @notice Initializing a `LSP8MintableInit` token contract with: token name = `name_`, token symbol = `symbol_`, and
+     * address `newOwner_` as the token contract owner.
+     *
+     * @param name_ The name of the token.
+     * @param symbol_ The symbol of the token.
+     * @param newOwner_ The owner of the token contract.
+     * @param lsp4TokenType_ The type of token this digital asset contract represents (`0` = Token, `1` = NFT, `2` = Collection).
+     * @param lsp8TokenIdFormat_ The format of tokenIds (= NFTs) that this contract will create.
+     */
+    function initialize(
+        string memory name_,
+        string memory symbol_,
+        address newOwner_,
+        uint256 lsp4TokenType_,
+        uint256 lsp8TokenIdFormat_
+    ) external virtual initializer {
+        LSP8MintableInitAbstract._initialize(
+            name_,
+            symbol_,
+            newOwner_,
+            lsp4TokenType_,
+            lsp8TokenIdFormat_
+        );
+    }
+}

package/contracts/presets/LSP8MintableInitAbstract.sol

@@ -0,0 +1,62 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.12;
+
+// interfaces
+import {ILSP8Mintable} from "./ILSP8Mintable.sol";
+// modules
+import {
+    LSP8IdentifiableDigitalAssetInitAbstract
+} from "../LSP8IdentifiableDigitalAssetInitAbstract.sol";
+
+/**
+ * @dev LSP8IdentifiableDigitalAsset deployable preset contract (inheritable proxy version) with a public {mint} function callable only by the contract {owner}.
+ */
+abstract contract LSP8MintableInitAbstract is
+    LSP8IdentifiableDigitalAssetInitAbstract,
+    ILSP8Mintable
+{
+    /**
+     * @notice Initialize a `LSP7MintableInitAbstract` token contract with: token name = `name_`, token symbol = `symbol_`, and
+     * address `newOwner_` as the token contract owner.
+     *
+     * @param name_ The name of the token.
+     * @param symbol_ The symbol of the token.
+     * @param newOwner_ The owner of the token contract.
+     * @param lsp4TokenType_ The type of token this digital asset contract represents (`0` = Token, `1` = NFT, `2` = Collection).
+     * @param lsp8TokenIdFormat_ The format of tokenIds (= NFTs) that this contract will create.
+     */
+    function _initialize(
+        string memory name_,
+        string memory symbol_,
+        address newOwner_,
+        uint256 lsp4TokenType_,
+        uint256 lsp8TokenIdFormat_
+    ) internal virtual override onlyInitializing {
+        LSP8IdentifiableDigitalAssetInitAbstract._initialize(
+            name_,
+            symbol_,
+            newOwner_,
+            lsp4TokenType_,
+            lsp8TokenIdFormat_
+        );
+    }
+
+    /**
+     * @notice Minting tokenId `tokenId` for address `to` with the additional data `data` (Note: allow non-LSP1 recipient is set to `force`).
+     *
+     * @dev Public {_mint} function only callable by the {owner}.
+     *
+     * @param to The address that will receive the minted `tokenId`.
+     * @param tokenId The tokenId to mint.
+     * @param force Set to `false` to ensure that you are minting for a recipient that implements LSP1, `false` otherwise for forcing the minting.
+     * @param data Any addition data to be sent alongside the minting.
+     */
+    function mint(
+        address to,
+        bytes32 tokenId,
+        bool force,
+        bytes memory data
+    ) public virtual override onlyOwner {
+        _mint(to, tokenId, force, data);
+    }
+}

package/dist/index.cjs

@@ -0,0 +1,33 @@
+'use strict';
+
+const INTERFACE_ID_LSP8 = "0x3a271706";
+const LSP8DataKeys = {
+  LSP8TokenIdFormat: "0xf675e9361af1c1664c1868cfa3eb97672d6b1a513aa5b81dec34c9ee330e818d",
+  LSP8TokenMetadataBaseURI: "0x1a7628600c3bac7101f53697f48df381ddc36b9015e7d7c9c5633d1252aa2843",
+  LSP8ReferenceContract: "0x708e7b881795f2e6b6c2752108c177ec89248458de3bf69d0d43480b3e5034e6"
+};
+const LSP8_TYPE_IDS = {
+  // keccak256('LSP8Tokens_SenderNotification')
+  LSP8Tokens_SenderNotification: "0xb23eae7e6d1564b295b4c3e3be402d9a2f0776c57bdf365903496f6fa481ab00",
+  // keccak256('LSP8Tokens_RecipientNotification')
+  LSP8Tokens_RecipientNotification: "0x0b084a55ebf70fd3c06fd755269dac2212c4d3f0f4d09079780bfa50c1b2984d",
+  // keccak256('LSP8Tokens_OperatorNotification')
+  LSP8Tokens_OperatorNotification: "0x8a1c15a8799f71b547e08e2bcb2e85257e81b0a07eee2ce6712549eef1f00970"
+};
+const LSP8_TOKEN_ID_FORMAT = {
+  NUMBER: 0,
+  STRING: 1,
+  ADDRESS: 2,
+  UNIQUE_ID: 3,
+  HASH: 4,
+  MIXED_DEFAULT_NUMBER: 100,
+  MIXED_DEFAULT_STRING: 101,
+  MIXED_DEFAULT_ADDRESS: 102,
+  MIXED_DEFAULT_UNIQUE_ID: 103,
+  MIXED_DEFAULT_HASH: 104
+};
+
+exports.INTERFACE_ID_LSP8 = INTERFACE_ID_LSP8;
+exports.LSP8DataKeys = LSP8DataKeys;
+exports.LSP8_TOKEN_ID_FORMAT = LSP8_TOKEN_ID_FORMAT;
+exports.LSP8_TYPE_IDS = LSP8_TYPE_IDS;

package/dist/index.d.cts

@@ -0,0 +1,29 @@
+declare const INTERFACE_ID_LSP8 = "0x3a271706";
+declare const LSP8DataKeys: {
+    LSP8TokenIdFormat: string;
+    LSP8TokenMetadataBaseURI: string;
+    LSP8ReferenceContract: string;
+};
+declare const LSP8_TYPE_IDS: {
+    LSP8Tokens_SenderNotification: string;
+    LSP8Tokens_RecipientNotification: string;
+    LSP8Tokens_OperatorNotification: string;
+};
+/**
+ * @dev List of LSP8 Token ID Formats that can be used to create different types of NFTs and represent each NFT identifiers (= tokenIds) differently.
+ * @see For details see: https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-8-IdentifiableDigitalAsset.md#lsp8tokenidformat
+ */
+declare const LSP8_TOKEN_ID_FORMAT: {
+    NUMBER: number;
+    STRING: number;
+    ADDRESS: number;
+    UNIQUE_ID: number;
+    HASH: number;
+    MIXED_DEFAULT_NUMBER: number;
+    MIXED_DEFAULT_STRING: number;
+    MIXED_DEFAULT_ADDRESS: number;
+    MIXED_DEFAULT_UNIQUE_ID: number;
+    MIXED_DEFAULT_HASH: number;
+};
+
+export { INTERFACE_ID_LSP8, LSP8DataKeys, LSP8_TOKEN_ID_FORMAT, LSP8_TYPE_IDS };

package/dist/index.d.mts

@@ -0,0 +1,29 @@
+declare const INTERFACE_ID_LSP8 = "0x3a271706";
+declare const LSP8DataKeys: {
+    LSP8TokenIdFormat: string;
+    LSP8TokenMetadataBaseURI: string;
+    LSP8ReferenceContract: string;
+};
+declare const LSP8_TYPE_IDS: {
+    LSP8Tokens_SenderNotification: string;
+    LSP8Tokens_RecipientNotification: string;
+    LSP8Tokens_OperatorNotification: string;
+};
+/**
+ * @dev List of LSP8 Token ID Formats that can be used to create different types of NFTs and represent each NFT identifiers (= tokenIds) differently.
+ * @see For details see: https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-8-IdentifiableDigitalAsset.md#lsp8tokenidformat
+ */
+declare const LSP8_TOKEN_ID_FORMAT: {
+    NUMBER: number;
+    STRING: number;
+    ADDRESS: number;
+    UNIQUE_ID: number;
+    HASH: number;
+    MIXED_DEFAULT_NUMBER: number;
+    MIXED_DEFAULT_STRING: number;
+    MIXED_DEFAULT_ADDRESS: number;
+    MIXED_DEFAULT_UNIQUE_ID: number;
+    MIXED_DEFAULT_HASH: number;
+};
+
+export { INTERFACE_ID_LSP8, LSP8DataKeys, LSP8_TOKEN_ID_FORMAT, LSP8_TYPE_IDS };

package/dist/index.d.ts

@@ -0,0 +1,29 @@
+declare const INTERFACE_ID_LSP8 = "0x3a271706";
+declare const LSP8DataKeys: {
+    LSP8TokenIdFormat: string;
+    LSP8TokenMetadataBaseURI: string;
+    LSP8ReferenceContract: string;
+};
+declare const LSP8_TYPE_IDS: {
+    LSP8Tokens_SenderNotification: string;
+    LSP8Tokens_RecipientNotification: string;
+    LSP8Tokens_OperatorNotification: string;
+};
+/**
+ * @dev List of LSP8 Token ID Formats that can be used to create different types of NFTs and represent each NFT identifiers (= tokenIds) differently.
+ * @see For details see: https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-8-IdentifiableDigitalAsset.md#lsp8tokenidformat
+ */
+declare const LSP8_TOKEN_ID_FORMAT: {
+    NUMBER: number;
+    STRING: number;
+    ADDRESS: number;
+    UNIQUE_ID: number;
+    HASH: number;
+    MIXED_DEFAULT_NUMBER: number;
+    MIXED_DEFAULT_STRING: number;
+    MIXED_DEFAULT_ADDRESS: number;
+    MIXED_DEFAULT_UNIQUE_ID: number;
+    MIXED_DEFAULT_HASH: number;
+};
+
+export { INTERFACE_ID_LSP8, LSP8DataKeys, LSP8_TOKEN_ID_FORMAT, LSP8_TYPE_IDS };

package/dist/index.mjs

@@ -0,0 +1,28 @@
+const INTERFACE_ID_LSP8 = "0x3a271706";
+const LSP8DataKeys = {
+  LSP8TokenIdFormat: "0xf675e9361af1c1664c1868cfa3eb97672d6b1a513aa5b81dec34c9ee330e818d",
+  LSP8TokenMetadataBaseURI: "0x1a7628600c3bac7101f53697f48df381ddc36b9015e7d7c9c5633d1252aa2843",
+  LSP8ReferenceContract: "0x708e7b881795f2e6b6c2752108c177ec89248458de3bf69d0d43480b3e5034e6"
+};
+const LSP8_TYPE_IDS = {
+  // keccak256('LSP8Tokens_SenderNotification')
+  LSP8Tokens_SenderNotification: "0xb23eae7e6d1564b295b4c3e3be402d9a2f0776c57bdf365903496f6fa481ab00",
+  // keccak256('LSP8Tokens_RecipientNotification')
+  LSP8Tokens_RecipientNotification: "0x0b084a55ebf70fd3c06fd755269dac2212c4d3f0f4d09079780bfa50c1b2984d",
+  // keccak256('LSP8Tokens_OperatorNotification')
+  LSP8Tokens_OperatorNotification: "0x8a1c15a8799f71b547e08e2bcb2e85257e81b0a07eee2ce6712549eef1f00970"
+};
+const LSP8_TOKEN_ID_FORMAT = {
+  NUMBER: 0,
+  STRING: 1,
+  ADDRESS: 2,
+  UNIQUE_ID: 3,
+  HASH: 4,
+  MIXED_DEFAULT_NUMBER: 100,
+  MIXED_DEFAULT_STRING: 101,
+  MIXED_DEFAULT_ADDRESS: 102,
+  MIXED_DEFAULT_UNIQUE_ID: 103,
+  MIXED_DEFAULT_HASH: 104
+};
+
+export { INTERFACE_ID_LSP8, LSP8DataKeys, LSP8_TOKEN_ID_FORMAT, LSP8_TYPE_IDS };

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@lukso/lsp8-contracts",
+  "version": "0.15.0-rc.0",
+  "description": "Package for the LSP8 Identifiable Digital Asset standard",
+  "license": "Apache-2.0",
+  "author": "",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "typings": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.ts"
+    },
+    "./artifacts/*": "./artifacts/*",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "contracts/**/*.sol",
+    "!contracts/Mocks/**/*.sol",
+    "artifacts/*.json",
+    "dist",
+    "types",
+    "!types/factories",
+    "./README.md"
+  ],
+  "keywords": [
+    "LUKSO",
+    "LSP",
+    "Blockchain",
+    "Standards",
+    "Smart Contracts",
+    "Ethereum",
+    "EVM",
+    "Solidity"
+  ],
+  "scripts": {
+    "package": "hardhat prepare-package",
+    "build": "hardhat compile --show-stack-traces",
+    "build:js": "unbuild",
+    "build:types": "npx typechain --target=ethers-v6 ./artifacts/*.json --out-dir types",
+    "clean": "hardhat clean && rm -Rf dist/",
+    "format": "prettier --write .",
+    "lint": "eslint . --ext .ts,.js",
+    "lint:solidity": "solhint 'contracts/**/*.sol' && prettier --check 'contracts/**/*.sol'"
+  },
+  "dependencies": {
+    "@erc725/smart-contracts": "^7.0.0",
+    "@openzeppelin/contracts": "^4.9.3",
+    "@lukso/lsp1-contracts": "*",
+    "@lukso/lsp2-contracts": "*",
+    "@lukso/lsp4-contracts": "*",
+    "@lukso/lsp17contractextension-contracts": "*"
+  }
+}