@lukso/universalprofile-contracts 0.15.0-rc.0

package/README.md

@@ -0,0 +1,22 @@
+# Universal Profile · [![npm version](https://img.shields.io/npm/v/@lukso/universalprofile-contracts.svg?style=flat)](https://www.npmjs.com/package/@lukso/universalprofile-contracts)
+
+Smart Contract implementation for **Universal Profile**, a combination of LSP0 ERC725 Account and LSP3 Profile Metadata.
+
+## Installation
+
+```bash
+npm i @lukso/universalprofile-contracts
+```
+
+## Solidity constants
+
+The constants related to LSP3 Profile Metadata can be directly imported from the `Constants.sol` file.
+
+<!-- prettier-ignore -->
+```solidity
+import {
+  _LSP3_SUPPORTED_STANDARDS_KEY,
+  _LSP3_SUPPORTED_STANDARDS_VALUE,
+  _LSP3_PROFILE_KEY
+} from "universalprofile/contracts/Constants.sol";
+```

package/contracts/Constants.sol

@@ -0,0 +1,14 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.0;
+
+/// @dev This files makes constants related to LSP3 Profile Metadata available to be imported
+/// directly from the UniversalProfile package.
+
+// solhint-disable no-unused-import
+import {
+    _LSP3_SUPPORTED_STANDARDS_KEY,
+    _LSP3_SUPPORTED_STANDARDS_VALUE,
+    _LSP3_PROFILE_KEY
+} from "@lukso/lsp3-contracts/contracts/LSP3Constants.sol";
+
+// solhint-enable

package/contracts/UniversalProfile.sol

@@ -0,0 +1,42 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.4;
+
+// modules
+import {
+    LSP0ERC725Account
+} from "@lukso/lsp0-contracts/contracts/LSP0ERC725Account.sol";
+
+// constants
+import {
+    _LSP3_SUPPORTED_STANDARDS_KEY,
+    _LSP3_SUPPORTED_STANDARDS_VALUE
+} from "@lukso/lsp3-contracts/contracts/LSP3Constants.sol";
+
+/**
+ * @title implementation of a LUKSO's Universal Profile based on LSP3
+ * @author Fabian Vogelsteller <fabian@lukso.network>
+ * @dev Implementation of the ERC725Account + LSP1 universalReceiver
+ */
+contract UniversalProfile is LSP0ERC725Account {
+    /**
+     * @notice Deploying a UniversalProfile contract with owner set to address `initialOwner`.
+     *
+     * @dev Set `initialOwner` as the contract owner and the `SupportedStandards:LSP3Profile` data key in the ERC725Y data key/value store.
+     * - The `constructor` is payable and allows funding the contract on deployment.
+     * - The `initialOwner` will then be allowed to call protected functions marked with the `onlyOwner` modifier.
+     *
+     * @param initialOwner the owner of the contract
+     *
+     * @custom:events
+     * - {UniversalReceiver} event when funding the contract on deployment.
+     * - {OwnershipTransferred} event when `initialOwner` is set as the contract {owner}.
+     * - {DataChanged} event when setting the {_LSP3_SUPPORTED_STANDARDS_KEY}.
+     */
+    constructor(address initialOwner) payable LSP0ERC725Account(initialOwner) {
+        // set data key SupportedStandards:LSP3Profile
+        _setData(
+            _LSP3_SUPPORTED_STANDARDS_KEY,
+            _LSP3_SUPPORTED_STANDARDS_VALUE
+        );
+    }
+}

package/contracts/UniversalProfileInit.sol

