安全网关类型SDK
类型脚本 SDK 安全客户端网关
📖 API 参考
使用政策
NB:安全客户端网关并非面向公众使用. 请 别 使用这个SDK 如果你正在建造,例如一个安全应用程序.
使用 SDK
安装 :
yarn add @gnosis.pm/safe-react-gateway-sdk
导入 :
import { getChainsConfig, type ChainListResponse } from '@gnosis.pm/safe-react-gateway-sdk'
使用 :
const chains = await getChainsConfig()
SDK 不需要初始化, 除非您想要覆盖基础 URL 。 您可以设置这样的替代基址 :
import { setBaseUrl } from '@gnosis.pm/safe-react-gateway-sdk'
// Switch the SDK to dev mode
setBaseUrl('https://safe-client.staging.5afe.dev')
完整的 SDK 引用可以找到 这里。 。 。 .
添加终点
终点类型定义于 src/types/gateway.ts。 。 。 .
每个终点包括:
- 定义于
src/index.ts(例如:.getBalances(中文(简体) ) - 路径定义(例如:.
'/chains/{chainId}/safes/{address}/balances/{currency}/'(中文(简体) ) - 操作定义(例如).
safes_balances_list(中文(简体) ) - 反应定义
要添加一个新的端点,要遵循现有端点设定的模式.
爱斯林特( B)
此命令将在每次执行之前运行 :
yarn eslint:fix
测试
在当地运行单元和e2e测试:
yarn test
注释:e2e测试使实际API在中转中调用.
网关 API 文件
此 SDK 中的类型脚本类型基于 粗体类型 从网关API.