Skip to content

Commit b9953af

Browse files
HaoXuan40404HaoXuan40404
committed
init wedpr lab core
0 parents  commit b9953af

35 files changed

+3115
-0
lines changed

‎.github/workflows/vcl.yml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Rust
2+
3+
on: [push]
4+
5+
jobs:
6+
build:
7+
8+
runs-on: ubuntu-latest
9+
10+
steps:
11+
- uses: actions/checkout@v1
12+
- name: Nightly default
13+
run: rustup default nightly
14+
- name: Build
15+
run: cargo build --verbose
16+
- name: Run tests
17+
run: cargo test --verbose

‎.gitignore

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
/target
2+
/**/target
3+
**/*.rs.bk
4+
.DS_Store
5+
.vscode/
6+
.idea/*
7+
*.lock
8+
*.iml
9+
*.tar.gz

‎.rustfmt.toml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
blank_lines_upper_bound = 1
2+
format_code_in_doc_comments = true
3+
format_macro_matchers = true
4+
format_strings = true
5+
indent_style = "Block"
6+
match_block_trailing_comma = true
7+
max_width = 80
8+
merge_imports = true
9+
normalize_comments = true
10+
normalize_doc_attributes = true
11+
overflow_delimited_expr = true
12+
reorder_imports = true
13+
reorder_modules = true
14+
tab_spaces = 4
15+
use_try_shorthand = true
16+
where_single_line = true
17+
wrap_comments = true

‎CONTRIBUTING.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# 贡献代码
2+
3+
非常感谢能有心为WeDPR-Lab贡献代码！
4+
5+
## 分支策略
6+
7+
项目采用[git-flow](https://jeffkreeftmeijer.com/git-flow/)的分支策略。
8+
9+
* master：最新的稳定分支
10+
* dev：待发布的稳定分支
11+
* feature-xxxx：一个正在开发xxxx特性分支
12+
* bugfix-xxxx：一个正在修bug xxxx的分支
13+
14+
## 贡献方法
15+
16+
### Issue
17+
18+
可直接去[issues page](https://github.com/WeBankBlockchain/WeDPR-Lab-Core/issues)提issue。
19+
20+
### 修复bug
21+
22+
1. Fork本仓库到个人仓库
23+
2. 从个人仓库的master分支拉出一个bugfix-xxxx分支
24+
3. 在bugfix-xxxx上修复bug
25+
4. 测试修复的bug
26+
5. PR（Pull Request）到本仓库的dev分支
27+
6. 等待社区review这个PR
28+
7. PR合入，bug修复完成！
29+
30+
### 开发新特性
31+
32+
1. Fork本仓库到个人仓库
33+
2. 从个人仓库的dev分支拉出一个feature-xxxx分支
34+
3. 在feature-xxxx上进行特性开发
35+
4. 不定期的从本仓库的dev分支pull最新的改动到feature-xxxx分支
36+
5. 测试新特性
37+
6. PR（Pull Request）到本参考的dev分支
38+
7. 等待社区review这个PR
39+
8. PR合入，特性开发完成！

‎Cargo.toml

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[workspace]
2+
3+
members = [
4+
"crypto",
5+
"solution/verifiable_confidential_ledger",
6+
"common/utils",
7+
"common/macros",
8+
"common/protos",
9+
]

‎LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md

+87
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# 项目背景
2+
3+
![WeDPR](https://wedpr-lab.readthedocs.io/zh_CN/latest/_static/images/wedpr_logo.png)
4+
5+
WeDPR是一系列**即时可用场景式**隐私保护高效解决方案套件和服务（参见[WeDPR白皮书](https://mp.weixin.qq.com/s?__biz=MzU0MDY4MDMzOA==&mid=2247483910&idx=1&sn=7b647dec9f046f1e6f94d103897f7efb&scene=19#wechat_redirect)），由微众银行区块链团队自主研发。方案致力于解决业务数字化中隐私不“隐”、共享协作不可控等隐私保护风险痛点，消除隐私主体的隐私顾虑和业务创新的合规壁垒，助力基于隐私数据的核心价值互联和新兴商业探索，营造公平、对等、共赢的多方数据协作环境，达成数据价值跨主体融合和数据治理的可控平衡。
6+
7+
WeDPR具备以下特色和优势：
8+
9+
- **场景式解决方案**：已基于隐匿支付、匿名投票、匿名竞拍、匿名摇号和选择性认证披露等应用场景，提炼出公开可验证密文账本、多方密文决策、多方密文排名、多方密文计算、多方安全随机数生成、选择性密文披露等高效技术方案框架模板，5分钟一键构建示例应用。
10+
- **即时可用**：高性能、高易用、跨平台跨语言实现、不依赖中心化可信服务、不依赖可信硬件、支持国密算法标准、隐私效果公开可验证。
11+
- **透明可控**：隐私控制回归属主，杜绝数据未授权使用，在『数据可用而不可见』的基础上，进一步实现数据使用全程可监管、可追溯、可验证。
12+
13+
WeDPR全面拥抱开放，将陆续开源一系列核心算法组件，进一步提升系统安全性的透明度，提供更透明、更可信的隐私保护效果。WeDPR-Lab就是这一系列开源的**核心算法组件**的集合。
14+
15+
首组开源的核心算法组件将围绕**公开可验证密文账本**（Verifiable Confidential Ledger, VCL）解决方案进行，在数字化资产流通场景（如支付、清算）、涉及多方之间共享账本信息的场景（如供应链金融、跨境金融服务）等均可广泛应用。
16+
17+
本次开源（v1.0.0版本）包含的主要内容如下：
18+
19+
- 公开可验证密文账本的一个交互式样例，实现密文金额发行、密文金额四则运算关系验证、密文金额范围验证等功能；
20+
- Rust SDK，封装底层算法，提供易用、易扩展、跨语言的编程接口；
21+
- 三类零知识证明算法的高效稳定实现，包括密文加和关系证明、密文乘积关系证明、密文范围证明；
22+
- 其他基础工具代码。
23+
24+
我们期望能够通过代码开源的方式：
25+
26+
- 有效降低使用隐私保护算法组件的技术门槛；
27+
- 减少业务系统集成隐私保护特性的开发成本；
28+
- 助力全行业伙伴安全、合规地开展数据业务。
29+
30+
欢迎社区伙伴参与WeDPR-Lab的共建，一起为可信开放数字新生态的构建打造坚实、可靠的技术底座。
31+
32+
## 安装
33+
34+
### 安装Rust环境
35+
36+
1. 安装nightly版本的Rust开发环境，可参考[示例安装指引](https://wiki.jikexueyuan.com/project/rust/nightly-rust.html)。
37+
2. 若有疑问，可进一步参考[Rust官方文档](https://www.rust-lang.org/tools/install)。
38+
39+
### 下载WeDPR-Lab源代码
40+
41+
使用git命令行工具，执行如下命令。
42+
43+
```bash
44+
git clone https://github.com/WeBankBlockchain/WeDPR-Lab-Core.git
45+
```
46+
47+
## 运行Demo
48+
49+
### 运行公开可验证密文账本Demo
50+
51+
```bash
52+
cd WeDPR-Lab-Core/solution/verifiable_confidential_ledger
53+
cargo run
54+
```
55+
56+
在VCL解决方案子目录（即`verifiable_confidential_ledger`目录）中，运行cargo run之后，按照demo指引，选择演示的语言，按步骤输入即可进行体验。
57+
58+
## 接口文档
59+
60+
### 生成并查看Rust SDK接口文档
61+
62+
在本项目的根目录（即`WeDPR-Lab-Core`目录）中，运行如下命令。
63+
64+
```bash
65+
cargo doc
66+
```
67+
68+
以上命令将根据代码中的注释，在`target/doc`子目录中，生成的SDK接口文档。
69+
70+
进入`target/doc`文档目录后，会看到所有SDK相关的包名（包含WeDPR-Lab和其他依赖包），进入以下任意一个包名的目录，用网页浏览器打开其中的`index.html`文件，便可查看WeDPR-Lab相关的接口说明。
71+
72+
- verifiable_confidential_ledger
73+
- wedpr_crypto
74+
- wedpr_macros
75+
- wedpr_protos
76+
- wedpr_utils
77+
78+
## 其他相关文档
79+
80+
- [WeDPR方案白皮书](https://mp.weixin.qq.com/s?__biz=MzU0MDY4MDMzOA==&mid=2247483910&idx=1&sn=7b647dec9f046f1e6f94d103897f7efb&scene=19#wechat_redirect)
81+
- [WeDPR-Lab用户文档](https://wedpr-lab.readthedocs.io/zh_CN/latest/index.html)
82+
83+
## 项目贡献
84+
85+
- 点亮我们的小星星(点击项目左上方Star按钮)
86+
- 提交代码(Pull Request)，参考我们的代码[贡献流程](./CONTRIBUTING.md)
87+
- [提问和提交BUG](https://github.com/WeBankBlockchain/WeDPR-Lab-Core/issues)

‎common/macros/Cargo.toml

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[package]
2+
name = "wedpr_macros"
3+
version = "1.0.0"
4+
authors = ["WeDPR <wedpr@webank.com>"]
5+
edition = "2018"
6+
7+
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
8+
9+
[dependencies]

0 commit comments

Comments
 (0)