vc-bitstring-status-list icon indicating copy to clipboard operation
vc-bitstring-status-list copied to clipboard

The explainer needs more clarity around example bitstring list I am unable to decode the example bitstring status list

Open mjaferDo opened this issue 1 year ago • 1 comments

In the explainer the Status List credential credential example below I have tried to decode and then unzip the example encodedList however I have not been able to do so.

{
  "@context": [
    "https://www.w3.org/ns/credentials/v2"
  ],
  "id": "https://example.com/credentials/status/3",
  "type": ["VerifiableCredential", "BitstringStatusListCredential"],
  "issuer": "did:example:12345",
  "validFrom": "2021-04-05T14:27:40Z",
  "credentialSubject": {
    "id": "https://example.com/status/3#list",
    "type": "BitstringStatusList",
    "statusPurpose": "revocation",
    "encodedList": "uH4sIAAAAAAAAA-3BMQEAAADCoPVPbQwfoAAAAAAAAAAAAAAAAAAAAIC3AYbSVKsAQAAA"
  }
}

Also it is not clear from example that what bitstring list has been encoded. That is what does the list look like before it is encoded. I have come across an implementation below. https://github.com/digitalbazaar/vc-bitstring-status-list/tree/main

The library creates a binary array of bits (unsinged 8 digit integer) and it is not a string. It will help if the explainer elaborates a little when giving examples. The unencoded list below is a binary value representing statuses of 13 credentials. "0000100010101"

I think it helps if we can clarify that the list should be created in binary format not a binary representation of bits in a ASCII string.

mjaferDo avatar Mar 12 '25 15:03 mjaferDo

I'm not completely sure, but I believe the encodedList uH4sIAAAAAAAAA-3BMQEAAADCoPVPbQwfoAAAAAAAAAAAAAAAAAAAAIC3AYbSVKsAQAAA corresponds to a byteArray of size 16384 where all elements are 0.

I'm not sure because I'm having trouble reproducing this by encoding a byteArray of size 16384 with all elements set to 0. My encodedlist from that source list is uH4sIAAAAAAAA_-3BMQEAAADCoPVPbQwfoAAAAAAAAAAAAAAAAAAAAIC3AYbSVKsAQAAA which is almost the same, but slightly different.

I think that clearly specifying what the example bitstringlist is representing would make the explainer significantly more useful.

LemurP avatar Sep 09 '25 09:09 LemurP