aries-mobile-agent-react-native icon indicating copy to clipboard operation
aries-mobile-agent-react-native copied to clipboard

Aries Mobile Agent for React Native, built using Aries Framework JavaScript

⚠️ This repository is deprecated ⚠️

Future work is happening at hyperledger/aries-mobile-agent-react-native




Hyperledger Aries logo

Aries Mobile Agent React Native

Built using TypeScript

Aries Mobile Agent React Native is a mobile agent built on top of Aries Framework JavaScript

Usage

Prerequisites

For iOS you will also need to install CocoaPods

Besides the prerequisites listed above, the mobile agent relies on an external mediator to receive messages. You can start a sample mediator from the Aries Framework JavaScript repo. Run the following to start two sample mediators:

git clone https://github.com/hyperledger/aries-framework-javascript.git
cd aries-framework-javascript

docker-compose -f docker/docker-compose-mediators.yml -f docker/docker-compose-mediators-ngrok.yml up

The logs will output the public ngrok URL the mediator is exposed at. Copy the "url" value from the output (either alice or bob), it should look something like https://90eab166f78c.ngrok.io:

alice-mediator_1  | 2020-12-07T09:27:09.786Z aries-framework-javascript ---------- Creating agent with config ----------
alice-mediator_1  |  {
alice-mediator_1  |   "url": "https://90eab166f78c.ngrok.io",
alice-mediator_1  |   "port": "3001",
alice-mediator_1  |   "label": "RoutingMediator01",
alice-mediator_1  |   "walletConfig": {
alice-mediator_1  |     "id": "mediator01"
alice-mediator_1  |   },
alice-mediator_1  |   "walletCredentials": {
alice-mediator_1  |     "key": "0000000000000000000000000Mediator01"
alice-mediator_1  |   },
alice-mediator_1  |   "publicDid": "DtWRdd6C5dN5vpcN6XRAvu",
alice-mediator_1  |   "publicDidSeed": "00000000000000000000000Forward01",
alice-mediator_1  |   "autoAcceptConnections": true
alice-mediator_1  | }
alice-mediator_1  |

Now update the mediatorUrl in src/App.tsx to the copied URL:

const agent = await initAgent({
  mediatorUrl: 'https://90eab166f78c.ngrok.io',
})

Installation

To install the dependencies, run:

yarn **install**
pod install --project-directory=ios/ # needed for iOS

Running

To start the agent, you may run the following commands:

yarn android

# or for iOS
# yarn ios --device

Note: the current Indy iOS build included in this repo is not compiled for the architectures required by the iOS simulator. Therefore running this project in iOS will only work on a physical device

Contributing

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

License

Aries Mobile Agent React Native is licensed under the Apache License Version 2.0 (Apache-2.0).