fix: alter 'getBlob' and 'Blob' subscribers value

Author: dtbuchholz

README.md

@@ -1056,13 +1056,13 @@ This will emit an `OverwriteBlob` event and overwrite the blob in the network.
 ##### Get a blob
 
 ```sh
-cast abi-decode "getBlob(string)((uint64,string,(address,(string,(uint64,uint64,string,address,bool))[])[],uint8))" $(cast call --rpc-url $ETH_RPC_URL $BLOBS "getBlob(string)" "rzghyg4z3p6vbz5jkgc75lk64fci7kieul65o6hk6xznx7lctkmq")
+cast abi-decode "getBlob(string)((uint64,string,(string,uint64)[],uint8))" $(cast call --rpc-url $ETH_RPC_URL $BLOBS "getBlob(string)" "rzghyg4z3p6vbz5jkgc75lk64fci7kieul65o6hk6xznx7lctkmq")
 ```
 
 This will return the following response:
 
 ```sh
-(6, "utiakbxaag7udhsriu6dm64cgr7bk4zahiudaaiwuk6rfv43r3rq", [(0x90F79bf6EB2c4f870365E785982E1f101E93b906, [("foo", (4825, 91225 [9.122e4], "cydkrslhbj4soqppzc66u6lzwxgjwgbhdlxmyeahytzqrh65qtjq", 0x0000000000000000000000000000000000000000, false))])], 2)
+6, "utiakbxaag7udhsriu6dm64cgr7bk4zahiudaaiwuk6rfv43r3rq", [("1bce5a746a1134bf082baac80be951906bb406787e14c9fee0d7d8db0fc0b7f4", 98266 [9.826e4])], 2)
 ```
 
 Which maps to the `Blob` struct:
