feat(sdk): User id as HexString

[teogeb]

Summary

User id items are stored as arbitrary length string instead of EthereumAddress.

Renamed getAddess() in StreamrClient to getUserId(). This is a breaking change.

This is a preparation PR for #2780. This PR doesn't doesn't contain any changes to contract / The Graph interaction and therefore any user ids which are not exactly 20 bytes long don't work yet. (We should merge this PR to main just before that PR, or implement the contract interactions in a PR which has this PR as a base branch.)

Changes

The UserID helper type if now a a separate BrandedString. Additionally there is a new helper type UserIDRaw, and helper functions toUserId and toUserIdRaw. There is also the HexString helper type which is an alias to string.

In the API all user id inputs and outputs are HexString values. This is not a breaking change as earlier the inputs and outputs were either string or EthereumAddress values. (The EthereumAddress is a branded string, and it was used only in outputs, i.e. in the API all of these were just string values.)

In Message:

• field type of publisherId

In StreamrClient:

• return type of getUserId(),
• field type of UserPermissionQuery#user
  • it is parameter type in hasPermission()
• field type of UserPermissionAssignment#user
  • it is parameter/return type in getPermissions(), grantPermissions(), revokePermissions() and setPermissions()
• return type of getStreamPublishers() and getStreamSubscribers()
• parametrer type of isStreamPublisher(), isStreamSubscriber()
• field type of SearchStreamsPermissionFilter#user
  • it is a parameter type in searchStreams()
• changed type of ResendFromOptions#publisherId and ResendRangeOptions#publisherId
  • these are parameter types in resend()
• parameter type of addEncryptionKey()

In Stream:

• corresponding changes in hasPermission(), getPermissions(), grantPermissions(), revokePermissions() and setPermissions()

Internal

In StreamMessage the publisherId field type is UserID (i.e. the branded string) as we don't consider that class to be a part part of the public API. Also the related user id types in MessageID/GroupKeyRequest/GroupKeyResponse are UserID strings.

Future improvements

• Change all EthereumAddress outputs to HexString outputs (e.g. getStorageNodes()) to unify the API
• Could rename user field of UserPermissionAssignment#user and SearchStreamsPermissionFilter#user to userId to unify the API (we have typically the ID suffix in these, e.g. streamId and publisherId)
• Could refactor some test so that we use randomUserId instead of fastWallet / ether's Wallet

[jtakalai]

I'm not going to demand changes in this repo, but I don't really see what the point of breaking/removing the old function is, especially in cases where (currently) we only support authentication only with Ethereum keys (that will have a corresponding address). It doesn't feel like too much of a concession to leave the existing getAddress etc. methods that return the ID (if it's an address) or throw (if it's not). This wouldn't require so many changes from users, esp those who expect to be using Ethereum addresses only.

[teogeb]

I'm not going to demand changes in this repo, but I don't really see what the point of breaking/removing the old function is, especially in cases where (currently) we only support authentication only with Ethereum keys (that will have a corresponding address). It doesn't feel like too much of a concession to leave the existing getAddress etc. methods that return the ID (if it's an address) or throw (if it's not). This wouldn't require so many changes from users, esp those who expect to be using Ethereum addresses only.

Re-added the getAddress() as you suggested. We could maybe remove/deprecate it later if we want to simplify the API (o need to have have two different names for the same thing). But as there are no other authentication methods yet, it makes sense to keep the alias for backwards compatibility.

The getUserId() is the preferred method to access user's id so that we'll have this kind of straighforward API:

await stream.grantPermissions({
    permissions: [StreamPermission.PUBLISH],
    userId: await publisher.getUserId()
})