feat: include from param in bucket & blob methods (#81)

Closes #80

Author: dtbuchholz

README.md

@@ -26,6 +26,7 @@
     - [Methods](#methods-1)
     - [Examples](#examples-1)
     - [Query objects](#query-objects)
+    - [Update object metadata](#update-object-metadata)
   - [Blobs contract](#blobs-contract)
     - [Methods](#methods-2)
   - [Testing](#testing)
@@ -635,13 +636,13 @@ The following methods are available on the credit contract, shown with their fun
   metadata.
 - `listBuckets()`: List all buckets for the sender.
 - `listBuckets(address)`: List all buckets for the specified address.
-- `addObject(address,string,string,string,uint64)`: Add an object to a bucket and associated object
-  upload parameters. The first value is the bucket address, the subsequent values are all of the
-  "required" values in `AddObjectParams` (`source` node ID, `key`, `blobHash`, and `size`).
-- `addObject(address,(string,string,string,string,uint64,uint64,(string,string)[],bool))`: Add an
-  object to a bucket (first value) and associated object upload parameters (second value) as the
-  `AddObjectParams` struct, described in more detail below.
-- `deleteObject(address,string)`: Remove an object from a bucket.
+- `addObject(address,string,string,string,uint64,address)`: Add an object to a bucket and associated
+  object upload parameters. The first value is the bucket address, the subsequent values are all of
+  the "required" values in `AddObjectParams` (`source` node ID, `key`, `blobHash`, and `size`).
+- `addObject(address,(string,string,string,string,uint64,uint64,(string,string)[],bool,address))`:
+  Add an object to a bucket (first value) and associated object upload parameters (second value) as
+  the `AddObjectParams` struct, described in more detail below.
+- `deleteObject(address,string,address)`: Remove an object from a bucket.
 - `getObject(address,string)`: Get an object from a bucket.
 - `queryObjects(address)`: Query the bucket (hex address) with no prefix (defaults to `/` delimiter
   and the default offset and limit in the underlying WASM layer).
@@ -653,6 +654,8 @@ The following methods are available on the credit contract, shown with their fun
   limit.
 - `queryObjects(address,string,string,uint64,uint64)`: Query the bucket with a prefix, delimiter,
   offset, and limit.
+- `updateObjectMetadata(address,string,(string,string)[],address)`: Update the metadata of an
+  object.
 
 #### Examples
 
@@ -914,6 +917,14 @@ struct KeyValue {
 }
 ```
 
+#### Update object metadata
+
+You can update the metadata of an existing object with the following command:
+
+```sh
+cast send --rpc-url $ETH_RPC_URL $BUCKETS "updateObjectMetadata(address,string,(string,string)[],address)" $BUCKET_ADDR "hello/world" '[("alias","foo")]' $EVM_ADDRESS --private-key $PRIVATE_KEY
+```
+
 ### Blobs contract
 
 You can interact with the existing blobs contract on the testnet via the address above. If you're
@@ -941,7 +952,7 @@ accepts "optional" arguments. All of the method parameters and return types can
 - `addBlob(AddBlobParams memory params)`: Store a blob directly on the network. This is described in
   more detail below, and it involves a two-step approach with first staging data with the blob
   storage node, and then passing related values onchain.
-- `deleteBlob(address,string,string)`: Delete a blob from the network, passing the sponsor's
+- `deleteBlob(address,string,string,address)`: Delete a blob from the network, passing the sponsor's
   address, the blob hash, and the subscription ID (either `""` if none was originally provided, or
   the string that was chosen during `addBlob`).
 - `overwriteBlob(string,AddBlobParams memory)`: Overwrite a blob from the network, passing the old

src/interfaces/IBlobManager.sol

@@ -70,7 +70,9 @@ interface IBlobManager {
     /// @param subscriber The address of the subscriber.
     /// @param blobHash Blob blake3 hash to delete.
     /// @param subscriptionId Identifier used to differentiate blob additions for the same subscriber.
-    function deleteBlob(address subscriber, string memory blobHash, string memory subscriptionId) external;
+    /// @param from The address of the account that is deleting the blob.
+    function deleteBlob(address subscriber, string memory blobHash, string memory subscriptionId, address from)
+        external;
 
     /// @dev Overwrite a blob in storage.
     /// @param oldHash The blake3 hash of the blob to be deleted.

src/interfaces/IBucketManager.sol

@@ -24,6 +24,12 @@ interface IBucketManager {
     /// @param key The object key.
     event DeleteObject(address indexed owner, address indexed bucket, string key);
 
+    /// @dev Emitted when the metadata of an object is updated.
+    /// @param owner The owner.
+    /// @param bucket The bucket's robust t2 address.
+    /// @param key The object key.
+    event UpdateObjectMetadata(address indexed owner, address indexed bucket, string key);
+
     /// @dev Create a bucket. Uses the sender as the owner.
     function createBucket() external;
 
@@ -52,13 +58,15 @@ interface IBucketManager {
     /// @param blobHash The object blake3 hash.
     /// @param recoveryHash Blake3 hash of the metadata to use for object recovery.
     /// @param size The object size.
+    /// @param from The address of the account that is adding the object.
     function addObject(
         address bucket,
         string memory source,
         string memory key,
         string memory blobHash,
         string memory recoveryHash,
-        uint64 size
+        uint64 size,
+        address from
     ) external;
 
     /// @dev Add an object to a bucket.
@@ -69,7 +77,16 @@ interface IBucketManager {
     /// @dev Delete an object from a bucket.
     /// @param bucket The bucket.
     /// @param key The key.
-    function deleteObject(address bucket, string memory key) external;
+    /// @param from The address of the account that is deleting the object.
+    function deleteObject(address bucket, string memory key, address from) external;
+
+    /// @dev Update the metadata of an object.
+    /// @param bucket The bucket.
+    /// @param key The key.
+    /// @param metadata The metadata.
+    /// @param from The address of the account that is updating the metadata.
+    function updateObjectMetadata(address bucket, string memory key, KeyValue[] memory metadata, address from)
+        external;
 
     /// @dev Get an object from a bucket.
     /// @param bucket The bucket.

src/types/BlobTypes.sol

@@ -141,6 +141,7 @@ struct StorageStats {
 /// @param size Blob size.
 /// @param ttl Blob time-to-live epochs. If not specified, the auto-debitor maintains about one hour of credits as an
 /// ongoing commitment.
+/// @param from Address of the entity adding the blob.
 struct AddBlobParams {
     address sponsor;
     string source;

src/types/BucketTypes.sol

@@ -82,6 +82,7 @@ struct Machine {
 /// @param ttl (uint64): The object time-to-live epochs.
 /// @param metadata (KeyValue[]): The object metadata.
 /// @param overwrite (bool): Whether to overwrite a key if it already exists.
+/// @param from (address): Account address that initiated the call
 struct AddObjectParams {
     string source;
     string key;
@@ -91,4 +92,5 @@ struct AddObjectParams {
     uint64 ttl;
     KeyValue[] metadata;
     bool overwrite;
+    address from;
 }

src/wrappers/BlobManager.sol

@@ -62,8 +62,10 @@ contract BlobManager is IBlobManager {
     }
 
     /// @dev See {IBlobManager-deleteBlob}.
-    function deleteBlob(address subscriber, string memory blobHash, string memory subscriptionId) external {
-        LibBlob.deleteBlob(subscriber, blobHash, subscriptionId);
+    function deleteBlob(address subscriber, string memory blobHash, string memory subscriptionId, address from)
+        external
+    {
+        LibBlob.deleteBlob(subscriber, blobHash, subscriptionId, from);
         emit DeleteBlob(msg.sender, subscriber, blobHash, subscriptionId);
     }
 

src/wrappers/BucketManager.sol

@@ -46,7 +46,8 @@ contract BucketManager is IBucketManager {
         string memory key,
         string memory blobHash,
         string memory recoveryHash,
-        uint64 size
+        uint64 size,
+        address from
     ) external {
         AddObjectParams memory params = AddObjectParams({
             source: source,
@@ -56,7 +57,8 @@ contract BucketManager is IBucketManager {
             size: size,
             ttl: 0, // No expiration
             metadata: new KeyValue[](0), // No metadata
-            overwrite: false // Do not overwrite
+            overwrite: false, // Do not overwrite
+            from: from
         });
         LibBucket.addObject(bucket, params);
         emit AddObject(msg.sender, bucket, key);
@@ -69,11 +71,19 @@ contract BucketManager is IBucketManager {
     }
 
     /// @dev See {IBucketManager-deleteObject}.
-    function deleteObject(address bucket, string memory key) external {
-        LibBucket.deleteObject(bucket, key);
+    function deleteObject(address bucket, string memory key, address from) external {
+        LibBucket.deleteObject(bucket, key, from);
         emit DeleteObject(msg.sender, bucket, key);
     }
 
+    /// @dev See {IBucketManager-updateObjectMetadata}.
+    function updateObjectMetadata(address bucket, string memory key, KeyValue[] memory metadata, address from)
+        external
+    {
+        LibBucket.updateObjectMetadata(bucket, key, metadata, from);
+        emit UpdateObjectMetadata(msg.sender, bucket, key);
+    }
+
     /// @dev See {IBucketManager-getObject}.
     function getObject(address bucket, string memory key) external view returns (ObjectValue memory) {
         return LibBucket.getObject(bucket, key);

src/wrappers/LibBlob.sol

@@ -447,12 +447,6 @@ library LibBlob {
         return decodeBlob(data);
     }
 
-    function getBlob2(string memory blobHash) external view returns (bytes memory data) {
-        bytes memory params = blobHash.encodeCborBlobHashOrNodeId();
-        data = LibWasm.readFromWasmActor(ACTOR_ID, METHOD_GET_BLOB, params);
-        return data;
-    }
-
     /// @dev Get the status of a blob.
     /// @param subscriber The address of the subscriber.
     /// @param blobHash The hash of the blob.
@@ -565,11 +559,15 @@ library LibBlob {
     /// @param subscriber The address of the subscriber.
     /// @param blobHash The hash of the blob.
     /// @param subscriptionId The subscription ID.
-    function deleteBlob(address subscriber, string memory blobHash, string memory subscriptionId) external {
-        bytes[] memory encoded = new bytes[](3);
+    /// @param from Account address that initiated the deletion.
+    function deleteBlob(address subscriber, string memory blobHash, string memory subscriptionId, address from)
+        external
+    {
+        bytes[] memory encoded = new bytes[](4);
         encoded[0] = subscriber == address(0) ? LibWasm.encodeCborNull() : subscriber.encodeCborAddress();
         encoded[1] = blobHash.encodeCborBlobHashOrNodeId();
         encoded[2] = encodeSubscriptionId(subscriptionId);
+        encoded[3] = from.encodeCborAddress();
         bytes memory params = encoded.encodeCborArray();
         // Note: response bytes are always empty
         LibWasm.writeToWasmActor(ACTOR_ID, METHOD_DELETE_BLOB, params);

src/wrappers/LibBucket.sol

@@ -31,6 +31,7 @@ library LibBucket {
     uint64 internal constant METHOD_DELETE_OBJECT = 4237275016;
     uint64 internal constant METHOD_GET_OBJECT = 1894890866;
     uint64 internal constant METHOD_LIST_OBJECTS = 572676265;
+    uint64 internal constant METHOD_UPDATE_OBJECT_METADATA = 540229491;
 
     /// @dev Decode a CBOR encoded list.
     /// @param data The CBOR encoded list.
@@ -152,7 +153,7 @@ library LibBucket {
     /// @param params The add params.
     /// @return encoded The CBOR encoded add params.
     function encodeAddObjectParams(AddObjectParams memory params) internal pure returns (bytes memory) {
-        bytes[] memory encoded = new bytes[](8);
+        bytes[] memory encoded = new bytes[](9);
         encoded[0] = params.source.encodeCborBlobHashOrNodeId();
         encoded[1] = params.key.encodeCborBytes();
         encoded[2] = params.blobHash.encodeCborBlobHashOrNodeId();
@@ -165,6 +166,18 @@ library LibBucket {
         encoded[5] = params.ttl == 0 ? LibWasm.encodeCborNull() : params.ttl.encodeCborUint64();
         encoded[6] = params.metadata.encodeCborKeyValueMap();
         encoded[7] = params.overwrite.encodeCborBool();
+        encoded[8] = params.from.encodeCborAddress();
+        return encoded.encodeCborArray();
+    }
+
+    /// @dev Encode a CBOR encoded delete object params.
+    /// @param key The key of the object to delete.
+    /// @param from The address of the account that is deleting the object.
+    /// @return encoded The CBOR encoded delete object params.
+    function encodeDeleteObjectParams(string memory key, address from) internal pure returns (bytes memory) {
+        bytes[] memory encoded = new bytes[](2);
+        encoded[0] = key.encodeCborBytes();
+        encoded[1] = from.encodeCborAddress();
         return encoded.encodeCborArray();
     }
 
@@ -188,6 +201,23 @@ library LibBucket {
         return encoded.encodeCborArray();
     }
 
+    /// @dev Encode a CBOR encoded update object metadata params.
+    /// @param key The key of the object to update.
+    /// @param metadata The metadata.
+    /// @param from The address of the account that is updating the metadata.
+    /// @return encoded The CBOR encoded update object metadata params.
+    function encodeUpdateObjectMetadataParams(string memory key, KeyValue[] memory metadata, address from)
+        internal
+        pure
+        returns (bytes memory)
+    {
+        bytes[] memory encoded = new bytes[](3);
+        encoded[0] = key.encodeCborBytes();
+        encoded[1] = metadata.encodeCborKeyValueMap();
+        encoded[2] = from.encodeCborAddress();
+        return encoded.encodeCborArray();
+    }
+
     /// @dev Convert a kind to a string.
     /// @param kind The kind.
     /// @return string The string representation of the kind.
@@ -246,12 +276,26 @@ library LibBucket {
     /// @dev Delete an object from the bucket.
     /// @param bucket The bucket.
     /// @param key The object key.
-    function deleteObject(address bucket, string memory key) external {
+    /// @param from The address of the account that is deleting the object.
+    function deleteObject(address bucket, string memory key, address from) external {
         uint64 bucketAddr = bucket.addressToActorId();
-        bytes memory params = key.encodeCborBytes();
+        bytes memory params = encodeDeleteObjectParams(key, from);
         LibWasm.writeToWasmActor(bucketAddr, METHOD_DELETE_OBJECT, params);
     }
 
+    /// @dev Update the metadata of an object.
+    /// @param bucket The bucket.
+    /// @param key The object key.
+    /// @param metadata The metadata.
+    /// @param from The address of the account that is updating the metadata.
+    function updateObjectMetadata(address bucket, string memory key, KeyValue[] memory metadata, address from)
+        external
+    {
+        uint64 bucketAddr = bucket.addressToActorId();
+        bytes memory params = encodeUpdateObjectMetadataParams(key, metadata, from);
+        LibWasm.writeToWasmActor(bucketAddr, METHOD_UPDATE_OBJECT_METADATA, params);
+    }
+
     /// @dev Get an object from the bucket.
     /// @param bucket The bucket.
     /// @param key The object key.

test/LibBucket.t.sol

@@ -147,12 +147,13 @@ contract LibBucketTest is Test {
             size: 6,
             ttl: 0, // Null value
             metadata: metadata,
-            overwrite: false
+            overwrite: false,
+            from: 0x90F79bf6EB2c4f870365E785982E1f101E93b906
         });
         bytes memory encoded = LibBucket.encodeAddObjectParams(params);
         assertEq(
             encoded,
-            hex"889820160618a818c918670a18791827184118ef18c818bd18ea1879187918b518cc189b18181827181a18ee18cc100718c418f308189f18dd188418d34b68656c6c6f2f776f726c649820188e184c187c181b189918db18fd185018e718a91851188518fe18ad185e18e11844188f18a90418a218fd18d7187818ea18f518f218db18fd1862189a18999820000000000000000000000000000000000000000000000000000000000000000006f6a16c636f6e74656e742d7479706578186170706c69636174696f6e2f6f637465742d73747265616df4"
+            hex"899820160618a818c918670a18791827184118ef18c818bd18ea1879187918b518cc189b18181827181a18ee18cc100718c418f308189f18dd188418d34b68656c6c6f2f776f726c649820188e184c187c181b189918db18fd185018e718a91851188518fe18ad185e18e11844188f18a90418a218fd18d7187818ea18f518f218db18fd1862189a18999820000000000000000000000000000000000000000000000000000000000000000006f6a16c636f6e74656e742d7479706578186170706c69636174696f6e2f6f637465742d73747265616df456040a90f79bf6eb2c4f870365e785982e1f101e93b906"
         );
     }
 
@@ -165,4 +166,21 @@ contract LibBucketTest is Test {
         bytes memory encoded = LibBucket.encodeCreateBucketParams(params);
         assertEq(encoded, hex"8356040a90f79bf6eb2c4f870365e785982e1f101e93b906664275636b6574a0");
     }
+
+    function testEncodeDeleteObjectParams() public pure {
+        bytes memory encoded =
+            LibBucket.encodeDeleteObjectParams("hello/world", 0x90F79bf6EB2c4f870365E785982E1f101E93b906);
+        assertEq(encoded, hex"824b68656c6c6f2f776f726c6456040a90f79bf6eb2c4f870365e785982e1f101e93b906");
+    }
+
+    function testEncodeUpdateObjectMetadataParams() public pure {
+        KeyValue[] memory metadata = new KeyValue[](1);
+        metadata[0] = KeyValue("alias", "foo");
+        bytes memory encoded = LibBucket.encodeUpdateObjectMetadataParams(
+            "hello/world", metadata, 0x90F79bf6EB2c4f870365E785982E1f101E93b906
+        );
+        assertEq(
+            encoded, hex"834b68656c6c6f2f776f726c64a165616c69617363666f6f56040a90f79bf6eb2c4f870365e785982e1f101e93b906"
+        );
+    }
 }