WalletUnit

What is a WalletUnit in the EUDI context:

• A WalletUnit is an application holding states, data and credentials.
• A WalletUnit has to be registered and activated at its wallet provider.
• A WalletUnit is the main interface between a user and the EUDI Wallet ecosystem.

To better reflect this, the SDK provides a WalletUnit object holding the unit’s state.

WalletUnit States

A WalletUnit can be in different states allowing the user to finish different tasks.

• Installed: the app is newly installed on a device. The app is neither registered nor logged in at the wallet provider. To change this state, the app has to be registered or logged in with valid credentials.
• Operational: the app is logged in at the wallet provider with credentials from a valid registration.
• Valid: the app has at least one valid PID (Person Identification Data) credential.

The WalletState is provided as flow of the SDK’s WalletUnit object. It should be observed in a central place if the app shall react on changes in the WalletState.

val walletState: Flow<WalletState> = WalletSdkApi.walletUnit.state

Registration

To register the app at the given WalletProvider, the registration has to be started. The app has to provide the following user information to the SDK to complete the registration:

• email address
• a username
• a password

The registration is triggered by the register function. A RegistrationRequest object has to be created, containing the credentials, and passed to the sdk. This function returns an Either containing a RegistrationError or Unit. On successful registration, the sdk triggers a login with the same credentials.

val registrationRequest = RegistrationRequest(email= "me@example.com", username = "me", password = "supersecretpassword")
val result: Either<RegistrationError, Unit> = WalletSdkApi.walletUnit.register(registrationRequest)

The SDK is saving relevant data, the WalletState changes to Operational.

Login

If the user has already registered at the WalletProvider a Login can be started. A prior registration could have been done on e.g. a WalletProvider’s website or through a former registration in an app using the same provider. A LoginRequest, containing the following valid login data from the user, has to be created and passed to the login function.

• email address: the email address used to register at the WalletProvider
• password: the password used to register at the WalletProvider

val loginRequest = LoginRequest(email = "me@example.com", password = "supersecretpassword")
val result: Either<LoginError, Unit> = WalletSdkApi.walletUnit.login(loginRequest)

The SDK is saving relevant data, the WalletState changes to Operational.

Valid State

For the SDK to become Valid, at least one PID(Person Identifitcation Data) Credential has to be loaded. See Credentials for details.