@gnosis.pm/dex-js

中文文档
0.14.0发布于 2021/12/15MITTypeScriptESM + CJS近 30 天下载 6890

Gnosis Protocol JS integration: utils, contracts and other goodies

原始使用文档
文档目录3 节
  1. Usage
  2. Build
  3. Run test

npm version   Build Status   Coverage Status

Develop:   Build Status   Coverage Status

Gnosis Protocol JS

Gnosis Protocol JS it's library, with typescript support for Gnosis Protocol.

Gnosis Protocol introduces a new, fully decentralized exchange mechanism for ERC20 tokens with the following properties:

  • Batch auctions
  • Multidimensional order books with ring trades
  • Uniform clearing prices in every batch

This library provides:

  • Typescrypt version of the contracts of Gnosis Protocol
  • Some handy utils and constants

Usage

# Using yarn
yarn add @gnosis.pm/dex-js --save

#Alternatively
npm install @gnosis.pm/dex-js --save

Import the contract:

import { BatchExchangeContract } from ' @gnosis.pm/dex-js'

// Instanciate the smart contract
const web3 = new Web3()
const batchExchangeContract = new BatchExchangeContract({ web3 })

// Alternativelly provide the address
const batchExchangeContract = new BatchExchangeContract({ web3, address: '0x89593E017D4A88c60347257DAfB95384a422da09' })

Issues

If you find any issue, or you want to request a feature use https://github.com/gnosis/dex-js/issues

Pull requests are welcomed and are the best way to suggest new features.

Collaborate

Build

# Install dependencies
yarn install

# Build
yarn build

# Build and watch (useful when using "npm link")
yarn build:watch

Run test

# Install dependencies
yarn install

# Run
yarn test

版本与发布记录

@gnosis.pm/dex-js 共发布 89 个版本,首次发布于 2019/11/28;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.14.0latest2021/12/154 年前
0.13.02021/12/044 年前
0.12.02021/08/265 年前
0.11.02021/07/085 年前
0.10.02021/05/045 年前
0.10.0-RC.02021/04/305 年前

关于 @gnosis.pm/dex-js 的常见问题

@gnosis.pm/dex-js 是什么?

Gnosis Protocol JS integration: utils, contracts and other goodies

如何安装 @gnosis.pm/dex-js?

在项目目录运行 npm install @gnosis.pm/dex-js,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:web3(^1.2.4)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@gnosis.pm/dex-js 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gnosis.pm/dex-js 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@gnosis.pm/dex-js 可以商用吗?

@gnosis.pm/dex-js 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@gnosis.pm/dex-js 的下载量有多少?

根据 npm 官方下载统计,@gnosis.pm/dex-js 在 2026/10/17 – 2026/11/15 这 30 天内被下载 6,890 次,日均约 230 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gnosis.pm/dex-js 还在维护吗?

最新版本 0.14.0 发布于 2021/12/15(4 年前);至今共发布 89 个版本,其中过去 12 个月发布了 0 个;首次发布于 2019/11/28。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。