[{"_1":2,"_153":-5,"_154":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_132":133},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":-5,"_85":86,"_125":-5,"_126":11,"_127":17,"_128":11,"_129":-5,"_130":131},"canonicalUrl","https://hub.docker.com/r/iccromeu/aries-framework-javascript/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","iccromeu","reponame","aries-framework-javascript","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":70,"_75":11,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2021-04-14T12:06:30.119974Z","description","aries-framework-javascript build","is_private","last_updated","2021-04-19T08:38:13.535138Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",976,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","

\n $\"Hyperledger$ \n

Aries Framework JavaScript

Built using TypeScript

\n $\"Pipeline$ \n $\"Language$ \n $\"Codecov$ \n $\"License\"$ \n $\"aries-framework-javascript$ \n

\n\nAries Framework JavaScript is a framework for building SSI Agents and DIDComm services that aims to be compliant and interoperable with the standards defined in the [Aries RFCs](https://github.com/hyperledger/aries-rfcs).\n\n## Table of Contents \n\n- [Goals](#goals)\n- [Usage](#usage)\n - [Prerequisites](#prerequisites)\n - [NodeJS](#nodejs)\n - [Installing](#installing)\n - [Using the framework](#using-the-framework)\n - [Usage in React Native](#usage-in-react-native)\n - [Logs](#logs)\n- [Architecture](#architecture)\n- [Development](#development)\n - [Setup Ledger](#setup-ledger)\n - [Running tests](#running-tests)\n - [Setting environment variables](#setting-environment-variables)\n - [Starting mediator agents](#starting-mediator-agents)\n - [With Docker](#with-docker)\n - [Only run e2e tests with in memory messaging](#only-run-e2e-tests-with-in-memory-messaging)\n - [Only run e2e tests with HTTP based routing agencies](#only-run-e2e-tests-with-http-based-routing-agencies)\n - [Run all tests](#run-all-tests)\n- [Usage with Docker](#usage-with-docker)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Goals\n\nThe framework is still in early development. At the moment the goal of this implementation is to run two independent Edge Agents (clients), running on mobile or desktop, which are able to communicate via a Mediator agent. It should at least adhere to the following requirements:\n\n- Edge Agent is independent on underlying communication layer. It can communicate via either HTTP request-response, WebSockets or Push Notifications.\n- Edge Agent can go offline and still receive its messages when it goes back to online.\n- There should be an option to connect more clients (Edge Agents) to one Routing Agent.\n- Prevent correlation.\n\nSee the [Roadmap](https://github.com/hyperledger/aries-framework-javascript/issues/39) or the [Framework Development](https://github.com/hyperledger/aries-framework-javascript/projects/1) project board for current progress.\n\n## Usage\n\n### Prerequisites\n\nAries Framework JavaScript depends on the indy-sdk which has some manual installation requirements.\n\n#### NodeJS\n\nFollow the instructions [here](https://github.com/hyperledger/indy-sdk/#installing-the-sdk) to install `libindy`. Also make sure to have the right tools installed for the [NodeJS wrapper](https://github.com/hyperledger/indy-sdk/tree/master/wrappers/nodejs#installing). The NodeJS wrapper link also contains some common troubleshooting steps.\n\nIf you don't want to install the dependencies yourself, the [Dockerfile](./Dockerfile) contains everything needed to get started with the framework. See [Usage with Docker](#usage-with-docker) for more information.\n\n> If you're having trouble running this project, please read the [troubleshooting](./TROUBLESHOOTING.md) section. It contains the most common errors that arise when first installing libindy.\n\n> NOTE: The package is not tested in multiple versions of Node at the moment. If you're having trouble installing dependencies or running the framework know that at least **Node v12 DOES WORK** and **Node v14 DOES NOT WORk**.\n\n### Installing\n\nAdd the framework as a dependency to your project:\n\n```sh\nnpm install aries-framework\n\n# Or using Yarn\nyarn add aries-framework\n```\n\nThen make sure to install the correct Indy implementation for your platform.\n\n```sh\n# for NodeJS\nyarn install indy-sdk\n\n# for React Native\nyarn install rn-indy-sdk\n```\n\n### Using the framework\n\nWhile the framework is still in early development the best way to know what API the framework exposes is by looking at the [tests](src/__tests__), the [source code](src) or the [samples](samples). As the framework reaches a more mature state, documentation on the usage of the framework will be added.\n\n### Usage in React Native\n\nThe framework is designed to be usable in multiple environments. The indy-sdk is the only dependency that needs special handling and is therefore an parameter when initializing the agent. Alongside Aries Framework JavaScript you need to install the indy-sdk for the environment you're using.\n\nThe when initializing the agent you can pass the specific Indy API as an input parameter:\n\n```typescript\n// for NodeJS\nimport indy from 'indy-sdk'\n\n// for React Native\nimport indy from 'rn-indy-sdk'\n\nconst config = {\n // ... other config properties ...\n indy,\n}\n\nagent = new Agent(config, inboundTransport, outboundTransport)\n```\n\nFor an example react native app that makes use of the framework see [Aries Mobile Agent React Native](https://github.com/animo/aries-mobile-agent-react-native.git)\n\n### Logs\n\nTo enable logging inside the framework a logger must be passed to the agent config. A simple `ConsoleLogger` can be imported from the framework, for more advanced use cases the `ILogger` interface can implemented. See [`TestLogger`](./src/__tests__/logger.ts) for a more advanced example.\n\n```ts\nimport { ILogger, ConsoleLogger, LogLevel } from 'aries-framework-javascript'\n\nconst agentConfig = {\n // ... other config properties ...\n logger: new ConsoleLogger(LogLevel.debug),\n}\n```\n\n## Architecture\n\nAgent class has method `receiveMessage` which **unpacks** incoming **inbound message** and then pass it to the `dispatch` method. This method just tries to find particular `handler` according to message `@type` attribute. Handler then process the message, calls services if needed and also creates **outbound message** to be send by sender, if it's required by protocol.\n\nIf handler returns an outbound message then method `sendMessage` **packs** the message with defined recipient and routing keys. This method also creates **forwardMessage** when routing keys are available. The way an outbound message is send depends on the implementation of MessageSender interface. Outbound message just need to contain all information which is needed for given communication (e. g. HTTP endpoint for HTTP protocol).\n\n## Development\n\n### Setup Ledger\n\n```sh\n# Build indy pool\ndocker build -f network/indy-pool.dockerfile -t indy-pool .\n\n# Start indy pool\ndocker run -d --rm --name indy-pool -p 9701-9708:9701-9708 indy-pool\n\n# Setup CLI. This creates a wallet, connects to the ledger and sets the Transaction Author Agreement\ndocker exec indy-pool indy-cli-setup\n\n# DID and Verkey from seed\ndocker exec indy-pool add-did-from-seed 000000000000000000000000Trustee9\n\n# If you want to register using the DID/Verkey you can use\n# docker exec indy-pool add-did \"NkGXDEPgpFGjQKMYmz6SyF\" \"CrSA1WbYYWLJoHm16Xw1VEeWxFvXtWjtsfEzMsjB5vDT\"\n```\n\n### Running tests\n\nTest are executed using jest. Some test require either the **mediator agents** or the **ledger** to be running. When running tests that require a connection to the ledger pool, you need to set the `TEST_AGENT_PUBLIC_DID_SEED` and `GENESIS_TXN_PATH` environment variables.\n\n#### Setting environment variables\n\n- `GENESIS_TXN_PATH`: The path to the genesis transaction that allows us to connect to the indy pool.\n - `GENESIS_TXN_PATH=network/genesis/local-genesis.txn` - default. Works with the [ledger setup](#setup-ledger) from the previous step.\n - `GENESIS_TXN_PATH=network/genesis/builder-net-genesis.txn` - Sovrin BuilderNet genesis.\n - `GENESIS_TXN_PATH=/path/to/any/ledger/you/like`\n- `TEST_AGENT_PUBLIC_DID_SEED`: The seed to use for the public DID. This will be used to do public write operations to the ledger. You should use a seed for a DID that is already registered on the ledger.\n - If using the local or default genesis, use the same seed you used for the `add-did-from-seed` command form the [ledger setup](#setup-ledger) in the previous step.\n - If using the BuilderNet genesis, make sure your seed is registered on the BuilderNet using [selfserve.sovrin.org](https://selfserve.sovrin.org/) and you have read and accepted the associated [Transaction Author Agreement](https://github.com/sovrin-foundation/sovrin/blob/master/TAA/TAA.md). We are not responsible for any unwanted consequences of using the BuilderNet.\n\n#### Starting mediator agents\n\nTo start the mediator agents you need to run two commands. See the [Usage with Docker](#usage-with-docker) section on how to run the mediators inside docker.\n\nOpen terminal and start Alice's mediator:\n\n```\n./scripts/run-mediator.sh mediator01\n```\n\nOpen new terminal and start Bob's mediator:\n\n```\n./scripts/run-mediator.sh mediator02\n```\n\n##### With Docker\n\nTo run the mediators inside docker you can use the `docker-compose-mediators.yml` file:\n\n```sh\n# Run alice-mediator and bob-mediator\ndocker-compose -f docker/docker-compose-mediators.yml up -d\n```\n\nIf you want the ports to be exposed to the outside world using ngrok you can use the `docker-compose-mediators-ngrok.yml` extension. Make sure the ngrok docker compose file is used after the normal docker compose file.\n\n```sh\n# Run alice-mediator and bob-mediator exposed via ngrok\ndocker-compose -f docker/docker-compose-mediators.yml -f docker/docker-compose-mediators-ngrok.yml up -d\n```\n\n#### Only run e2e tests with in memory messaging\n\nYou don't have to start mediator agents or the ledger for these tests. Communication is done via RxJS subscriptions.\n\n```\nyarn test -t \"agents\"\n```\n\n#### Only run e2e tests with HTTP based routing agencies\n\nMake sure the **mediator agents** from the [Starting mediator agents](#starting-mediator-agents) step are running and then run:\n\n```\nyarn test -t \"with mediator\"\n```\n\n#### Run all tests\n\nMake sure the **mediator agents** from [Starting mediator agents](#starting-mediator-agents) are running and you pass the correct environment variables from [Setting environment variables](#setting-environment-variables) for connecting to the indy **ledger** pool.\n\n```\nGENESIS_TXN_PATH=network/genesis/local-genesis.txn TEST_AGENT_PUBLIC_DID_SEED=000000000000000000000000Trustee9 yarn test\n```\n\n## Usage with Docker\n\nIf you don't want to install the libindy dependencies yourself, or want a clean environment when running the framework or tests you can use docker.\n\nMake sure you followed the [local ledger setup](#setup-ledger) to setup a local indy pool inside docker.\n\n```sh\n# Builds the framework docker image with all dependencies installed\ndocker build -t aries-framework-javascript .\n\n# Run tests without network\ndocker run -it --rm aries-framework-javascript yarn test -t \"agents\"\n\n# Run test with mediator agents and ledger pool\ndocker-compose -f docker/docker-compose-mediators.yml up -d # Run alice-mediator and bob-mediator\ndocker run --rm --network host --env TEST_AGENT_PUBLIC_DID_SEED=000000000000000000000000Trustee9 --env GENESIS_TXN_PATH=network/genesis/local-genesis.txn aries-framework-javascript yarn test\n```\n\n## Contributing\n\nFound a bug? Ready to submit a PR? Want to submit a proposal for your grand idea? See our [CONTRIBUTING](CONTRIBUTING.md) file for more information to get you started!\n\n## License\n\nHyperledger Aries Framework JavaScript is licensed under the [Apache License Version 2.0 (Apache-2.0)](LICENSE).\n","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",570201056,"orgData","recentTags",[87],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":62,"_124":17},"content_type","creator",12560156,"full_size",298431647,"id",145537491,"images",[97],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":62,"_113":-5},"architecture","amd64","digest","sha256:374363b8b31cd9f643c2b2fadc9f4ae621d000e54b6d80aea954b0519e9317c5","features","","last_pulled","2026-08-30T06:50:25.301832976Z","last_pushed","2021-04-19T08:38:14Z","os","linux","os_features","os_version","size","variant","2021-04-19T08:38:13.229867Z","last_updater","last_updater_username","media_type","latest","repository",12304000,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":134,"_141":142,"_130":151,"_152":11},{"_36":135,"_38":136,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":137,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":138,"_75":11,"_76":140,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":139},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_143":60,"_144":-5,"_145":-5,"_146":147},"count","next","previous","results",[148],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":149,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":62,"_124":17},[150],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":62,"_113":-5},[],"canDeleteTags","actionData","errors"]

iccromeu/aries-framework-javascript

Tags for iccromeu/aries-framework-javascript