meeting_place_core 0.0.1-dev.31 copy "meeting_place_core: ^0.0.1-dev.31" to clipboard
meeting_place_core: ^0.0.1-dev.31 copied to clipboard

The core Meeting Place package that implements Control Plane API and Mediator capabilities, including multi-identity management for enhanced privacy and anonymity.

example/README.md

Core SDK Examples #

Check the sample code to learn how to use the Affinidi Meeting Place - Core SDK package to discover, connect, and communicate with others using Decentralised Identifiers (DIDs) and the DIDComm v2.1 protocol.

File path What it demonstrates
chat/alice.dart Publishes connection offer (invitation) and initialises individual chat.
chat/bob.dart Finds and accepts the connection offer, initialises individual chat.
group_chat/alice.dart Publishes connection offer, approves connection request and initialises group chat.
group_chat/bob.dart Finds and accepts the connection offer, initialises the group chat after group owner approves connection request. Sends the message.
group_chat/charlie.dart Finds and accepts the connection offer, initialises the group chat after group owner approves connection request. Receives message on chat stream and sends message back.
offer/alice.dart Publishes connection offer (invitation) and approve connection request after the offer was accepted. initialises the chat.
offer/bob.dart Finds and accepts the connection offer, sends notification about acceptance of the connection request. initialises the chat.

Running the Examples #

Execute the example Dart scripts from the packages/meeting_place_core/example folder. To run them, you need to provide environment variables for CONTROL_PLANE_DID and MEDIATOR_DID. The examples use the dotenv package to load these values from a local .env file for convenience.

  1. Create your local environment file

    Run this command in your terminal to copy the template and create .env in the root of the example folder:

    cp templates/.example.env .env
    

    Edit .env and update the values for CONTROL_PLANE_DID and MEDIATOR_DID to match your test environment.

  2. Run the example scripts

    You can now run the examples directly using Dart:

    # Offer example
    dart run offer/alice.dart
    dart run offer/bob.dart
    
    # OOB example
    dart run oob/alice.dart
    dart run oob/bob.dart
    
    # Outreach example
    dart run outreach/bob.dart
    dart run outreach/bob.dart
    

    The example utilities will automatically load variables from .env in the root of the example folder.

Notes:

  • The .env file should be placed in the root of the example folder as .env.
  • The template file is provided at templates/.example.env for convenience.
  • If .env is missing, the code will fall back to environment variables from the platform (useful for CI or manual export).
5
likes
160
points
1.26k
downloads

Documentation

API reference

Publisher

verified publisheraffinidi.com

Weekly Downloads

The core Meeting Place package that implements Control Plane API and Mediator capabilities, including multi-identity management for enhanced privacy and anonymity.

Repository (GitHub)
View/report issues
Contributing

License

Apache-2.0 (license)

Dependencies

collection, crypto, crypto_keys_plus, didcomm, json_annotation, meeting_place_control_plane, meeting_place_mediator, meta, mutex, proxy_recrypt, retry, ssi, uuid

More

Packages that depend on meeting_place_core