Proxy client

.dockerignore

@@ -1,2 +1,3 @@
 .git
 target
+github

.github/workflows/build.yml

@@ -1,7 +1,7 @@
 name: "Indy-VDR"
 
 env:
-  RUST_VERSION: "1.63.0"
+  RUST_VERSION: "1.65.0"
   CROSS_VERSION: "0.2.4"
 
 on:
@@ -24,6 +24,10 @@ on:
         default: false
         type: boolean
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   checks:
     name: Run checks
@@ -54,7 +58,7 @@ jobs:
       - name: Cargo fmt
         run: cargo fmt --all -- --check
 
-      - if: "runner.os == 'Linux'"
+      - if: ${{ runner.os == 'Linux' }}
         name: Pre-install cross
         run: |
           cargo install --bins --git https://github.com/rust-embedded/cross --tag v${{ env.CROSS_VERSION }} cross
@@ -83,13 +87,15 @@ jobs:
 
       - name: Run local node pool
         run: |
-          docker build -f ci/indy-pool.dockerfile -t test_pool --build-arg pool_ip=10.0.0.2 ci
-          docker network create --subnet=10.0.0.0/8 indy-sdk-network
-          docker run -d --name indy_pool -p 9701-9708:9701-9708 --net=indy-sdk-network test_pool
+          ./ci/test.sh up
 
       - name: Run tests
         run: cargo test --manifest-path libindy_vdr/Cargo.toml --features local_nodes_pool
 
+      - name: Stop local node pool
+        run: |
+          ./ci/test.sh down
+
   build-release:
     name: Build library
     needs: [checks]
@@ -136,17 +142,22 @@ jobs:
           shared-key: deps
           save-if: false
 
-      - name: Build
-        shell: sh
+      - if: ${{ matrix.use_cross }}
+        name: Build (cross)
         run: |
-          if [ -n "${{ matrix.use_cross }}" ]; then
-            cargo install --bins --git https://github.com/rust-embedded/cross --tag v${{ env.CROSS_VERSION }} cross
-            cross build --lib --release --target ${{ matrix.target }}
-          elif [ "${{ matrix.architecture }}" == "darwin-universal" ]; then
-            ./build-universal.sh
-          else
-            cargo build --lib --release --target ${{ matrix.target }}
-          fi
+          cargo install --bins --git https://github.com/rust-embedded/cross --tag v${{ env.CROSS_VERSION }} cross
+          cross build --lib --release --target ${{ matrix.target }}
+
+      - if: ${{ !matrix.use_cross && matrix.architecture == 'darwin-universal' }}
+        name: Build (mac)
+        run: ./build-universal.sh
+
+      # Requires using the default shell on Windows, otherwise it will complain:
+      # "This perl implementation doesn't produce Windows like paths"
+      - if: ${{ !matrix.use_cross && matrix.architecture != 'darwin-universal' }}
+        name: Build (standard)
+        run: |
+          cargo build --lib --release --target ${{ matrix.target }}
 
       - name: Upload library artifacts
         uses: actions/upload-artifact@v3
@@ -243,6 +254,15 @@ jobs:
       - name: Check types
         run: yarn check-types
 
+      - name: Run local node pool
+        run: |
+          cd ../../
+          docker build -f ci/indy-pool.dockerfile -t test_pool --build-arg pool_ip=10.0.0.2 ci
+          docker network create --subnet=10.0.0.0/8 indy-sdk-network
+          docker run -d --name indy_pool -p 9701-9708:9701-9708 --net=indy-sdk-network test_pool
+          cd wrappers/javascript
+          docker exec $(docker ps -aqf "ancestor=test_pool") cat /var/lib/indy/sandbox/pool_transactions_genesis >> genesis.txn
+
       - name: Run tests
         env:
           # binary is downloaded to root of repository
@@ -283,16 +303,14 @@ jobs:
       - name: Install Rust toolchain
         uses: dtolnay/rust-toolchain@master
         with:
-          # First version with support for cdylib: https://github.com/rust-lang/rust/pull/100636
-          toolchain: "1.65.0"
+          toolchain: ${{ env.RUST_VERSION }}
           targets: ${{ matrix.target }}
 
-      # Not useful unless the toolchain version matches the default
-      # - name: Cache cargo resources
-      #   uses: Swatinem/rust-cache@v2
-      #   with:
-      #     shared-key: deps
-      #     save-if: false
+      - name: Cache cargo resources
+        uses: Swatinem/rust-cache@v2
+        with:
+          shared-key: deps
+          save-if: false
 
       - name: Build
         run: |
