1 个不稳定版本

0.2.1	2024年2月22日

#1683 in 魔法豆

MIT 许可证

165KB
3.5K SLoC

⚠️ 不要鲁莽： 此项目处于早期开发阶段，但它确实可以与真实 satoshi 一起工作！请务必使用您不介意丢失的金额。

moksha

moksha 是一个基于 Rust 编写的 cashu 库、铸造和命令行钱包。

内容

关于
进度
组件
用法
许可证

关于

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）

组件

moksha-core 现金库的核心。包含创建和验证令牌的所有逻辑。
moksha-wallet 现金库库
moksha-cli 现金库命令行钱包
moksha-mint 现金库铸造服务器。处理铸造、熔化令牌请求。
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）

要运行铸造，您需要设置一个类似Polar的闪电regtest环境以及一个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。

依赖关系

~24–43MB
~678K SLoC