Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: adjusted documentation for wallet seeding #415

Merged
merged 2 commits into from
Nov 4, 2024
Merged

docs: adjusted documentation for wallet seeding #415

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
813d204
docs: adjusted documentation for wallet seeding
Phil91 Oct 15, 2024
e905e9b
docs: adjust documentation
Phil91 Oct 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 3 additions & 60 deletions docs/developer/Technical Documentation/Operator Wallet Setup/Initial Setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,66 +1,9 @@
# Initial operator wallet setup

To setup the wallet for the operator the following steps needs to be executed
The initial operator wallet setup is handled by the seeding process of the portal. The seeding process will create an application checklist which is waiting for the DIM Middle Layer response.
The application checklist process than will take care of the initial wallet setup and will create the BPNL and Membership Credential.

1. Request the wallet from the wallet provider
2. Get the companyId of the operator company from the database
3. Create the necessary data for the wallet creation
4. Post the wallet information to the portal

## Wallet request

The provider of the wallet needs to provide the initial wallet information for the operator. The needed information are the did, the did document and authenticationDetails containing the AuthenticationServiceUrl, the clientId and the client secret.

## Retrieving company id

using the company name the company can be found in the `portal.companies` table with this query:

```sql
SELECT id
FROM portal.companies
WHERE name = '(Operator Name)';
```

keep the company id for the later steps.

## Create necessary data

Before executing the scripts please make sure that there is no company_application entry with the company_id matching the id from aboves query.

After you ensured that no company_application exists for the operator company, the following scripts need to be executed:

```sql

INSERT INTO portal.processes(id, process_type_id, lock_expiry_date, version)
VALUES ('9782562f-5ba1-467f-b4da-a8d50d727145', 1, null, '9782562f-5ba1-467f-b4da-a8d50d727145');


INSERT INTO portal.process_steps(id, process_step_type_id, process_step_status_id, date_created, date_last_changed, process_id, message)
VALUES
('d9e8f517-d4f2-45ba-8b51-40a67d69f705', 1, 2, now(), null, '9782562f-5ba1-467f-b4da-a8d50d727145', null),
('2bd950c9-8561-4134-aa8f-04f6e673b1a1', 2, 2, now(), null, '9782562f-5ba1-467f-b4da-a8d50d727145', null),
('6aebf164-be91-486f-97be-699969d5cafb', 3, 3, now(), null, '9782562f-5ba1-467f-b4da-a8d50d727145', null),
('e85cf473-0321-4428-818a-3e595086ac94', 20, 2, now(), null, '9782562f-5ba1-467f-b4da-a8d50d727145', null),
('f895567f-50a0-4391-a086-24f6a046af7c', 21, 1, now(), null, '9782562f-5ba1-467f-b4da-a8d50d727145', null);

INSERT INTO portal.company_applications(id, date_created, date_last_changed, application_status_id, company_id, last_editor_id, checklist_process_id, company_application_type_id, onboarding_service_provider_id)
VALUES ('31322991-f6fd-4a40-a529-566c9b04d6a4', now(), null, 7, 'your company id', null, '9782562f-5ba1-467f-b4da-a8d50d727145', 1, null);

INSERT INTO portal.application_checklist(application_id, application_checklist_entry_type_id, date_created, date_last_changed, application_checklist_entry_status_id, comment)
VALUES ('31322991-f6fd-4a40-a529-566c9b04d6a4', 1, now(), null, 3, null),
('31322991-f6fd-4a40-a529-566c9b04d6a4', 2, now(), null, 3, null),
('31322991-f6fd-4a40-a529-566c9b04d6a4', 3, now(), null, 2, null),
('31322991-f6fd-4a40-a529-566c9b04d6a4', 4, now(), null, 1, null),
('31322991-f6fd-4a40-a529-566c9b04d6a4', 5, now(), null, 1, null),
('31322991-f6fd-4a40-a529-566c9b04d6a4', 6, now(), null, 1, null),
('31322991-f6fd-4a40-a529-566c9b04d6a4', 7, now(), null, 1, null),
('31322991-f6fd-4a40-a529-566c9b04d6a4', 8, now(), null, 1, null);

```

## Post company data

After the database setup is done post the data you received for the wallet to the endpoint `POST: /api/administration/registration/dim/{bpn}` this will simulate a callback from the DIM (Decentralized Identity Management) middle layer and continue the application checklist process.
> > Remarks: The seeding on the [DIM Middle Layer](https://github.com/SAP/ssi-dim-middle-layer/) side from version 2.1.0 onwards was adjusted as well. It will seed a tenant for the operator and a process which starts to create the wallet for the operator.

## NOTICE

Expand Down