@@ -302,7 +320,7 @@ jobs:
         uses: actions/upload-artifact@v3
         with:
           name: library-${{ matrix.target}}
-          path: target/${{ matrix.target }}/release/libindy_vdr.dylib
+          path: target/${{ matrix.target }}/release/libindy_vdr.a
 
   create-ios-xcframework:
     name: Create iOS xcframework
@@ -313,7 +331,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
 
-      - name: Fetch dynamic libraries
+      - name: Fetch static libraries
         uses: actions/download-artifact@v3
 
       - run: >
@@ -337,6 +355,9 @@ jobs:
   build-android:
     name: Build library (Android)
     needs: [checks]
+    env:
+      RUST_VERSION: "1.64.0" # Overriding the rust version here for lower NDK support
+
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -352,6 +373,11 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
 
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: ${{ env.RUST_VERSION }}
+
       - name: Build
         run: |
           cargo install --bins --git https://github.com/rust-embedded/cross --tag v${{ env.CROSS_VERSION }} cross
@@ -402,7 +428,7 @@ jobs:
     if: |
       (github.event_name == 'release' ||
       (github.event_name == 'workflow_dispatch' &&
-       github.event.inputs.publish == 'true'))
+       github.event.inputs.publish-binaries == 'true'))
 
     steps:
       - name: Fetch Android libraries
@@ -483,14 +509,14 @@ jobs:
       - name: Test python package
         # FIXME cross platform test the python package
         # maybe use the cross docker image?
-        if: "matrix.architecture != 'linux-aarch64'"
+        if: ${{ matrix.architecture != 'linux-aarch64' }}
         shell: sh
         run: |
           pip install dist/*
           python -m demo.test
         working-directory: wrappers/python
 
-      - if: "runner.os == 'Linux'"
+      - if: ${{ runner.os == 'Linux' }}
         name: Audit wheel
         run: |
           auditwheel show wrappers/python/dist/* | tee auditwheel.log

.gitignore

@@ -12,3 +12,5 @@ coverage
 *.tgz
 *.so
 .npmrc
+github
+**/networks

Cargo.toml

@@ -4,6 +4,7 @@ resolver = "2"
 members = [
     "libindy_vdr",
     "indy-vdr-proxy",
+    "indy-vdr-proxy-client",
 ]
 
 [profile.release]

Cross.toml

@@ -5,13 +5,13 @@ image = "ghcr.io/rust-cross/manylinux2014-cross:aarch64"
 image = "ghcr.io/rust-cross/manylinux2014-cross:x86_64"
 
 [target.x86_64-linux-android]
-image = "ghcr.io/cross-rs/x86_64-linux-android:main"
+image = "ghcr.io/hyperledger/aries-builder-images/cross/x86_64-linux-android:main"
 
 [target.i686-linux-android]
-image = "ghcr.io/cross-rs/i686-linux-android:main"
+image = "ghcr.io/hyperledger/aries-builder-images/cross/i686-linux-android:main"
 
 [target.aarch64-linux-android]
-image = "ghcr.io/cross-rs/aarch64-linux-android:main"
+image = "ghcr.io/hyperledger/aries-builder-images/cross/aarch64-linux-android:main"
 
 [target.armv7-linux-androideabi]
-image = "ghcr.io/cross-rs/armv7-linux-androideabi:main"
+image = "ghcr.io/hyperledger/aries-builder-images/cross/armv7-linux-androideabi:main"

README.md

@@ -39,27 +39,49 @@ At a later stage it should be possible to install a precompiled 'wheel' package
 
 ## Proxy Server
 
-The `indy-vdr-proxy` executable can be used to provide a simple REST API for interacting with the ledger. Command line options can be inspected by running `indy-vdr-proxy --help`.
+The `indy-vdr-proxy` executable can be used to provide a simple REST API for interacting with one or more Indy ledgers. Command line options can be inspected by running `indy-vdr-proxy --help`.
 
-Responses can be formatted in either HTML or JSON formats. HTML formatting is selected when the `text/html` content type is requested according to the Accept header (as sent by web browsers) or the request query string is set to `?html`. JSON formatting is selected otherwise, and may be explitly selected by using the query string `?raw`. For most ledger requests, JSON responses include information regarding which nodes were contacted is returned in the `X-Requests` header.
+To start the proxy server for a single ledger use the following command:
+```
+indy-vdr-proxy -p <PORT> (-g <OPTIONAL_PATH_TO_GENESIS_FILE>)
+```
+
+To start the proxy server with the standard configuration of indy ledgers use the following command:
+`indy-vdr-proxy -p <PORT> -- --multiple-ledgers`
+This will get the ledger configuration from `https://github.com/IDunion/indy-did-networks`
 