@@ -1076,21 +1076,8 @@ struct Blob {
 }
 
 struct Subscriber {
-    address subscriber; // 0x90F79bf6EB2c4f870365E785982E1f101E93b906
-    SubscriptionGroup[] subscriptionGroup; // See `SubscriptionGroup` struct below
-}
-
-struct SubscriptionGroup {
-    string subscriptionId; // "foo"
-    Subscription subscription; // See `Subscription` struct below
-}
-
-struct Subscription {
-    uint64 added; // 4825
-    uint64 expiry; // 91225
-    string source; // "cydkrslhbj4soqppzc66u6lzwxgjwgbhdlxmyeahytzqrh65qtjq"
-    address delegate; // 0x0000000000000000000000000000000000000000
-    bool failed; // false
+    string subscriptionId; // "1bce5a746a1134bf082baac80be951906bb406787e14c9fee0d7d8db0fc0b7f4"
+    uint64 expiry; // 98266
 }
 ```
 

src/types/BlobTypes.sol

@@ -156,8 +156,8 @@ struct AddBlobParams {
 /// @dev Blob information and status.
 /// @param size (uint64): The size of the blob content in bytes.
 /// @param metadataHash (string): Blob metadata hash that contains information for block recovery.
-/// @param subscribers (bytes): Active subscribers (accounts) that are paying for the blob, encoded as HashMap<Address,
-/// SubscriptionGroup>.
+/// @param subscribers (bytes): Active subscribers (accounts) that are paying for the blob, encoded as
+/// a `HashMap<SubscriptionId, ChainEpoch>`.
 /// @param status (bytes): Current status of the blob.
 struct Blob {
     uint64 size;
@@ -179,11 +179,11 @@ enum BlobStatus {
 }
 
 /// @dev A subscriber and their subscription groups.
-/// @param subscriber (address): The subscriber address.
-/// @param subscriptionGroup (SubscriptionGroup[]): The subscription groups. See {SubscriptionGroup} for more details.
+/// @param subscriptionId (string): The subscription ID.
+/// @param expiry (uint64): The block number when the subscription will expire.
 struct Subscriber {
-    address subscriber;
-    SubscriptionGroup[] subscriptionGroup;
+    string subscriptionId;
+    uint64 expiry;
 }
 
 /// @dev Pending subscription information.

src/wrappers/LibBlob.sol

@@ -176,9 +176,8 @@ library LibBlob {
         bytes[2][] memory decoded = data.decodeCborMappingToBytes();
         subscribers = new Subscriber[](decoded.length);
         for (uint256 i = 0; i < decoded.length; i++) {
-            // The `subscriber` value is an ID address string, like `f0123`, so we convert it to an address
-            subscribers[i].subscriber = decoded[i][0].decodeCborActorIdStringToAddress();
-            subscribers[i].subscriptionGroup = decodeSubscriptionGroup(decoded[i][1]);
+            subscribers[i].subscriptionId = decodeSubscriptionId(decoded[i][0]);
+            subscribers[i].expiry = decoded[i][1].decodeCborBytesToUint64();
         }
     }
 

test/LibBlob.t.sol

@@ -171,45 +171,33 @@ contract LibBlobTest is Test {
     function testDecodeSubscribers() public view {
         // One subscriber
         bytes memory data =
-            hex"a1656630313234a17840343564616464393261326161373431383133323638376639613432313439306261643963356161643332656134653937623135356533373739316630306435308519021f1a0001539f982018fd18bb1871185b08188508184418a1183e182b18b518980118cb18a60218bf183b18351118720418fb18f41836188101181b18ef18941839f6f4";
+            hex"a1a165696e6e65727840393763323930343836383633336164376232353337646534623035336338356333396262306165306263313631383965316261633738373165613065656633371a00016fb4";
         Subscriber[] memory subscribers = LibBlob.decodeSubscribers(data);
         // Note: tests will always show this as a masked ID address, but in reality, it's a looked up delegated address
-        assertEq(subscribers[0].subscriber, 0xFf0000000000000000000000000000000000007C);
-        assertEq(
-            subscribers[0].subscriptionGroup[0].subscriptionId,
-            "45dadd92a2aa7418132687f9a421490bad9c5aad32ea4e97b155e37791f00d50"
-        );
-        assertEq(subscribers[0].subscriptionGroup[0].subscription.added, 543);
-        assertEq(subscribers[0].subscriptionGroup[0].subscription.expiry, 86943);
-        assertEq(
-            subscribers[0].subscriptionGroup[0].subscription.source,
-            "7w5xcwyiqueejij6fo2zqaoluybl6ozvcfzaj67ug2aqcg7psq4q"
-        );
-        assertEq(subscribers[0].subscriptionGroup[0].subscription.delegate, address(0));
-        assertEq(subscribers[0].subscriptionGroup[0].subscription.failed, false);
+        assertEq(subscribers[0].subscriptionId, "97c2904868633ad7b2537de4b053c85c39bb0ae0bc16189e1bac7871ea0eef37");
+        assertEq(subscribers[0].expiry, 94132);
 
-        // Two subscription groups
+        // Two subscribers (i.e., same blob, different buckets)
         data =
-            hex"a1656630313234a2784034316664336363386562303731323262663165356564383562306236393237666236663162336630643662313331326261366531396437646536386366373833851908eb1a00015a6b982018fd18bb1871185b08188508184418a1183e182b18b518980118cb18a60218bf183b18351118720418fb18f41836188101181b18ef18941839f6f47840343564616464393261326161373431383133323638376639613432313439306261643963356161643332656134653937623135356533373739316630306435308519021f1a0001539f982018fd18bb1871185b08188508184418a1183e182b18b518980118cb18a60218bf183b18351118720418fb18f41836188101181b18ef18941839f6f4";
+            hex"a2a165696e6e65727840353764303161653032386136636131303937653630346137633065363863303433353135663437386162636334626165663763386638353137343133343736651a00017f0fa165696e6e65727840613465343463326138303638313061613737353163376632373834633030376131623636326666333130383936363863613362346634653862326330633963631a00017f42";
         subscribers = LibBlob.decodeSubscribers(data);
         // Note: tests will always show this as a masked ID address, but in reality, it's a looked up delegated address
-        assertEq(subscribers[0].subscriber, 0xFf0000000000000000000000000000000000007C);
-        assertEq(
-            subscribers[0].subscriptionGroup[0].subscriptionId,
-            "41fd3cc8eb07122bf1e5ed85b0b6927fb6f1b3f0d6b1312ba6e19d7de68cf783"
-        );
-        assertEq(
-            subscribers[0].subscriptionGroup[1].subscriptionId,
-            "45dadd92a2aa7418132687f9a421490bad9c5aad32ea4e97b155e37791f00d50"
-        );
+        assertEq(subscribers[0].subscriptionId, "57d01ae028a6ca1097e604a7c0e68c043515f478abcc4baef7c8f8517413476e");
+        assertEq(subscribers[0].expiry, 98063);
+        assertEq(subscribers[1].subscriptionId, "a4e44c2a806810aa7751c7f2784c007a1b662ff31089668ca3b4f4e8b2c0c9cc");
+        assertEq(subscribers[1].expiry, 98114);
 
-        // // Two different subscribers
+        // Three different subscribers (different account and buckets), same blob
         data =
-            hex"a2656630313234a2784034316664336363386562303731323262663165356564383562306236393237666236663162336630643662313331326261366531396437646536386366373833851908eb1a00015a6b982018fd18bb1871185b08188508184418a1183e182b18b518980118cb18a60218bf183b18351118720418fb18f41836188101181b18ef18941839f6f47840343564616464393261326161373431383133323638376639613432313439306261643963356161643332656134653937623135356533373739316630306435308519021f1a0001539f982018fd18bb1871185b08188508184418a1183e182b18b518980118cb18a60218bf183b18351118720418fb18f41836188101181b18ef18941839f6f4656630313236a1784033333566316434636333343130646136363562613133336136616339653666656536626334653861356435643239336262333966396465313266303530326438851909881a00015b08982018fd18bb1871185b08188508184418a1183e182b18b518980118cb18a60218bf183b18351118720418fb18f41836188101181b18ef18941839f6f4";
+            hex"a3a165696e6e65727840316263653561373436613131333462663038326261616338306265393531393036626234303637383765313463396665653064376438646230666330623766341a00017fdaa165696e6e65727840353764303161653032386136636131303937653630346137633065363863303433353135663437386162636334626165663763386638353137343133343736651a00017f0fa165696e6e65727840613465343463326138303638313061613737353163376632373834633030376131623636326666333130383936363863613362346634653862326330633963631a00017f42";
         subscribers = LibBlob.decodeSubscribers(data);
-        // Note: tests will always show this as a masked ID address, but in reality, it's a looked up delegated address
-        assertEq(subscribers[0].subscriber, 0xFf0000000000000000000000000000000000007C);
-        assertEq(subscribers[1].subscriber, 0xFF0000000000000000000000000000000000007e);
+        // Note: tests will always show this as a masked ID address, but in reality, it's a looked up delegated
+        assertEq(subscribers[0].subscriptionId, "1bce5a746a1134bf082baac80be951906bb406787e14c9fee0d7d8db0fc0b7f4");
+        assertEq(subscribers[0].expiry, 98266);
+        assertEq(subscribers[1].subscriptionId, "57d01ae028a6ca1097e604a7c0e68c043515f478abcc4baef7c8f8517413476e");
+        assertEq(subscribers[1].expiry, 98063);
+        assertEq(subscribers[2].subscriptionId, "a4e44c2a806810aa7751c7f2784c007a1b662ff31089668ca3b4f4e8b2c0c9cc");
+        assertEq(subscribers[2].expiry, 98114);
     }
 
     function testDecodeSubscriptionGroup() public view {
@@ -262,11 +250,13 @@ contract LibBlobTest is Test {
 
     function testDecodeBlob() public view {
         bytes memory data =
-            hex"84069820185818300918d918fc011819188d18b0150818dc186b18c918e618f10a185c18ef189118a3185d1864186d187318a518b718a8181918cd18b0184da1656630313234a17840343564616464393261326161373431383133323638376639613432313439306261643963356161643332656134653937623135356533373739316630306435308519021f1a0001539f982018fd18bb1871185b08188508184418a1183e182b18b518980118cb18a60218bf183b18351118720418fb18f41836188101181b18ef18941839f6f4685265736f6c766564";
+            hex"84069820182617188e181e18451847188b18b918f1184a181918e318b4188b051849182e18de188918ca18ea1874189f18e3185618a9185b18c9188c171884182fa3a165696e6e65727840316263653561373436613131333462663038326261616338306265393531393036626234303637383765313463396665653064376438646230666330623766341a00017fdaa165696e6e65727840353764303161653032386136636131303937653630346137633065363863303433353135663437386162636334626165663763386638353137343133343736651a00017f0fa165696e6e65727840613465343463326138303638313061613737353163376632373834633030376131623636326666333130383936363863613362346634653862326330633963631a00017f42685265736f6c766564";
         Blob memory blob = LibBlob.decodeBlob(data);
         assertEq(blob.size, 6);
-        assertEq(blob.metadataHash, "layatwp4aemy3mavbdogxspg6effz34runowi3ltuw32qgonwbgq");
-        assertEq(blob.subscribers.length, 1);
+        assertEq(blob.metadataHash, "eyly4hsfi6f3t4kkdhr3jcyfjexn5cok5j2j7y2wvfn4tdaxqqxq");
+        assertEq(blob.subscribers.length, 3);
+        assertEq(blob.subscribers[0].subscriptionId, "1bce5a746a1134bf082baac80be951906bb406787e14c9fee0d7d8db0fc0b7f4");
+        assertEq(blob.subscribers[0].expiry, 98266);
         assertEq(uint8(blob.status), uint8(BlobStatus.Resolved));
     }
 

test/scripts/wrapper_integration_test.sh

@@ -60,16 +60,15 @@ fi
 echo "Output: $output"
 
 # Test getBlob
-# TODO: fix `getBlob` and the subscribers field in the blob struct
-# echo
-# echo "Testing getBlob..."
-# output=$(cast call --rpc-url $ETH_RPC_URL $BLOBS "getBlob(string)" "$BLOB_HASH")
-# if [ "$output" = "0x" ]; then
-#     echo "getBlob failed"
-#     exit 1
-# fi
-# DECODED_BLOB=$(cast abi-decode "getBlob(string)((uint64,string,(address,(string,(uint64,uint64,string,address,bool))[])[],uint8))" $output)
-# echo "Output: $DECODED_BLOB"
+echo
+echo "Testing getBlob..."
+output=$(cast call --rpc-url $ETH_RPC_URL $BLOBS "getBlob(string)" "$BLOB_HASH")
+if [ "$output" = "0x" ]; then
+    echo "getBlob failed"
+    exit 1
+fi
+DECODED_BLOB=$(cast abi-decode "getBlob(string)((uint64,string,(string,uint64)[],uint8))" $output)
+echo "Output: $DECODED_BLOB"
 
 # Test getBlobStatus
 echo