Skip to main content

Store and manage Data Exchange Agreements (DEXA)

Project description

Data Exchange Agreements (DEXA) SDKs

AboutRelease StatusContributingLicensing

About

This repository hosts the source code for DEXA SDKs and is part of the deliverables for Provenance services with smart data agreement (PS-SDA) project that has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 957338. It implements common functions for DEXA that is used to implement dexa-protocols.

Release Status

Not released, work in progress.

Installation

Requirements:

  • Python 3.8.9 or higher

Plugin Installation

Install this plugin into the virtual environment:

$ pip install dexa-sdk

Usage

Hyperledger aries agents with DEXA protocols enabled can be created using DEXA SDK. Sample script is given below:

In agent.py, copy the following.

from dexa_sdk.agent.commands.start import execute

args = [
    "-it",
    "http",
    "0.0.0.0",
    "8006",
    "-ot",
    "http",
    "-e",
    "http://localhost:8006/",
    "--label",
    "Data Source",
    "--admin",
    "0.0.0.0",
    "8005",
    "--admin-insecure-mode",
    "--auto-accept-requests",
    "--auto-ping-connection",
    "--auto-respond-credential-proposal",
    "--auto-respond-credential-offer",
    "--auto-respond-credential-request",
    "--auto-store-credential",
    "--auto-respond-presentation-proposal",
    "--auto-respond-presentation-request",
    "--auto-verify-presentation",
    "--genesis-url",
    "https://indy.igrant.io/genesis",
    "--wallet-type",
    "indy",
    "--wallet-name",
    "Data Source",
    "--log-level",
    "info",
    "--wallet-key",
    "Data Source",
    "--webhook-url",
    "http://localhost:8005/webhooks",
    "--public-invites",
    "--plugin",
    "mydata_did",
    "--plugin",
    "dexa_protocol",
    "--eth-node-rpc",
    "<ethereum node rpc endpoint>",
    "--intermediary-eth-private-key",
    "<data intermediary ethereum private key>",
    "--org-eth-private-key",
    "<org ethereum private key>",
    "--contract-address",
    "<contract address>"
]

execute(args)

and run by executing python agent.py.

Using docker

docker run -it igrantio/dexa-sdk:0.1.8 -- -it http 0.0.0.0 8006 -ot http -e http://localhost:8006/ --label Data Source --admin 0.0.0.0 8005 --admin-insecure-mode --auto-accept-requests --auto-ping-connection --auto-respond-credential-proposal --auto-respond-credential-offer --auto-respond-credential-request --auto-store-credential --auto-respond-presentation-proposal --auto-respond-presentation-request --auto-verify-presentation --genesis-url https://indy.igrant.io/genesis --wallet-type indy --wallet-name Data Source --log-level info --wallet-key Data Source --webhook-url http://localhost:8005/webhooks --public-invites --plugin mydata_did --plugin dexa_protocol --eth-node-rpc <ethereum node rpc endpoint> --intermediary-eth-private-key <data intermediary ethereum private key>  --org-eth-private-key <org ethereum private key> --contract-address <contract address>

Contributing

Feel free to improve the plugin and send us a pull request. If you found any problems, please create an issue in this repo.

Licensing

Copyright (c) 2022-25 LCubed AB (iGrant.io), Sweden

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.

You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the LICENSE for the specific language governing permissions and limitations under the License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dexa-sdk-0.1.14.tar.gz (2.7 MB view details)

Uploaded Source

Built Distribution

dexa_sdk-0.1.14-py3-none-any.whl (2.8 MB view details)

Uploaded Python 3

File details

Details for the file dexa-sdk-0.1.14.tar.gz.

File metadata

  • Download URL: dexa-sdk-0.1.14.tar.gz
  • Upload date:
  • Size: 2.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.15 CPython/3.8.12 Darwin/22.1.0

File hashes

Hashes for dexa-sdk-0.1.14.tar.gz
Algorithm Hash digest
SHA256 2cbe09ff2b43e24be0ad63a73454a24104e13595c4e106b2f45ed21a13d32910
MD5 377f20764103fa8789a607812f38a70e
BLAKE2b-256 9fd6a5aa3ecc7c0b045b6d845c32d64a6185bf19a8f288fc00ecd01b07787e48

See more details on using hashes here.

File details

Details for the file dexa_sdk-0.1.14-py3-none-any.whl.

File metadata

  • Download URL: dexa_sdk-0.1.14-py3-none-any.whl
  • Upload date:
  • Size: 2.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.15 CPython/3.8.12 Darwin/22.1.0

File hashes

Hashes for dexa_sdk-0.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 519f56348fcd8ab204aeb7ef4402240cda445aee129dd9b6a9e038516b8a03ab
MD5 b7b385420c65aa9861b61b3ccec1747e
BLAKE2b-256 150bc9c7f51f4021f6d1bc31dfbfea0c808b5dc846a0d199f493e0e382394097

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page