-Sending prepared requests to the ledger is performed by delivering a POST request to the `/submit` endpoint, where the body of the request is the JSON-formatted payload. Additional endpoints are provided as shortcuts for ledger read transactions:
-
-- `/` The root path shows basic status information about the server and the ledger pool
-- `/genesis` Return the current set of genesis transactions
-- `/taa` Fetch the current ledger Transaction Author Agreement
-- `/aml` Fetch the current ledger Acceptance Methods List (for the TAA)
-- `/nym/{DID}` Fetch the NYM transaction associated with a DID
-- `/attrib/{DID}/endpoint` Fetch the registered endpoint for a DID
-- `/schema/{SCHEMA_ID}` Fetch a schema by its identifier
-- `/cred_def/{CRED_DEF_ID}` Fetch a credential definition by its identifier
-- `/rev_reg/{REV_REG_ID}` Fetch a revocation registry by its identifier
-- `/rev_reg_def/{REV_REG_ID}` Fetch a revocation registry definition by its registry identifier
-- `/rev_reg_delta/{REV_REG_ID}` Fetch a revocation registry delta by its registry identifier
-- `/auth` Fetch all AUTH rules for the ledger
-- `/auth/{TXN_TYPE}/{ADD|EDIT}` Fetch the AUTH rule for a specific transaction type and action
-- `/txn/{SUBLEDGER}/{SEQ_NO}` Fetch a specific transaction by subledger identifier (0-2, or one of `pool`, `domain`, or `config`) and sequence number.
+A custom ledger configuration can be provided either by specificing a Github repo or a local folder:
+```
+indy-vdr-proxy -p <PORT> -g <GITHUB_URL or PATH_TO_FOLDER> -- --multiple-ledgers
+```
+The structure needs to be as follows `<NAMESPACE>/OPTIONAL<SUB_NAMESPACE>/pool_transactions_genesis.json`, e.g. `/sovrin/staging/pool_transactions_genesis.json`
+
+Responses can be formatted in either HTML or JSON formats. HTML formatting is selected when the `text/html` content type is requested according to the Accept header (as sent by web browsers) or the request query string is set to `?html`. JSON formatting is selected otherwise, and may be explitly selected by using the query string `?raw`. For most ledger requests, JSON responses include information regarding which nodes were contacted is returned in the `X-Requests` header.
 