@@ -0,0 +1,42 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.4;
+
+// modules
+import {Version} from "./Version.sol";
+import {UniversalProfileInitAbstract} from "./UniversalProfileInitAbstract.sol";
+
+/**
+ * @title Deployable Proxy implementation of a LUKSO's Universal Profile based on LSP3
+ * @author Fabian Vogelsteller <fabian@lukso.network>
+ * @dev Implementation of the ERC725Account + LSP1 universalReceiver
+ */
+contract UniversalProfileInit is UniversalProfileInitAbstract, Version {
+    /**
+     * @notice deploying a `UniversalProfileInit` base contract to be used behind proxy
+     * @dev Locks the base contract on deployment, so that it cannot be initialized, owned and controlled by anyone after it has been deployed.
+     * This is intended so that the sole purpose of this contract is to be used as a base contract behind a proxy.
+     */
+    constructor() {
+        _disableInitializers();
+    }
+
+    /**
+     * @notice Initializing a UniversalProfile contract with owner set to address `initialOwner`.
+     *
+     * @dev Set `initialOwner` as the contract owner and the `SupportedStandards:LSP3Profile` data key in the ERC725Y data key/value store.
+     * - The `initialize(address)` function is payable and allows funding the contract on initialization.
+     * - The `initialOwner` will then be allowed to call protected functions marked with the `onlyOwner` modifier.
+     *
+     * @param initialOwner the owner of the contract
+     *
+     * @custom:events
+     * - {UniversalReceiver} event when funding the contract on deployment.
+     * - {OwnershipTransferred} event when `initialOwner` is set as the contract {owner}.
+     * - {DataChanged} event when setting the {_LSP3_SUPPORTED_STANDARDS_KEY}.
+     */
+    function initialize(
+        address initialOwner
+    ) external payable virtual initializer {
+        UniversalProfileInitAbstract._initialize(initialOwner);
+    }
+}

package/contracts/UniversalProfileInitAbstract.sol

@@ -0,0 +1,47 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.4;
+
+// modules
+import {
+    LSP0ERC725AccountInitAbstract
+} from "@lukso/lsp0-contracts/contracts/LSP0ERC725AccountInitAbstract.sol";
+
+// constants
+import {
+    _LSP3_SUPPORTED_STANDARDS_KEY,
+    _LSP3_SUPPORTED_STANDARDS_VALUE
+} from "@lukso/lsp3-contracts/contracts/LSP3Constants.sol";
+
+/**
+ * @title Inheritable Proxy implementation of a LUKSO's Universal Profile based on LSP3
+ * @author Fabian Vogelsteller <fabian@lukso.network>
+ * @dev Implementation of the ERC725Account + LSP1 universalReceiver
+ */
+abstract contract UniversalProfileInitAbstract is
+    LSP0ERC725AccountInitAbstract
+{
+    /**
+     * @dev Set `initialOwner` as the contract owner and the `SupportedStandards:LSP3Profile` data key in the ERC725Y data key/value store.
+     * The `initialOwner` will then be allowed to call protected functions marked with the `onlyOwner` modifier.
+     *
+     * @param initialOwner The owner of the contract.
+     *
+     * @custom:warning ERC725X & ERC725Y parent contracts are not initialised as they don't have non-zero initial state. If you decide to add non-zero initial state to any of those contracts, you must initialize them here.
+     *
+     * @custom:events
+     * - {UniversalReceiver} event when funding the contract on deployment.
+     * - {OwnershipTransferred} event when `initialOwner` is set as the contract {owner}.
+     * - {DataChanged} event when setting the {_LSP3_SUPPORTED_STANDARDS_KEY}.
+     */
+    function _initialize(
+        address initialOwner
+    ) internal virtual override onlyInitializing {
+        LSP0ERC725AccountInitAbstract._initialize(initialOwner);
+
+        // set data key SupportedStandards:LSP3Profile
+        _setData(
+            _LSP3_SUPPORTED_STANDARDS_KEY,
+            _LSP3_SUPPORTED_STANDARDS_VALUE
+        );
+    }
+}

package/contracts/Version.sol

@@ -0,0 +1,17 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.4;
+
+abstract contract Version {
+    /**
+     * @dev Get the version of the contract.
+     * @notice Contract version.
+     *
+     * @return The version of the the contract.
+     */
+    // DO NOT CHANGE
+    // Comments block below is used by release-please to automatically update the version in this file.
+    // x-release-please-start-version
+    string public constant VERSION = "0.14.0";
+
+    // x-release-please-end
+}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@lukso/universalprofile-contracts",
+  "version": "0.15.0-rc.0",
+  "description": "Package for Universal Profile, an implementation of LSP0 ERC725 Account & LSP3 Profile Metadata standards combined together.",
+  "license": "Apache-2.0",
+  "author": "",
+  "keywords": [
+    "LUKSO",
+    "LSP",
+    "Blockchain",
+    "Standards",
+    "Smart Contracts",
+    "Ethereum",
+    "EVM",
+    "Solidity"
+  ],
+  "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",
+    "./README.md"
+  ],
+  "scripts": {
+    "build": "hardhat compile --show-stack-traces",
+    "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/lsp0-contracts": "*",
+    "@lukso/lsp3-contracts": "*"
+  }
+}