[TRACKING PR] pisp/master

.circleci/config.yml

@@ -15,7 +15,7 @@ orbs:
 # defaults
 #
 # YAML defaults templates, in alphabetical order
-##  
+##
 defaults_Dependencies: &defaults_Dependencies |
   apk --no-cache add git
   apk --no-cache add ca-certificates
@@ -50,7 +50,7 @@ defaults_license_scanner: &defaults_license_scanner
 executors:
   default-docker:
     working_directory: /home/circleci/project
-    docker: 
+    docker:
       - image: node:12.16.1-alpine
 
   default-machine:
@@ -66,10 +66,10 @@ jobs:
   setup:
     executor: default-docker
     steps:
-      - checkout
       - run:
           name: Install general dependencies
           command: *defaults_Dependencies
+      - checkout
       - run:
           name: Access npm folder as root
           command: cd $(npm root -g)/npm
@@ -87,10 +87,10 @@ jobs:
   test-unit:
     executor: default-docker
     steps:
-      - checkout
       - run:
           name: Install general dependencies
           command: *defaults_Dependencies
+      - checkout
       - restore_cache:
           keys:
           - dependency-cache-5-{{ checksum "src/package.json" }}
@@ -129,10 +129,10 @@ jobs:
   lint:
     executor: default-docker
     steps:
-      - checkout
       - run:
           name: Install general dependencies
           command: *defaults_Dependencies
+      - checkout
       - restore_cache:
           keys:
           - dependency-cache-5-{{ checksum "src/package.json" }}
@@ -179,7 +179,7 @@ jobs:
           root: /tmp
           paths:
             - ./docker-image.tar
-      
+
   license-scan:
     executor: default-machine
     steps:
@@ -249,7 +249,7 @@ jobs:
   #         failure_message: 'Anchore Image Scan failed for: \`"${DOCKER_ORG}/${CIRCLE_PROJECT_REPONAME}:${CIRCLE_TAG}"\`'
   #     - store_artifacts:
   #         path: anchore-reports
-  
+
   publish:
     executor: default-machine
     steps:
@@ -271,8 +271,17 @@ jobs:
           command: |
             echo "Publishing $DOCKER_ORG/$CIRCLE_PROJECT_REPONAME:$CIRCLE_TAG"
             docker push $DOCKER_ORG/$CIRCLE_PROJECT_REPONAME:$CIRCLE_TAG
-            echo "Publishing $DOCKER_ORG/$CIRCLE_PROJECT_REPONAME:$RELEASE_TAG"
-            docker push $DOCKER_ORG/$CIRCLE_PROJECT_REPONAME:$RELEASE_TAG
+            case "$CIRCLE_TAG" in
+              *-pisp*)
+                # Don't update `late5t` for an image that has a `-pisp`
+                echo 'skipping late5t tag'
+                exit 0
+                ;;
+              *)
+                echo "Publishing $DOCKER_ORG/$CIRCLE_PROJECT_REPONAME:$RELEASE_TAG"
+                docker push $DOCKER_ORG/$CIRCLE_PROJECT_REPONAME:$RELEASE_TAG
+                ;;
+            esac
       - slack/status:
           webhook: "$SLACK_WEBHOOK_ANNOUNCEMENT"
           success_message: '*"${CIRCLE_PROJECT_REPONAME}"* - Release \`"${CIRCLE_TAG}"\` \nhttps://github.com/mojaloop/"${CIRCLE_PROJECT_REPONAME}"/releases/tag/"${CIRCLE_TAG}"'
@@ -344,7 +353,7 @@ workflows:
             - audit-licenses
           filters:
             tags:
-              only: /v[0-9]+(\.[0-9]+)*(\-snapshot)?(\-hotfix(\.[0-9]+))?/
+              only: /v[0-9]+(\.[0-9]+)*(\-snapshot)?(\-hotfix(\.[0-9]+))?(\-pisp)?/
             branches:
               ignore:
                 - /.*/
@@ -354,7 +363,7 @@ workflows:
             - build
           filters:
             tags:
-              only: /v[0-9]+(\.[0-9]+)*(\-snapshot)?(\-hotfix(\.[0-9]+))?/
+              only: /v[0-9]+(\.[0-9]+)*(\-snapshot)?(\-hotfix(\.[0-9]+))?(\-pisp)?/
             branches:
               ignore:
                 - /.*/
@@ -375,7 +384,7 @@ workflows:
             - license-scan
           filters:
             tags:
