mojaloop/sdk-scheme-adapter

Mojaloop SDK 方案适配器

该包提供了一个方案适配器，用于在Mojaloop API兼容交换机和不原生实现Mojaloop API的DFSP后端平台之间建立接口。

适配器与DFSP后端之间的API为同步HTTP，而与交换机之间的接口为原生Mojaloop API。

该包展示了Mojaloop SDK标准组件在TLS、JWS和ILP方面的使用（可在http://www.github.com/mojaloop/sdk-standard-components%E8%8E%B7%E5%8F%96%EF%BC%89%E3%80%82

有关该项目的背景和上下文信息，请参见此演示文稿。

DFSP 后端 API

DFSP后端必须实现DFSP 入站API，以便适配器接收资金到客户账户（即入站转账）。

DFSP后端可调用DFSP 出站API来发起资金转出（即从客户账户发送资金）。

Docker 镜像

该包作为预构建Docker镜像发布在Docker Hub上：https://hub.docker.com/r/mojaloop/sdk-scheme-adapter

快速开始

以下步骤演示了如何在本地设置Mojaloop SDK方案适配器及模拟DFSP后端。

此配置适合希望使用方案适配器将其后端系统与Mojaloop API启用的交换机集成的DFSP作为起点。

注意：以下说明适用于基于Linux的系统。对于Mac和/或Windows，需根据你的环境调整相应步骤。

1. 确保本地已安装docker和docker-compose。分别参见[***]

2. 克隆Mojaloop SDK模拟DFSP后端仓库到本地：

   进入工作目录，然后使用HTTPS克隆：

   bash
   $ git clone https://github.com/mojaloop/sdk-mock-dfsp-backend.git
   

   或使用SSH克隆：

   bash
   $ git clone git@github.com:mojaloop/sdk-mock-dfsp-backend.git
   

   进入克隆的仓库目录：

   bash
   $ cd sdk-mock-dfsp-backend
   

3. 编辑方案适配器配置，将其指向Mojaloop API启用的交换机或模拟器：

   使用文本编辑器编辑文件src/scheme-adapter.env。 将PEER_ENDPOINT变量的值修改为Mojaloop API启用的交换机或模拟器的DNS名称或IP地址及端口号。 保存文件。

4. 使用docker-compose下载并运行预构建的方案适配器、共享缓存和模拟DFSP后端容器：

   进入src子文件夹并运行docker-compose：

   bash
   $ cd src/
   $ docker-compose up
   

   Docker将下载方案适配器、共享缓存（redis）和模拟DFSP后端的预构建镜像，并启动容器。

5. 测试出站（发送资金）API：

   查找模拟DFSP后端容器的IP地址。可通过以下命令：

   bash
   docker network ls
   

   查看本地Docker网络列表，识别docker-compose创建的网络（名称基于运行docker-compose up的目录名）。

   识别网络后，使用以下命令查看网络详情：

   bash
   docker network inspect {网络名称}
   

   终端将输出包含网络中容器及其IP地址的JSON结构。

   使用以下命令指示模拟DFSP后端通过方案适配器发起出站转账：

   替换为Mock DFSP后端容器的正确IP地址

   bash
   curl -X POST \
     http://{模拟容器IP地址}:3000/send \
     -H 'Content-Type: application/json' \
     -d '{
       "from": {
           "displayName": "John Doe",
           "idType": "MSISDN",
           "idValue": "123456789"
       },
       "to": {
           "idType": "MSISDN",
           "idValue": "987654321"
       },
       "amountType": "SEND",
       "currency": "USD",
       "amount": "100",
       "transactionType": "TRANSFER",
       "note": "test payment",
       "homeTransactionId": "123ABC"
   }'
   

   上述调用的响应将指示方案适配器与Mojaloop API启用的交换机或模拟器之间的通信结果。

6. 联系你的交换机运营商或使用模拟器测试入站（接收资金）API。

现在可查看模拟DFSP后端的代码，了解其如何实现方案适配器简化的入站API。