章鱼

用于提交和匹配订单的CLI和引擎 🐙

使用Rust构建，使用Warp API，并在Railway上托管。

安装

Cargo

使用此指南安装rust工具链以安装cargo。然后使用以下命令安装cli crate：

cargo install octopus-cli

您也可以通过克隆此存储库并使用Cargo构建它来安装crate。在终端中运行以下命令：

构建

git clone https://github.com/richo225/octopus.git
cd octopus
cargo build --target octopus_cli --release

构建成功后，二进制文件将可在target/release目录中找到。

使用方法

要在终端中运行crate，请使用以下命令：

octopus-cli

如果您想在本地运行octopus服务器，请使用以下命令执行二进制文件，然后运行CLI，指向本地服务器：

RUST_LOG=trace cargo run --bin octopus-web

然后运行CLI，指向本地服务器

cargo run --bin octopus-cli -- https://127.0.0.1:8080

有关引擎的完整文档可在https://docs.rs/octopus-engine/0.1.0/octopus_engine/找到。

命令

deposit

允许用户创建账户或将资金存入现有账户。

withdraw

从用户的账户中提取资金。

send

将资金发送到其他用户的账户。

submit_order

submit_order命令允许用户提交订单供引擎处理。将返回收据以及任何匹配项。

orderbook

检索当前订单簿。

account

检索用户的账户余额。

txlog

txlog命令检索平台上的整个交易日志。

测试

要在终端中运行crate的测试，请使用以下命令：

cargo test

这将执行CLI和引擎的测试用例，并提供测试结果。

贡献

欢迎贡献！如果您发现了一个错误，有功能请求或想贡献代码，请遵循贡献文件中的指南。

许可证

此软件包采用MIT许可证。