-              only: /v[0-9]+(\.[0-9]+)*(\-snapshot)?(\-hotfix(\.[0-9]+))?/
+              only: /v[0-9]+(\.[0-9]+)*(\-snapshot)?(\-hotfix(\.[0-9]+))?(\-pisp)?/
             branches:
               ignore:
                 - /.*/

.gitignore

@@ -2,3 +2,6 @@
 node_modules/
 .swp
 src/junit.xml
+.DS_Store
+.vscode
+secrets/*.pem

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:12.16.1-alpine as builder
+FROM node:12.18.3-alpine as builder
 
 RUN apk add --no-cache git python build-base
 
@@ -10,17 +10,18 @@ WORKDIR /src/
 # files change- only when any dependencies change- which is a superior developer experience when
 # relying on docker-compose.
 COPY ./src/package.json ./package.json
+COPY ./src/package-lock.json ./package-lock.json
 COPY ./src/lib/cache/package.json ./lib/cache/package.json
-COPY ./src/lib/log/package.json ./lib/log/package.json
+COPY ./src/lib/check/package.json ./lib/check/package.json
 COPY ./src/lib/model/lib/requests/package.json ./lib/model/lib/requests/package.json
 COPY ./src/lib/model/lib/shared/package.json ./lib/model/lib/shared/package.json
 COPY ./src/lib/model/package.json ./lib/model/package.json
 COPY ./src/lib/randomphrase/package.json ./lib/randomphrase/package.json
 COPY ./src/lib/router/package.json ./lib/router/package.json
 COPY ./src/lib/validate/package.json ./lib/validate/package.json
-RUN npm install
+RUN npm ci --only=production
 
-FROM node:12.16.1-alpine
+FROM node:12.18.3-alpine
 
 ARG BUILD_DATE
 ARG VCS_URL
@@ -37,7 +38,6 @@ LABEL org.label-schema.url="https://mojaloop.io/"
 LABEL org.label-schema.version=$VERSION
 
 COPY --from=builder /src/ /src
-RUN npm prune --production
 COPY ./src ./src
 COPY ./secrets /
 

Dockerfile-integration

@@ -0,0 +1,44 @@
+FROM node:12.18.3-alpine as builder
+
+RUN apk add --no-cache git python build-base
+
+EXPOSE 3000
+
+WORKDIR /src/
+
+# This is super-ugly, but it means we don't have to re-run npm install every time any of the source
+# files change- only when any dependencies change- which is a superior developer experience when
+# relying on docker-compose.
+COPY ./src/package.json ./package.json
+COPY ./src/package-lock.json ./package-lock.json
+COPY ./src/lib/cache/package.json ./lib/cache/package.json
+COPY ./src/lib/check/package.json ./lib/check/package.json
+COPY ./src/lib/model/lib/requests/package.json ./lib/model/lib/requests/package.json
+COPY ./src/lib/model/lib/shared/package.json ./lib/model/lib/shared/package.json
+COPY ./src/lib/model/package.json ./lib/model/package.json
+COPY ./src/lib/randomphrase/package.json ./lib/randomphrase/package.json
+COPY ./src/lib/router/package.json ./lib/router/package.json
+COPY ./src/lib/validate/package.json ./lib/validate/package.json
+RUN npm ci
+
+FROM node:12.18.3-alpine
+
+ARG BUILD_DATE
+ARG VCS_URL
+ARG VCS_REF
+ARG VERSION
+
+# See http://label-schema.org/rc1/ for label schema info
+LABEL org.label-schema.schema-version="1.0"
+LABEL org.label-schema.name="sdk-scheme-adapter"
+LABEL org.label-schema.build-date=$BUILD_DATE
+LABEL org.label-schema.vcs-url=$VCS_URL
+LABEL org.label-schema.vcs-ref=$VCS_REF
+LABEL org.label-schema.url="https://mojaloop.io/"
+LABEL org.label-schema.version=$VERSION
+
+COPY --from=builder /src/ /src
+COPY ./src ./src
+COPY ./secrets /
+
+CMD ["node", "src/index.js"]

README.md

@@ -153,4 +153,19 @@ docker exec -it scheme-adapter-int sh -c 'npm run test:int'
 
 # copy results out
 docker cp scheme-adapter-int:/src/junit.xml .
-```
+```
+
+### Get status of quote request
+The status of a previously sent quotation request can be get by executing `GET /quotes/{ID}`.
+When the response to the original quote request is sent, the response is cached in the redis store. When a `GET /quotes/{ID}` is received,
+the cached response is retrieved from the redis store and returned to the caller as a body with `PUT /quotes/{ID}` request.
+When the redis is setup as a persistent store then it will return the response for all the quote requests sent with `POST /quotes`. If the the redis is setup as cache with expiry time then it will not return response for the expired quotes when the cache expires. Also only the payer dfsp is supposed to make the `GET /quotes/{ID}` request.
+If the quote response is not found in the redis store `PUT /quotes/{ID}` will be made with the following body
+```
+{
+   "errorInformation":{
+      "errorCode":"3205",
+      "errorDescription":"Quote ID not found"
+   }
+}
+```

docker-compose.integration.yml

@@ -11,6 +11,7 @@ services:
     container_name: scheme-adapter-int
     build:
       context: .
+      dockerfile: Dockerfile-integration
       target: builder
     env_file: ./src/test/config/integration.env
     volumes:

docs/dfspInboundApi.yaml

@@ -9,7 +9,7 @@ info:
   license:
     name: Apache License Version 2.0, January 2004
     url: http://www.apache.org/licenses/
-  version: 1.0.0
+  version: 1.1.0
 
 paths:
   /participants/{idType}/{idValue}:
@@ -171,6 +171,24 @@ paths:
                 $ref: '#/components/schemas/transferDetailsResponse'
         500:
           $ref: '#/components/responses/500'
+    put:
+      summary: Receive notification for a specific transfer
+      description: The HTTP request `PUT /transfers/{transferId}` is used to receive notification for transfer being fulfiled when the FSP is a Payee
+      tags:
+        - Transfers
+      parameters:
+        - $ref: '#/components/schemas/transferId'
+      requestBody:
+        description: An incoming notification for fulfiled transfer
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/fulfilNotification'
+      responses:
+        200:
+          description: The notification was accepted
+        500:
+          $ref: '#/components/responses/500'
 
 components:
   schemas:
@@ -345,6 +363,8 @@ components:
       - XDR
       - XOF
       - XPF
+      - XTS
+      - XXX
       - YER
       - ZAR
       - ZMW
@@ -380,6 +400,13 @@ components:
       minItems: 0
       maxItems: 16
 
+    accountList:
+      type: array
+      items:
+        $ref: '#/components/schemas/account'
+      minItems: 1
+      maxItems: 32
+
     geoCode:
       type: object
       description: Indicates the geographic location from where the transaction was initiated.
@@ -478,6 +505,23 @@ components:
           minLength: 1
           maxLength: 128
 
+
+    account:
+      type: object
+      properties:
+        address:
+          type: string
+          minLength: 1
+          maxLength: 1023
+        currency:
+          type: string
+          minLength: 3
+          maxLength: 3
+        description:
+          type: string
+          minLength: 1
+          maxLength: 128
+
     initiatorType:
       type: string
       enum:
@@ -680,6 +724,8 @@ components:
           description: Up to 4 digits specifying the sender's merchant classification, if known and applicable.
         extensionList:
           $ref: '#/components/schemas/extensionList'
+        accounts:
+          $ref: '#/components/schemas/accountList'
 
     transferState:
       type: string
@@ -774,14 +820,33 @@ components:
         extensions:
           $ref: '#/components/schemas/extensionList'
 
-
     transferStatus:
       type: string
       enum:
       - ERROR_OCCURRED
       - WAITING_FOR_QUOTE_ACCEPTANCE
       - COMPLETED
 
+    fulfilNotification:
+      title: TransfersIDPatchResponse
+      type: object
+      description: PUT /transfers/{transferId} object
+      properties:
+        completedTimestamp:
+          $ref: '#/components/schemas/timestamp'
+          description: Time and date when the transaction was completed.
+          example: "2020-05-19T08:38:08.699-04:00"
+        transferState:
+          $ref: '#/components/schemas/transferState'
+          description: State of the transfer.
+          example: COMMITTED
+        extensionList:
+          $ref: '#/components/schemas/ExtensionList'
+          description: Optional extension, specific to deployment.
+      required:
+        - completedTimestamp
+        - transferState
+
   responses:
     '400':
       description: Malformed or missing required headers or parameters
@@ -833,4 +898,3 @@ components:
         minLength: 1
         maxLength: 128
       description: Either a sub-identifier of a `{idValue}`, or a sub-type of the `{idType}`, normally a `{personalIdType}`
-