#citadel #dusk #integrated #system #user #setup #moat

zk-citadel-moat

用于Dusk Network中集成的基于ZK的SSI系统的Citadel SDK

2个版本

0.1.1 2023年12月1日
0.1.0 2023年12月1日

#7 in #dusk

MPL-2.0 许可证

90KB
2K SLoC

护城河:Citadel SDK

CI Repository

护城河(也称为Citadel SDK)包含了使用集成到Dusk区块链中的Citadel协议使用和实现自主权身份系统所需的所有工具。

先决条件

护城河需要一个可访问的Rust节点安装并运行,或者选择一个可信的节点。您可以按照这里的解释设置一个节点。它还需要一个连接到给定Rust节点的已安装钱包,如这里所述。

测试环境

您可以通过在integration-tests/config.toml中指定测试Rust节点地址,并执行以下操作来测试您设置的环境和库是否正常工作(请注意,钱包需要使用password作为测试的密码才能成功)

cargo t --release --features="exp_tests" -- --test-threads=1
cargo t --release --features="int_tests" -- --test-threads=1

护城河CLI

moat-cli实用程序可以从Citadel协议中任何一方的角度使用,无论他们是

  • 用户:一个请求链上LP许可并能够链上使用这些许可的方。
  • 许可提供者(LP):一个接收用户链上请求以向他们颁发许可的方。
  • 服务提供者(SP):一个接收用户链下请求以提供服务的方。

要使用CLI,您应该在moat-cli/config.toml中指定Rust节点地址。然后,您可以为涉及的任何一方执行CLI,如下所示。

用户

用户可以请求许可并使用它们。要运行用户CLI,只需运行

cargo r --release --bin moat-cli-user -- --wallet-pass <PASSWORD>

许可提供者

LP可以扫描区块链以查找请求,如果请求有效,则颁发许可。要运行LP CLI,只需运行

cargo r --release --bin moat-cli-lp -- --wallet-pass <PASSWORD>

服务提供者

SP可以接收用户请求以授予他们的服务,并通过对用户提供的会话cookie进行检查来接受或拒绝请求。要运行SP CLI,只需运行

cargo r --release --bin moat-cli-sp -- --wallet-pass <PASSWORD>

护城河API

为希望将Citadel集成到其代码中的开发者提供的API可在此处获得 这里。您可以在 moat-example 中找到如何使用该API的示例。

依赖项

~70MB
~1M SLoC