2个版本

0.1.2 2021年11月1日
0.1.0 2021年10月25日

#5 in #interchange

每月24次下载
用于 flow-sdk

MIT/Apache

36KB
993

Flow Rust SDK

CI Crates.io docs.rs MIT OR Apache-2.0

此项目的最低支持Rust版本(MSRV)为1.56.0。

要安装Rust,请访问rustup网站获取信息。

文档

要查看概念定义的示例以及API参考的链接,请参阅docs/README.md

要查看最新的API参考,请访问https://fee1-dead.github.io/flow.rs/flow_sdk/。它使用不稳定的功能,可以抓取仓库中的示例用法。

docs.rs还托管了最新发布版本的文档,但没有函数的示例代码段。

示例

如果您正在寻找交互式示例,您可以查看flow-examples/。该目录中的示例运行模拟器并向模拟器发送请求。

要运行flow-examples/中的示例,请确保您已安装Flow CLI,并在项目根目录中运行cargo run -p flow-examples。我可能在将来提供flow-examples的预构建二进制文件。

使用FLOW_CLI_EXTRA_ARGS来控制传递给启动模拟器的额外参数。例如:如果8080端口已被占用,则使用FLOW_CLI_EXTRA_ARGS="--http-port 8081"

如果您正在寻找仅从网络上获取一些信息而没有任何输入的示例,请查看examples/目录。

要运行examples/中的示例,请运行cargo run --example file_name_without_rs

测试

SDK 中包含在 src/tests 中的测试,Cadence JSON 测试位于 cadence_json/src/tests

文档中的示例也经过测试。

加密和散列算法

目前库支持使用 secp256k1 进行签名和 SHA3 散列。未来可能添加对其他算法的支持。

secp256k1 签名由 secp256k1 crate 提供,它是对 libsecp256k1 的 FFI 包装,这是一个由 Pieter Wuille 开发的 C 库,被许多项目使用。

sha3 散列由 tiny-keccak crate 提供,它声称性能优于 RustCrypto 的另一个 crate。

依赖项

~1.4–2MB
~45K SLoC