原生鼠标 SDK

开始

安装

yarn add @consensys/native-ramps-sdk

或者说

npm install @consensys/native-ramps-sdk

使用量

import { NativeRampsSdk } from '@consensys/native-ramps-sdk'

// Initialize the SDK
const nativeRampsSdk = new NativeRampsSdk()

// Use the SDK methods

版本管理

要更新 SDK 版本 :

1. 更新版本编号 package.json数字 :

   {
     "version": "1.0.1"
   }
   

2. 安装要同步版本的依赖性 :

   npm install
   

SDK 自动使用来自 package.json 用于所有版本相关功能.

地方发展

为当地开发和测试SDK:

建造SDK

1. 安装依赖性 :

   npm install
   

2. 构建 SDK :

   npm run build
   

   这将:

   • 将类型文件编译为 JavaScript
   • 生成类型声明( E).d.ts 文档)
   • 将全部输出到 dist/ 目录

测试另一个工程的本地变化

在不发布的情况下测试您在其它工程中的本地变化 :

1. 构建 SDK( 如上所示)

2. 复制整个 dist/ 您的目标项目文件夹 node_modules/@consensys/native-ramps-sdk/ 目录 :

   # From your target project directory
   cp -r /path/to/native-ramps-sdk/dist/* ./node_modules/@consensys/native-ramps-sdk/dist/
   

3. 或者,您可以使用 npm 链接进行更无缝的开发体验 :

   # In the SDK directory
   npm link
   
   # In your target project directory
   npm link @consensys/native-ramps-sdk
   

发展 工作流量

1. 在 src/
2. 运行 npm run build 编辑您的修改
3. 复制更新 dist/ 用于测试项目或使用 npm 链接的文件
4. 测试您在目标工程中的变化
5. 视需要重复

其他有用的命令

• npm run test - 运行测试
• npm run lint - 检查代码样式
• npm run prettier - 格式代码
• npm run test:watch - 在监视模式下进行测试