Renaming (#37)

* Announce -> Publish
* uri -> url
* Updated packages
* Solc 0.8.4 -> 0.8.6
* Added indexes to Delegation events for searching consistency

Author: wilwade

README.md

@@ -13,15 +13,15 @@ $ npm install @dsnp/contracts
 ### JavaScript ABI Usage
 
 ```javascript
-const announcer = require("@dsnp/contracts/abi/Announcer.json");
-const annoucerABI = announcer.abi;
+const publisher = require("@dsnp/contracts/abi/Publisher.json");
+const publisherABI = publisher.abi;
 
 ```
 ### TypeScript ABI Usage
 
 ```typescript
 // Requires "resolveJsonModule": true in [tsconfig](https://www.typescriptlang.org/tsconfig#resolveJsonModule)
-import { abi as announcerABI } from "@dsnp/contracts/abi/Announcer.json";
+import { abi as publisherABI } from "@dsnp/contracts/abi/Publisher.json";
 ```
 
 #### TypeScript Contract Types
@@ -37,23 +37,23 @@ To maintain types, it is suggested to use [TypeChain](https://github.com/ethereu
 ```typescript
 // web3 example
 import web3 from "web3";
-import { Announcer } from "./types/typechain/Announcer";
-import { abi as announcerABI } from "@dsnp/contracts/abi/Announcer.json";
+import { Publisher } from "./types/typechain/Publisher";
+import { abi as publisherABI } from "@dsnp/contracts/abi/Publisher.json";
 
-const getAnnouncerContract = (contractAddress: string) => {
+const getPublisherContract = (contractAddress: string) => {
   // web3 requires the type casts
-  return (new web3.eth.Contract(announcerABI, contractAddress) as any) as Announcer;
+  return (new web3.eth.Contract(publisherABI, contractAddress) as any) as Publisher;
 }
 ```
 
 ```typescript
 // ethersjsv5 example
 import { Provider } from "@ethersproject/providers";
-import { Announcer } from "./types/typechain/Announcer";
+import { Publisher } from "./types/typechain/Publisher";
 
-const getAnnouncerContract = (contractAddress: string, provider: Provider) => {
+const getPublisherContract = (contractAddress: string, provider: Provider) => {
   // TypeChain for Ethers provides factories
-  return Announcer__factory.connect(contractAddress, provider);
+  return Publisher__factory.connect(contractAddress, provider);
 }
 ```
 
@@ -64,9 +64,9 @@ Once installed, you can use the contracts in the library by importing them:
 ```solidity
 pragma solidity ^0.8.0;
 
-import "@dsnp/contracts/IAnnounce.sol";
+import "@dsnp/contracts/IPublish.sol";
 
-contract MyAnnouncer is IAnnounce {
+contract MyPublisher is IPublish {
     // ...
 }
 ```

contracts/Announcer.sol

@@ -4,5 +4,6 @@ pragma solidity >=0.8.0 <0.9.0;
 import "@openzeppelin/contracts/proxy/beacon/UpgradeableBeacon.sol";
 
 contract Beacon is UpgradeableBeacon {
+    // solhint-disable-next-line no-empty-blocks
     constructor(address _logic) UpgradeableBeacon(_logic) {}
 }

contracts/Beacon.sol

@@ -28,7 +28,7 @@ interface IDelegation {
          */
         NONE,
         /**
-         * @dev 0x1 Announce any DSNP message
+         * @dev 0x1 Sign a DSNP Announcement
          */
         ANNOUNCE,
         /**
@@ -72,14 +72,14 @@ interface IDelegation {
      * @param delegate Address delegated
      * @param role Permission Role
      */
-    event DSNPAddDelegate(address delegate, Role role);
+    event DSNPAddDelegate(address indexed delegate, Role role);
 
     /**
      * @dev Log for removal of a delegate
      * @param delegate Address revoked
      * @param endBlock Block number considered to be the end of the delegate permissions
      */
-    event DSNPRemoveDelegate(address delegate, uint64 endBlock);
+    event DSNPRemoveDelegate(address indexed delegate, uint64 endBlock);
 
     /**
      * @dev Add or change permissions for delegate
@@ -116,7 +116,7 @@ interface IDelegation {
      * @param endBlock Block number to consider the permissions terminated (MUST be > 0x0).
      *
      * MUST be called by the delegate, owner, or other delegate with permissions
-     * MUST store endBlock for response in isAuthorizedToAnnounce (exclusive)
+     * MUST store endBlock for response in isAuthorizedTo (exclusive)
      * MUST emit DSNPRemoveDelegate
      */
     function delegateRemove(address addr, uint64 endBlock) external;
@@ -129,7 +129,7 @@ interface IDelegation {
      * @param change Change data containing new delegate address, endBlock, and nonce
      *
      * MUST be signed by the delegate, owner, or other delegate with permissions
-     * MUST store endBlock for response in isAuthorizedToAnnounce (exclusive)
+     * MUST store endBlock for response in isAuthorizedTo (exclusive)
      * MUST emit DSNPRemoveDelegate
      */
     function delegateRemoveByEIP712Sig(

contracts/IAnnounce.sol

@@ -0,0 +1,23 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity >=0.8.0 <0.9.0;
+
+interface IPublish {
+    struct Batch {
+        int16 dsnpType;
+        string url;
+        bytes32 hash;
+    }
+
+    /**
+     * @dev Log for each batch published
+     * @param dsnpType The type of Announcement in the batch file
+     * @param dsnpHash The keccak hash of the batch file
+     * @param dsnpUrl A url that resolves to the batch file of Announcements
+     */
+    event DSNPBatchPublication(int16 indexed dsnpType, bytes32 dsnpHash, string dsnpUrl);
+
+    /**
+     * @param publications Array of Batch struct to publish
+     */
+    function publish(Batch[] calldata publications) external;
+}

contracts/IDelegation.sol

@@ -221,7 +221,7 @@ contract Identity is IDelegation, ERC165 {
      * @param endBlock Block number to consider the permissions terminated (MUST be > 0x0).
      *
      * MUST be called by the delegate, owner, or other delegate with permissions
-     * MUST store endBlock for response in isAuthorizedToAnnounce (exclusive)
+     * MUST store endBlock for response in isAuthorizedTo (exclusive)
      * MUST emit DSNPRemoveDelegate
      */
     function delegateRemove(address addr, uint64 endBlock) external override {
@@ -247,7 +247,7 @@ contract Identity is IDelegation, ERC165 {
      * @param change Change data containing new delegate address, endBlock, and nonce
      *
      * MUST be signed by the delegate, owner, or other delegate with permissions
-     * MUST store endBlock for response in isAuthorizedToAnnounce (exclusive)
+     * MUST store endBlock for response in isAuthorizedTo (exclusive)
      * MUST emit DSNPRemoveDelegate
      */
     function delegateRemoveByEIP712Sig(
@@ -340,10 +340,9 @@ contract Identity is IDelegation, ERC165 {
         bytes32 s,
         DelegateAdd calldata change
     ) internal view returns (address) {
-        bytes32 typeHash =
-            keccak256(
-                abi.encode(DELEGATE_ADD_TYPEHASH, change.nonce, change.delegateAddr, change.role)
-            );
+        bytes32 typeHash = keccak256(
+            abi.encode(DELEGATE_ADD_TYPEHASH, change.nonce, change.delegateAddr, change.role)
+        );
         return signerFromHashStruct(v, r, s, typeHash);
     }
 
@@ -361,15 +360,9 @@ contract Identity is IDelegation, ERC165 {
         bytes32 s,
         DelegateRemove calldata change
     ) internal view returns (address) {
-        bytes32 typeHash =
-            keccak256(
-                abi.encode(
-                    DELEGATE_REMOVE_TYPEHASH,
-                    change.nonce,
-                    change.delegateAddr,
-                    change.endBlock
-                )
-            );
+        bytes32 typeHash = keccak256(
+            abi.encode(DELEGATE_REMOVE_TYPEHASH, change.nonce, change.delegateAddr, change.endBlock)
+        );
         return signerFromHashStruct(v, r, s, typeHash);
     }
 
@@ -387,10 +380,9 @@ contract Identity is IDelegation, ERC165 {
         bytes32 s,
         bytes32 hashStruct
     ) internal view returns (address) {
-        bytes32 digest =
-            keccak256(
-                abi.encodePacked("\x19\x01", _delegationData().domainSeparatorHash, hashStruct)
-            );
+        bytes32 digest = keccak256(
+            abi.encodePacked("\x19\x01", _delegationData().domainSeparatorHash, hashStruct)
+        );
         return ecrecover(digest, v, r, s);
     }
 }

contracts/IPublish.sol

@@ -33,10 +33,10 @@ contract IdentityBeaconProxy is Proxy {
         bs.initialized = true;
 
         // Call Base Logic
-        (bool success, ) =
-            IBeacon(beacon).implementation().delegatecall(
-                abi.encodeWithSignature("initialize(address)", owner)
-            );
+        // solhint-disable avoid-low-level-calls
+        (bool success, ) = IBeacon(beacon).implementation().delegatecall(
+            abi.encodeWithSignature("initialize(address)", owner)
+        );
         require(success, "initialize failed");
     }
 
@@ -47,7 +47,7 @@ contract IdentityBeaconProxy is Proxy {
      */
     function _beaconData() internal pure returns (BeaconStorage storage beaconStorage) {
         bytes32 position = BEACON_SLOT;
-        /* solhint-disable no-inline-assembly */
+        // solhint-disable no-inline-assembly
         assembly {
             beaconStorage.slot := position
         }

contracts/Identity.sol

@@ -0,0 +1,20 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity >=0.8.0 <0.9.0;
+
+import "./IPublish.sol";
+
+contract Publisher is IPublish {
+    /**
+     * @param publications Array of Batch structs to publish
+     */
+    function publish(Batch[] calldata publications) external override {
+        require(publications.length < 100, "gas consumption is high");
+        for (uint256 i = 0; i < publications.length; i++) {
+            emit DSNPBatchPublication(
+                publications[i].dsnpType,
+                publications[i].hash,
+                publications[i].url
+            );
+        }
+    }
+}

contracts/IdentityBeaconProxy.sol

@@ -304,15 +304,14 @@ contract Registry is IRegistry {
         bytes32 s,
         AddressChange calldata change
     ) internal view returns (address) {
-        bytes32 typeHash =
-            keccak256(
-                abi.encode(
-                    ADDRESS_CHANGE_TYPEHASH,
-                    change.nonce,
-                    change.addr,
-                    keccak256(bytes(change.handle))
-                )
-            );
+        bytes32 typeHash = keccak256(
+            abi.encode(
+                ADDRESS_CHANGE_TYPEHASH,
+                change.nonce,
+                change.addr,
+                keccak256(bytes(change.handle))
+            )
+        );
         return signerFromHashStruct(v, r, s, typeHash);
     }
 
@@ -330,15 +329,14 @@ contract Registry is IRegistry {
         bytes32 s,
         HandleChange calldata change
     ) internal view returns (address) {
-        bytes32 typeHash =
-            keccak256(
-                abi.encode(
-                    HANDLE_CHANGE_TYPEHASH,
-                    change.nonce,
-                    keccak256(bytes(change.oldHandle)),
-                    keccak256(bytes(change.newHandle))
-                )
-            );
+        bytes32 typeHash = keccak256(
+            abi.encode(
+                HANDLE_CHANGE_TYPEHASH,
+                change.nonce,
+                keccak256(bytes(change.oldHandle)),
+                keccak256(bytes(change.newHandle))
+            )
+        );
         return signerFromHashStruct(v, r, s, typeHash);
     }
 

contracts/Publisher.sol

@@ -21,41 +21,41 @@ contract TestDelegate is ERC165, IDelegation {
         delegateAddr = owner;
     }
 
-    function delegate(address newDelegate, Role role) external override {
+    function delegate(address, Role) external pure override {
         require(false, "Not implemented");
     }
 
     function delegateByEIP712Sig(
-        uint8 v,
-        bytes32 r,
-        bytes32 s,
-        DelegateAdd calldata change
-    ) external override {
+        uint8,
+        bytes32,
+        bytes32,
+        DelegateAdd calldata
+    ) external pure override {
         require(false, "Not implemented");
     }
 
-    function delegateRemove(address addr, uint64 endBlock) external override {
+    function delegateRemove(address, uint64) external pure override {
         require(false, "Not implemented");
     }
 
     function delegateRemoveByEIP712Sig(
-        uint8 v,
-        bytes32 r,
-        bytes32 s,
-        DelegateRemove calldata change
-    ) external override {
+        uint8,
+        bytes32,
+        bytes32,
+        DelegateRemove calldata
+    ) external pure override {
         require(false, "Not implemented");
     }
 
     function isAuthorizedTo(
         address addr,
-        Permission permission,
-        uint256 blockNumber
+        Permission,
+        uint256
     ) external view override returns (bool) {
         return addr == delegateAddr;
     }
 
-    function getNonceForDelegate(address addr) external view override returns (uint32) {
+    function getNonceForDelegate(address) external pure override returns (uint32) {
         require(false, "Not implemented");
         return 0;
     }

contracts/Registry.sol

@@ -25,7 +25,7 @@ const getAccounts = (network: string) => {
 const config: HardhatUserConfig = {
   defaultNetwork: "hardhat",
   solidity: {
-    compilers: [{ version: "0.8.4", settings: {} }],
+    compilers: [{ version: "0.8.6", settings: {} }],
   },
   networks: {
     hardhat: {},