tiny-secp256k1

此库正在开发中，并且，就像它依赖的 C 库 secp256k1（通过 secp256k1-sys Rust 包）一样，这是一个针对 bitcoinjs 生态系统最终用户确定最佳 API 的研究努力。

安装

npm

npm install tiny-secp256k1

yarn

yarn add tiny-secp256k1

WebAssembly 和 Node.js 版本

先前版本的 tiny-secp256k1 通过 C++ 扩展 实现，通过 NAN（Node.js 的原生抽象） 和 elliptic 作为后备方案，当扩展不能构建或在类似浏览器的环境中。

当前版本使用编译为 WebAssembly 的 Rust 包（它使用 C 库）。使用 Wasm，相同的代码可以在任何环境中执行。Wasm 比 elliptic 快，但比节点绑定慢（PR 中的结果 或您可以在 benches 目录中运行自己的基准测试）。

构建

要本地构建，您需要 C/C++ 工具链，Rust 版本 >=1.50.0 以及从 binaryen 的 wasm-opt。

rustup 是安装 Rust 的推荐方法。您还需要 wasm32-unknown-unknown 目标。

rustup toolchain install stable --target wasm32-unknown-unknown --component clippy --component rustfmt

使用 npm 安装开发依赖项后，您可以构建 Wasm

make build-wasm

或运行测试

make test

另一种方法是使用 Docker

% docker build -t tiny-secp256k1 .
% docker run -it --rm -v `pwd`:/tiny-secp256k1 -w /tiny-secp256k1 tiny-secp256k1
# make build

示例

tiny-secp256k1 包含两个示例。第一个是 Node.js 的简单脚本，它生成随机数据并打印参数和方法结果。第二个是 React 应用。

React 应用在每个提交到 master 分支时在 GitHub Actions 上构建，并上传到 gh-pages 分支，该分支始终可在网络上访问：https://bitcoinjs.github.io/tiny-secp256k1/

文档

isPoint (A)

isPoint :: Buffer -> Bool

如果

• A未使用序列标签 0x02、0x03 或 0x04进行编码，则返回 false
• A.x不在 [1...p - 1]
• A.y不在 [1...p - 1]

isPointCompressed (A)

isPointCompressed :: Buffer -> Bool

如果公钥未压缩，则返回 false

isXOnlyPoint (A)

isXOnlyPoint :: Buffer -> Bool

如果公钥不是xOnlyPubkey，则返回 false

isPrivate (d)

isPrivate :: Buffer -> Bool

如果

• d不是256位，或者
• d不在 [1..order - 1]

pointAdd (A, B[, compressed])

pointAdd :: Buffer -> Buffer [-> Bool] -> Maybe Buffer

如果结果是无穷大，则返回 null

抛出异常

• 如果 !isPoint(A)，则返回 Expected Point
• 如果 !isPoint(B)，则返回 Expected Point

pointAddScalar (A, tweak[, compressed])

pointAddScalar :: Buffer -> Buffer [-> Bool] -> Maybe Buffer

如果结果是无穷大，则返回 null

抛出异常

• 如果 !isPoint(A)，则返回 Expected Point
• 如果 tweak不在 [0...order - 1]，则返回 Expected Tweak

pointCompress (A, compressed)

pointCompress :: Buffer -> Bool -> Buffer

抛出异常

• 如果 !isPoint(A)，则返回 Expected Point

pointFromScalar (d[, compressed])

pointFromScalar :: Buffer [-> Bool] -> Maybe Buffer

如果结果是无穷大，则返回 null

抛出异常

• 如果 !isPrivate(d)，则返回 Expected Private

xOnlyPointFromScalar (d)

xOnlyPointFromScalar :: Buffer -> Buffer

为给定的私钥返回xOnlyPubkey

抛出异常

• 如果 !isPrivate(d)，则返回 Expected Private

xOnlyPointFromPoint (p)

xOnlyPointFromPoint :: Buffer -> Buffer

为给定的DER公钥返回xOnlyPubkey

抛出异常

• 如果 !isPoint(p)，则返回 Expected Point

pointMultiply (A, tweak[, compressed])

pointMultiply :: Buffer -> Buffer [-> Bool] -> Maybe Buffer

如果结果是无穷大，则返回 null

抛出异常

• 如果 !isPoint(A)，则返回 Expected Point
• 如果 tweak不在 [0...order - 1]，则返回 Expected Tweak

privateAdd (d, tweak)

privateAdd :: Buffer -> Buffer -> Maybe Buffer

如果结果是等于 0，则返回 null

抛出异常

• 如果 !isPrivate(d)，则返回 Expected Private
• 如果 tweak不在 [0...order - 1]，则返回 Expected Tweak

privateSub (d, tweak)

privateSub :: Buffer -> Buffer -> Maybe Buffer

如果结果是等于 0，则返回 null

抛出异常

• 如果 !isPrivate(d)，则返回 Expected Private
• 如果 tweak不在 [0...order - 1]，则返回 Expected Tweak

xOnlyPointAddTweak (p, tweak)

xOnlyPointAddTweak :: Buffer -> Buffer -> { parity: 1 | 0; xOnlyPubkey: Buffer; }

返回调整后的xOnlyPubkey和奇偶校验位（1|0的数字类型）

抛出异常

• 如果 !isXOnlyPoint(p)，则返回 Expected Point
• 如果 !isXOnlyPoint(tweak)，则返回 Expected Tweak

xOnlyPointAddTweakCheck :: Buffer -> Buffer -> Buffer [-> 1 | 0] -> Bool

sign :: Buffer -> Buffer [-> Buffer] -> Buffer

signSchnorr :: Buffer -> Buffer [-> Buffer] -> Buffer

verify :: Buffer -> Buffer -> Buffer [-> Bool] -> Bool

verifySchnorr :: Buffer -> Buffer -> Buffer -> Bool