+Sending prepared requests to the ledger is performed by delivering a POST request to the `{LEDGER}/submit` endpoint, where the body of the request is the JSON-formatted payload. Additional endpoints are provided as shortcuts for ledger read transactions:
+- `/` Return configured ledgers 
+- `{LEDGER}/` Basic status information about the server and the ledger pool
+- `{LEDGER}/genesis` Return the current set of genesis transactions
+- `{LEDGER}/taa` Fetch the current ledger Transaction Author Agreement
+- `{LEDGER}/aml` Fetch the current ledger Acceptance Methods List (for the TAA)
+- `{LEDGER}/nym/{DID}` Fetch the NYM transaction associated with an unqualified DID. Can be used with `timestamp` or `seq_no` query parameters to fetch specific versions
+- `{LEDGER}/attrib/{DID}/endpoint` Fetch the registered endpoint for an unqualified DID
+- `{LEDGER}/schema/{SCHEMA_ID}` Fetch a schema by its identifier
+- `{LEDGER}/cred_def/{CRED_DEF_ID}` Fetch a credential definition by its identifier
+- `{LEDGER}/rev_reg/{REV_REG_ID}` Fetch a revocation registry by its identifier
+- `{LEDGER}/rev_reg_def/{REV_REG_ID}` Fetch a revocation registry definition by its registry identifier
+- `{LEDGER}/rev_reg_delta/{REV_REG_ID}` Fetch a revocation registry delta by its registry identifier
+- `{LEDGER}/auth` Fetch all AUTH rules for the ledger
+- `{LEDGER}/auth/{TXN_TYPE}/{ADD|EDIT}` Fetch the AUTH rule for a specific transaction type and action
+- `{LEDGER}/txn/{SUBLEDGER}/{SEQ_NO}` Fetch a specific transaction by subledger identifier (0-2, or one of `pool`, `domain`, or `config`) and sequence number.
+
+If the proxy server is used with a single ledger, the `{LEDGER}` part of the path must be omitted.
+
+### DID:Indy Resolver
+
+Indy VDR contains a DID Resolver to resolve DIDs and dereference DID Urls to ledger objects from configured ledgers according to the [did:indy specification](https://hyperledger.github.io/indy-did-method/).
+
+`GET /1.0/identifiers/{DID or DID_URL}`
 ## Connecting to a Ledger
 
 Whether using the library or the proxy server, you will need a `genesis.txn` file containing the set of pool genesis transactions. You can run a local pool in Docker using [VON-Network](https://github.com/bcgov/von-network) or follow the [Indy-SDK instructions](https://github.com/hyperledger/indy-sdk#how-to-start-local-nodes-pool-with-docker).

build-xcframework.sh

@@ -3,22 +3,25 @@
 set -eo pipefail
 
 # Check if lipo and xcodebuild exist
-if [ -z `command -v lipo` ] || [ -z `command -v xcodebuild` ]
+if [ -z `command -v lipo` ] || [ -z `command -v xcodebuild` ] || [ -z `command -v sed` ]
+
 then
-    echo "!!! lipo or xcodebuild could not be found !!!"
+    echo "!!! lipo, xcodebuild or sed could not be found !!!"
     help
 fi
 
 NAME="indy_vdr"
+BUNDLE_NAME="indy-vdr"
 VERSION=$(cargo generate-lockfile && cargo pkgid indy-vdr | sed -e "s/^.*[#@]//")
 echo $VERSION
-BUNDLE_IDENTIFIER="org.hyperledger.$NAME"
-LIBRARY_NAME="lib$NAME.dylib"
+BUNDLE_IDENTIFIER="org.hyperledger.$BUNDLE_NAME"
+LIBRARY_NAME="lib$NAME.a"
 XC_FRAMEWORK_NAME="$NAME.xcframework"
 FRAMEWORK_LIBRARY_NAME=$NAME
 FRAMEWORK_NAME="$FRAMEWORK_LIBRARY_NAME.framework"
 HEADER_NAME="lib$NAME.h"
 OUT_PATH="out"
+MIN_IOS_VERSION="12.0"
 
 # Setting some default paths
 AARCH64_APPLE_IOS_PATH="./target/aarch64-apple-ios/release"
@@ -33,9 +36,9 @@ Help() {
   echo "  - xcodebuild"
   echo "To build an xcframework with underlying Frameworks"
   echo "the following can be passed in as positional arguments"
-  echo "  1. Path to the aarch64-apple-ios directory where the $LIBRARY is stored"
-  echo "  2. Path to the aarch64-apple-ios-sim directory where the $LIBRARY is stored"
-  echo "  3. Path to the x86_64-apple-ios directory where the $LIBRARY is stored"
+  echo "  1. Path to the aarch64-apple-ios directory where the $LIBRARY_NAME is stored"
+  echo "  2. Path to the aarch64-apple-ios-sim directory where the $LIBRARY_NAME is stored"
+  echo "  3. Path to the x86_64-apple-ios directory where the $LIBRARY_NAME is stored"
   echo "  4. Path to the header file, excluding the header"
   echo "Make sure to add the 'release' section of the path for a"
   echo "release build."
@@ -156,6 +159,8 @@ cat <<EOT >> Info.plist
 	<string>$VERSION</string>
 	<key>NSPrincipalClass</key>
 	<string></string>
+  <key>MinimumOSVersion</key>
+  <string>$MIN_IOS_VERSION</string>
 </dict>
 </plist>
 EOT
@@ -179,8 +184,4 @@ xcodebuild -create-xcframework \
 echo "cleaning up..."
 rm -rf $FRAMEWORK_NAME real sim
 
-echo "Fixing the identifiers of the dylib..."
-install_name_tool -id  @rpath/$NAME.framework/$FRAMEWORK_LIBRARY_NAME $XC_FRAMEWORK_NAME/ios-arm64/$FRAMEWORK_NAME/$FRAMEWORK_LIBRARY_NAME
-install_name_tool -id  @rpath/$NAME.framework/$FRAMEWORK_LIBRARY_NAME $XC_FRAMEWORK_NAME/ios-arm64_x86_64-simulator/$FRAMEWORK_NAME/$FRAMEWORK_LIBRARY_NAME
-
 echo "Framework written to $OUT_PATH/$XC_FRAMEWORK_NAME"