appURI Extension (#209)

* basic appUri var

* docs

* couple small comment fixes

* public function

* prettier fix

* appURI docs

* docs?

* updated version

* restrict mutability to view for _canSetAppURI

Co-authored-by: Yash <[email protected]>

Author: furqanrydhan

contracts/extension/AppURI.sol

@@ -0,0 +1,35 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.0;
+
+import "./interface/IAppURI.sol";
+
+/**
+ *  Thirdweb's `AppURI` is a contract extension for any contract
+ *  that wants to add an official App URI that follows the appUri spec
+ *
+ */
+
+abstract contract AppURI is IAppURI {
+    /// @dev appURI
+    string public override appURI;
+
+    /// @dev Lets a contract admin set the URI for app metadata.
+    function setAppURI(string memory _uri) public override {
+        if (!_canSetAppURI()) {
+            revert("Not authorized");
+        }
+
+        _setupAppURI(_uri);
+    }
+
+    /// @dev Lets a contract admin set the URI for app metadata.
+    function _setupAppURI(string memory _uri) internal {
+        string memory prevURI = appURI;
+        appURI = _uri;
+
+        emit AppURIUpdated(prevURI, _uri);
+    }
+
+    /// @dev Returns whether appUri can be set in the given execution context.
+    function _canSetAppURI() internal view virtual returns (bool);
+}

contracts/extension/interface/IAppURI.sol

@@ -0,0 +1,22 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.0;
+
+/**
+ *  Thirdweb's `AppURI` is a contract extension for any base contracts. It lets you set a metadata URI
+ *  for you contract.
+ *
+ */
+
+interface IAppURI {
+    /// @dev Returns the metadata URI of the contract.
+    function appURI() external view returns (string memory);
+
+    /**
+     *  @dev Sets contract URI for the storefront-level metadata of the contract.
+     *       Only module admin can call this function.
+     */
+    function setAppURI(string calldata _uri) external;
+
+    /// @dev Emitted when the contract URI is updated.
+    event AppURIUpdated(string prevURI, string newURI);
+}

docs/AppURI.md

@@ -0,0 +1,68 @@
+# AppURI
+
+
+
+
+
+Thirdweb's `AppURI` is a contract extension for any contract  that wants to add an official App URI that follows the appUri spec
+
+
+
+## Methods
+
+### appURI
+
+```solidity
+function appURI() external view returns (string)
+```
+
+
+
+*appURI*
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | string | undefined |
+
+### setAppURI
+
+```solidity
+function setAppURI(string _uri) external nonpayable
+```
+
+
+
+*Lets a contract admin set the URI for app metadata.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _uri | string | undefined |
+
+
+
+## Events
+
+### AppURIUpdated
+
+```solidity
+event AppURIUpdated(string prevURI, string newURI)
+```
+
+
+
+
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| prevURI  | string | undefined |
+| newURI  | string | undefined |
+
+
+

docs/IAppURI.md

@@ -0,0 +1,68 @@
+# IAppURI
+
+
+
+
+
+Thirdweb's `AppURI` is a contract extension for any base contracts. It lets you set a metadata URI  for you contract.
+
+
+
+## Methods
+
+### appURI
+
+```solidity
+function appURI() external view returns (string)
+```
+
+
+
+*Returns the metadata URI of the contract.*
+
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | string | undefined |
+
+### setAppURI
+
+```solidity
+function setAppURI(string _uri) external nonpayable
+```
+
+
+
+*Sets contract URI for the storefront-level metadata of the contract.       Only module admin can call this function.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| _uri | string | undefined |
+
+
+
+## Events
+
+### AppURIUpdated
+
+```solidity
+event AppURIUpdated(string prevURI, string newURI)
+```
+
+
+
+*Emitted when the contract URI is updated.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| prevURI  | string | undefined |
+| newURI  | string | undefined |
+
+
+