3个不稳定版本

0.2.1	2024年2月22日
0.1.2	2023年10月21日
0.1.1	2023年10月21日

#2050 in 魔法豆

每月35次下载
用于 moksha-cli

MIT 许可证

145KB
3.5K SLoC

⚠️ 不要鲁莽： 此项目处于早期开发阶段，但它确实可以与真实的sat工作！始终使用您不介意失去的金额。

moksha

moksha是一个用Rust编写的cashu库，包含铸造和cli钱包。

内容

关于
进度
Crates
用法
许可证

关于

Cashu是基于David Wagner的Chaumian blinding变体的Ecash实现。代币逻辑基于minicash (描述)，该实现了一个盲迪菲-赫尔曼密钥交换方案，由Ruben Somsen在此记录。请阅读Cashu文档以获取更详细的信息。

进度

铸造功能

支持的后端
- LNbits
- Lnd
- Alby
- Strike
- core-lightning (WIP)

钱包功能

连接到铸造（加载密钥）
请求铸造代币
铸造代币
发送代币（为所选值获取编码的代币）
接收代币
融化代币
检查代币是否已花费
多铸造支持

实现了NUTs

NUT-00
NUT-01
NUT-02
NUT-03
NUT-04
NUT-05
NUT-06
NUT-07
NUT-08
NUT-09
NUT-10
NUT-11
NUT-12
NUT-13
NUT-14
NUT-15
NUT-16
NUT-17 链上铸造（非官方NUT）
NUT-18 链上熔化（非官方NUT）

Crates

moksha-core Cashu库的核心。包含创建和验证代币的所有逻辑。
moksha-wallet Cashu钱包库
moksha-cli Cashu命令行钱包
moksha-mint Cashu铸造服务器。处理铸造、熔化和代币请求。
integrationtests 启动一个铸造实例并对其进行集成测试。

用法

部署铸造

Docker-compose

Docker-compose简化了运行多容器Docker应用程序的过程。以下是您如何使用它来运行moksha -mint的方法：

首先，您需要在您的机器上安装Docker Compose。如果没有安装，您可以从中下载它：官方Docker网站。
将您的LND实例中的tls.cert和admin.macaroon文件复制到./data/mutinynet/目录。
在docker-compose.yml文件中配置环境变量LND_GRPC_HOST，使其指向您的LND实例。
在您的docker-compose.yml文件相同的目录中运行以下命令以启动铸造和PostgreSQL数据库：

docker-compose up -d app database

开发

设置rust

git clone https://github.com/ngutech21/moksha.git
cargo install just typos-cli sqlx-cli grcov wasm-pack wasm-opt
rustup component add llvm-tools-preview
cd moksha

为您的平台安装protobuf

这对于LND后端是必需的。

sudo apt install protobuf-compiler
brew install protobuf
choco install protoc

配置

mv .env.example .env
# edit .env file
vim .env

运行铸造（cashu-server）

要运行铸造，您需要设置一个闪电regtest环境，例如Polar，以及一个Lnbits或Lnd实例。在Lnbits中创建一个新的钱包，将管理员密钥复制到.env文件中，并将url设置为您的Lnbits实例。铸造使用PostgreSQL存储已使用证明和挂起发票。数据库URL可以在.env文件中配置。

install docker and docker-compose
docker compose up -d
just db-create
just run-mint

运行cli-wallet

显示信息

显示当前版本、数据库目录和铸造URL。

just run-cli info

检查余额

just run-cli balance

铸造代币

此命令将返回一个闪电发票，您需要支付以铸造新的ecash代币。

just run-cli mint 42

发送代币

要将代币发送给其他用户，请输入。代币将打印到STOUT。然后您可以通过任何消息应用将它们发送给收件人。

just run-cli send 21

接收代币

要接收代币，您需要将代币作为接收命令的第一个参数输入。代币将被验证，并将价值添加到您的余额中。

just run-cli receive cashuAeyJ0...

开发

要运行覆盖率、检查错误等，请使用just命令

Available recipes:
    build-docker   # build the mint docker-image
    build-wasm     # compile all rust crates, that are relevant for the client, to wasm
    clean          # clean cargo
    db-create      # creates the postgres database
    db-migrate     # runs sqlx prepare
    db-prepare     # runs sqlx prepare
    default        # list all tasks
    deps           # install all dependencies
    final-check    # format code, check typos and run tests
    publish        # publish everything on crates.io
    run-cli *ARGS  # run cli-wallet with the given args
    run-coverage   # run coverage
    run-itests     # run integrationtests
    run-mint *ARGS # run the cashu-mint
    run-tests      # runs all tests
    typos          # check code for typos
    typos-fix-all  # fix all typos

许可证

moksha根据MIT许可协议分发。请参阅LICENSE。

依赖项

~20–43MB
~644K SLoC