dermonarch / aries-framework-go

Hyperledger Aries Framework Go provides packages for building Agent / DIDComm services

aries-framework-go

Introduction

A Go framework for Aries

Build

Prerequisites (General)

• Go 1.13

Prerequisites (for running tests)

• Go 1.13
• Docker
• Make

Targets

# run all the project build targets
make all

# run linter checks
make checks

# run unit tests
make unit-test

Crypto material generation for tests

For unit-tests, crypto material is generated under:

pkg/didcomm/transport/http/testdata

using the openssl tool.

It is generated automatically when running unit tests.

If you wish to regenerate it, you can delete this folder and:

1. run make unit-test or
2. cd into pkg/didcomm/transport/http/ and run go generate

Controller REST API specifications generation

Controller REST API specifications are generated according to Open API 2.0 standards.

It can be generated by running command make generate-openapi-test

Generated spec can be found under build/rest/openapi/spec

Contributing

Found a bug? Ready to submit a PR? Want to submit a proposal for your grand idea? Follow our guidelines for more information to get you started!

License

Hyperledger Aries Framework Go is licensed under the Apache License Version 2.0.