Notable and breaking changed and additions to the SDK.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning (does not apply to alpha development).
authenticateDidWithSiwx
no longer lowercases theaddress
proprety for SIWE messages-
- should NOT cause any issues with existing MIDs (when updating)
EVM
provider assumes connection if the address is available-
- attempt to
getAddress
before trying toenable
oreth_requestAccounts
- attempt to
- [BREAKING]
authenticateSiwx
has been renamed tosignSiwx
-
- requires a SIWX message to be passed
-
- no longer returns a
did
but instead returns the entireuser
(AuthUserInformation
)
- no longer returns a
- [BREAKING]
SiwxSession
type renamed toSignedSiwx
- [BREAKING]
IKeyDidAuth
type renamed toIDidAuth
ISiwxAuth
now extendsIDidAuth
OrbisEVMAuth
,OrbisSolanaAuth
andOrbisTezosAuth
now exposeauthenticateDid
for decoupled DID creationget did()
added toOrbisDB
, exposes the currently authenticatedDID
- new method
parseUserFromDid: AuthUserInformation
exposed under/utils
OrbisKeyDidAuth.createRandom
to create a randomdid:key
- [BREAKING] Major internal session management refactor
-
- Sessions now rely on the serialized
DIDSession
format, simplifying management and compatibility with other Ceramic ecosystem apps
- Sessions now rely on the serialized
-
serializedSession
as a new option forconnectUser
to pass a serialized session string
-
OrbisConnectResult
is rebuilt on the fly from the parsed serialized session
-
orbis.serializedSession
can be used to retrieve a serialized active session (ie. to be used withlocalStorage
)
-
KeyDidSession
now serializes to base64 and stores the DID alongside the seed
-
- Migration has been built into
isUserConnected
so sessions created and stored before0.0.40-alpha
should work and will be converted to the new format
- Migration has been built into
-
- Multiple types refactored or renamed, this includes
OrbisConnectResult
- Multiple types refactored or renamed, this includes
-
metadata.publicKey
removed from the Tezos provider (metadata.address
remains)
- [BREAKING] Updated function signature of
select.orderBy
(now matches otherSELECT
methods that accept multiple values - optionally)
- New features
- Changes to existing functionality
- Bug fixed
- Removed features
- Deprecated features
- Vulnerabilities changes