Skip to content

Commit 7ab7073

Browse files
chore: update readme
1 parent e35f20f commit 7ab7073

File tree

1 file changed

+8
-58
lines changed
  • clients/dart/didcomm/atlas_didcomm_client

1 file changed

+8
-58
lines changed

clients/dart/didcomm/atlas_didcomm_client/README.md

Lines changed: 8 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Affinidi Atlas DIDComm Client for Dart
22

3-
A Dart client for interacting with Affinidi Atlas over DIDComm v2.1. It enables secure, end-to-end encrypted management of Atlas services (Mediator, Meeting Place/MPX, Trust Registry/TR) using DID-based identities and message flows.
3+
A Dart client for interacting with Affinidi Atlas over DIDComm v2.1. It enables secure, end-to-end encrypted management of Atlas services using DID-based identities and message flows.
44

5-
This client builds on the Affinidi DIDComm Mediator Client and provides high-level APIs to:
5+
This client provides high-level APIs to:
66

7-
- Manage service ACLs via the mediator
8-
- Deploy and destroy Atlas service instances (Mediator, MPX, TR)
7+
- Manage service ACLs
8+
- Deploy and destroy Atlas service instances
99
- Retrieve instance metadata and lists
1010
- Query service requests and update deployments/configurations
1111

@@ -28,14 +28,14 @@ This client builds on the Affinidi DIDComm Mediator Client and provides high-lev
2828
## Core Concepts
2929

3030
- **DIDComm v2.1**: Open standard for secure, interoperable, end-to-end encrypted communication using DIDs.
31-
- **Affinidi Atlas**: An orchestrator that manages services — Mediator, Meeting Place (MPX), and Trust Registry (TR) — via DIDComm, providing coordinated lifecycle, configuration, and secure messaging across them.
32-
- **Mediator ACL**: Access control list that configures which users/DIDs can access a specific Atlas‑deployed instance (Mediator, MPX, TR).
31+
- **Affinidi Atlas**: An orchestrator that manages Mediator instances via DIDComm, providing coordinated lifecycle, configuration, and secure messaging.
32+
- **Mediator ACL**: Access control list that configures which users/DIDs can access a specific Atlas‑deployed instance.
3333

3434
## Key Features
3535

3636
- High-level Dart APIs over DIDComm for Atlas
3737
- Instance lifecycle: deploy, destroy, list, and metadata
38-
- Requests query for Mediator, MPX, TR
38+
- Requests query for a deployed instance
3939
- Deployment and configuration updates
4040

4141
## Requirements
@@ -100,14 +100,6 @@ Future<void> main() async {
100100
// Mediator instances
101101
final mediators = await client.getMediatorInstancesList(limit: 10);
102102
print(mediators.body);
103-
104-
// MPX instances
105-
final mpx = await client.getMpxInstancesList(limit: 10);
106-
print(mpx.body);
107-
108-
// Trust Registry instances
109-
final trs = await client.getTrInstancesList(limit: 10);
110-
print(trs.body);
111103
```
112104

113105
### Deploy and destroy instances
@@ -127,28 +119,6 @@ final destroyedMed = await client.destroyMediatorInstance(
127119
mediatorId: deployMed.body.instanceId,
128120
);
129121
print(destroyedMed.body);
130-
131-
// Deploy MPX
132-
final deployMpx = await client.deployMpxInstance(
133-
options: DeployMpxInstanceOptions(
134-
serviceSize: ServiceSize.small,
135-
// ... other deployment options
136-
),
137-
);
138-
139-
// Destroy MPX
140-
await client.destroyMpxInstance(mpxId: deployMpx.body.instanceId);
141-
142-
// Deploy TR
143-
final deployTr = await client.deployTrInstance(
144-
options: DeployTrInstanceOptions(
145-
serviceSize: ServiceSize.small,
146-
// ... other deployment options
147-
),
148-
);
149-
150-
// Destroy TR
151-
await client.destroyTrInstance(trId: deployTr.body.instanceId);
152122
```
153123

154124
### Get metadata and requests
@@ -160,13 +130,8 @@ final medMeta = await client.getMediatorInstanceMetadata(
160130
);
161131
print(medMeta.body);
162132
163-
final mpxMeta = await client.getMpxInstanceMetadata(mpxId: 'mpx-123');
164-
final trMeta = await client.getTrInstanceMetadata(trId: 'tr-123');
165-
166133
// Requests
167-
final medReqs = await client.getMediatorRequests(limit: 20);
168-
final mpxReqs = await client.getMpxRequests(limit: 20);
169-
final trReqs = await client.getTrRequests(limit: 20);
134+
final requests = await client.getMediatorRequests(limit: 20);
170135
```
171136

172137
### Update deployment/configuration
@@ -187,21 +152,6 @@ await client.updateMediatorInstanceConfiguration(
187152
// ... configuration fields
188153
),
189154
);
190-
191-
// MPX and TR deployments
192-
await client.updateMpxInstanceDeployment(
193-
mpxId: 'mpx-123',
194-
options: UpdateMpxInstanceDeploymentOptions(
195-
serviceSize: ServiceSize.medium,
196-
),
197-
);
198-
199-
await client.updateTrInstanceDeployment(
200-
trId: 'tr-123',
201-
options: UpdateTrInstanceDeploymentOptions(
202-
serviceSize: ServiceSize.medium,
203-
),
204-
);
205155
```
206156

207157
## Security Features

0 commit comments

Comments
 (0)