使用说明

安装

pnpm i ex-apis-node-sdk

本地运行

git clone https://github.com/tina0597/ex-apis-node-sdk.git
cd ex-apis-node-sdk
pnpm run install
pnpm run build

代码规范

本项目使用 TSLint + Prettier 进行代码规范检查。

运行代码检查

pnpm run lint

主要规则

• 使用单引号
• 优先使用 const 声明
• 使用箭头函数
• 禁止使用 any 类型（部分场景允许）
• 禁止使用 var 关键字
• 禁止使用 eval、debugger 等不安全代码
• 单行最大长度：100 字符
• 导入语句按字母排序

测试用例

| 文件名 | 说明 | | :--------------------------------: | :------------------: | | __test__/api.bitmart.spec.ts | Bitmart 交易所相关测试用例 | | __test__/blockchain.evm.spec.ts | EVM 链相关测试用例 | | __test__/blockchain.solana.spec.ts | Solana 链相关测试用例 | | __test__/blockchain.client.spec.ts | 统一区块链客户端测试用例 | | __test__/websocketTest.spec.ts | 消息推送相关测试用例（待实现） |

运行特定测试

1. 运行名称包含 "根据币种名称获取币种信息" 的测试

pnpm test -- -t "根据币种名称获取币种信息"

2. 运行 TestAccount 测试套件下的所有测试

pnpm test -- -t "TestAccount"

3. 运行特定测试文件

pnpm test -- api.bitmart.spec.ts
pnpm test -- api.bitget.spec.ts
pnpm test -- blockchain.evm.spec.ts

API示例

import 'dotenv/config';
import { SpotFactory, IBitmartConfig } from '../src';

const config: IBitmartConfig = {
  apiKey: process.env.BITMART_API_KEY || '',
  apiSecret: process.env.BITMART_SECRET_KEY || '',
  memo: process.env.BITMART_MEMO || '',
};

const bitmartSpot = SpotFactory.getInstance('bitmart', config);
const coins = await bitmartSpot.account.coins('floki');
console.log('获取币种信息:', coins);

websocket示例

待实现

RSA

如果你的apikey是RSA类型则主动设置签名类型为RSA

// config.ts
const config: IBitmartConfig = {
    apiKey: '',
    apiSecret: '',
    memo: '',
    signType: BIZ_CONSTANT.RSA // 如果你的apikey是RSA类型则主动设置签名类型为RSA
}

项目结构

ex-apis-node-sdk/
├── __test__/           # 测试用例
├── src/                # 源代码
│   ├── core/           # 核心客户端
│   ├── exchanges/      # 交易所实现
│   │   └── bitmart/    # Bitmart 交易所实现
│   ├── factory/        # 工厂模式实现
│   └── types/          # 类型定义
├── tsconfig.json       # TypeScript 配置
├── package.json        # 项目配置
└── README.md           # 项目文档

打包

1. go 项目打包(Windows)

D:\MyProject\vue3\gin-vue-server3\server
set GOOS=windows
set GOARCH=amd64
go build -o gin-vue-server.exe

2. go 项目打包(Linux)

D:\MyProject\vue3\gin-vue-server3\server
set GOOS=linux
set GOARCH=amd64
go build -o gin-vue-server