swtc-proxy API
服务 - 代理至井通节点
在线文档
描述
@swtc/lib
使用websocket
,兼容性和规模化有一定的问题
swtc-proxy
提供REST
服务,代理到井通节点解决上述问题
约定
- 安全第一, 确保密钥不出本机
- 尽量保持数据结构 和
@swtc/lib
对应一致 - 所有 API 应答均为 json object, 包括数据和错误
- 尽量支持可选参数, 几乎所有
@swtc/lib
支持的参数都可以通过 query 获得支持 - 集成至
@swtc/transaction
和 @swtc/api
- 精简为主, 面向所有用户。 提供缺省配置和 docker image
- swagger-ui 标准文档
使用
kubernetes (通过环境变量设置上游/调试/基于 IP 的访问限制)
kubectl create -f https://raw.githubusercontent.com/swtcca/swtcproxy/master/kubernetes.yaml
docker (通过环境变量设置上游/调试/基于 IP 的访问限制)
docker run --rm -e UPSTREAM=wss://s.jingtum.com:5020 -e DEBUG=true -e RATE=100 -d -p 5080:5080 lospringliu/swtcproxy
源代码
git clone https://github.com/swtcca/swtcproxy.git
cd swtcproxy
npm install
npm run test
env UPSTREAM=wss://s.jingtum.com:5020 RATE=100 npm run start
- 本地文档: http://localhost:5080/swagger
- 相应修改
static/swagger.json
的server.url
定制
源代码
git clone https://github.com/swtcca/swtclib.git
cd swtclib/packages/swtc-proxy
npm install
npm run test
npm run start
- 本地文档: http://localhost:5080/swagger
- 相应修改
static/swagger.json
的server.url
修改 start.js
修改源文件 tssrc/