@reclaimprotocol/attestor-core 5.1.3 → 5.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (26) hide show
  1. package/LICENSE +660 -660
  2. package/README.md +48 -22
  3. package/browser/resources/attestor-browser.min.mjs +28 -28
  4. package/lib/external-rpc/index.js +1 -1
  5. package/lib/index.js +1 -1
  6. package/lib/proto/tee-bundle.d.ts +45 -0
  7. package/lib/providers/http/response-charset.d.ts +1 -0
  8. package/lib/server/tee/acme-http-server.d.ts +13 -0
  9. package/lib/server/tee/attestation-generate.d.ts +29 -0
  10. package/lib/server/tee/bootstrap.d.ts +11 -0
  11. package/lib/server/tee/cert-manager.d.ts +24 -0
  12. package/lib/server/tee/cloud-logging.d.ts +23 -0
  13. package/lib/server/tee/secret-loader.d.ts +10 -0
  14. package/lib/server/tee/secret-manager.d.ts +3 -0
  15. package/lib/server/utils/sev-snp/gcp.d.ts +2 -0
  16. package/lib/server/utils/sev-snp/nitrotpm.d.ts +1 -0
  17. package/lib/server/utils/sev-snp/secure-boot.d.ts +9 -0
  18. package/lib/server/utils/sev-snp/secure-boot.test.d.ts +1 -0
  19. package/lib/server/utils/sev-snp/verify.d.ts +19 -0
  20. package/lib/server/utils/tee-cbc-contract.d.ts +3 -0
  21. package/lib/server/utils/tee-oprf-mpc-verification.d.ts +1 -0
  22. package/lib/server/utils/tee-transcript-reconstruction.d.ts +12 -0
  23. package/lib/server/utils/tee-verification.d.ts +3 -0
  24. package/lib/types/providers.d.ts +2 -0
  25. package/lib/utils/gcp-attestation.d.ts +23 -0
  26. package/package.json +3 -3
package/README.md CHANGED
@@ -14,6 +14,7 @@
14
14
  Reclaim enables you to bring user activity, reputation, and identity from external websites into your own platform.
15
15
 
16
16
  For example,
17
+
17
18
  - Import the number of rides the user has taken on Uber to build a competing ride sharing platform
18
19
  - Import the users purchasing preferences using Amazon to provide discounts to the right users
19
20
  - Enable economics on a blockchain using users offchain activity data
@@ -25,18 +26,24 @@ And many more...
25
26
 
26
27
  The `attestor-core` package is the core implementation of the Reclaim protocol.
27
28
 
28
- TLDR: An "attestor" is a server that sits between the reclaim user & the internet. The client sends data to the internet via the attestor. All this data is exchanged securely via the TLS protocol.
29
+ TLDR: An "attestor" is a server that sits between the reclaim user & the internet. The client sends data to the internet
30
+ via the attestor. All this data is exchanged securely via the TLS protocol.
29
31
 
30
- We leverage some special properties of the TLS protocol along with zero-knowledge proofs to reveal only the necessary information to the attestor.
31
- The attestor then signs this data & sends it back to the client. The client can then use this signed data to prove the claim to anyone.
32
+ We leverage some special properties of the TLS protocol along with zero-knowledge proofs to reveal only the necessary
33
+ information to the attestor. The attestor then signs this data & sends it back to the client. The client can then use
34
+ this signed data to prove the claim to anyone.
32
35
 
33
36
  This package contains both the client & server side code for the Reclaim protocol.
34
37
 
35
38
  Read a longer brief [here](/docs/problem-statement.md).
36
39
 
37
- This repository contains **Typescript** implementation of the attestor server & the SDK to interact with it. The SDK is compatible with the browser & NodeJS. However, to run the SDK on React Native/Mobile, refer to our [React Native guide](/docs/browser-rpc.md).
40
+ This repository contains **Typescript** implementation of the attestor server & the SDK to interact with it. The SDK is
41
+ compatible with the browser & NodeJS. However, to run the SDK on React Native/Mobile, refer to
42
+ our [React Native guide](/docs/browser-rpc.md).
38
43
 
39
- Note: if you're looking to build apps on Reclaim, we'd recommend you to use the [Reclaim SDK](https://docs.reclaimprotocol.org/) instead. This repository is intended for developers looking to contribute to the core protocol
44
+ Note: if you're looking to build apps on Reclaim, we'd recommend you to use
45
+ the [Reclaim SDK](https://docs.reclaimprotocol.org/) instead. This repository is intended for developers looking to
46
+ contribute to the core protocol
40
47
 
41
48
  ## Install
42
49
 
@@ -46,49 +53,68 @@ From GitHub:
46
53
  From NPM:
47
54
  `npm install @reclaimprotocol/attestor-core`
48
55
 
49
- **Note:** if you plan on running the package on NodeJS or any non-browser environment, download the ZK files required to generate & verify ZK proofs:
56
+ **Note:** if you plan on running the package on NodeJS or any non-browser environment, download the ZK files required to
57
+ generate & verify ZK proofs:
58
+
50
59
  ```bash
51
60
  npm run download:zk-files
52
61
  ```
53
62
 
54
- **Note:** this approach is only advised for NodeJS projects or projects meant to run directly in a modern browser. For React Native or any solution running in a mobile app, refer to our doc [here](/docs/browser-rpc.md).
63
+ **Note:** this approach is only advised for NodeJS projects or projects meant to run directly in a modern browser. For
64
+ React Native or any solution running in a mobile app, refer to our doc [here](/docs/browser-rpc.md).
55
65
 
56
- Note for devs: the "prepare" script which is run after `npm install` is configured to only build when there are files in the `src` directory. This is to prevent errors when building the Docker image.
66
+ Note for devs: the "prepare" script which is run after `npm install` is configured to only build when there are files in
67
+ the `src` directory. This is to prevent errors when building the Docker image.
57
68
 
58
69
  ## Getting Started
59
70
 
60
71
  We'd recommend you go through our documentation in the following order:
61
- 1. [Problem Statement](/docs/problem-statement.md): Understand the problem we're solving & whether this is the right solution for you.
62
- 2. [Getting Started](/docs/getting-started.md): Understand how to get started with the attestor SDK & create your first claim.
63
- 3. [Browser RPC/React Native](/docs/browser-rpc.md): How to setup the attestor client SDK for environments like React Native or any other mobile app.
64
- 4. [Provider](/docs/provider.md): What is a provider in the Reclaim context, how to create one & details on the HTTP provider.
65
- 5. [Internals of Claim Creation](/docs/claim-creation.md): In-depth description of the full flow of creating a claim with a attestor.
66
- 6. [Working with the Codebase](/docs/project.md): Understand how to work with the codebase & how to deploy an attestor server.
67
- 7. [Run your own Attestor Server](/docs/run-server.md): Understand how to run your own attestor server locally or deploy it to the cloud.
72
+
73
+ 1. [Problem Statement](/docs/problem-statement.md): Understand the problem we're solving & whether this is the right
74
+ solution for you.
75
+ 2. [Getting Started](/docs/getting-started.md): Understand how to get started with the attestor SDK & create your first
76
+ claim.
77
+ 3. [Browser RPC/React Native](/docs/browser-rpc.md): How to setup the attestor client SDK for environments like React
78
+ Native or any other mobile app.
79
+ 4. [Provider](/docs/provider.md): What is a provider in the Reclaim context, how to create one & details on the HTTP
80
+ provider.
81
+ 5. [Internals of Claim Creation](/docs/claim-creation.md): In-depth description of the full flow of creating a claim
82
+ with a attestor.
83
+ 6. [Working with the Codebase](/docs/project.md): Understand how to work with the codebase & how to deploy an attestor
84
+ server.
85
+ 7. [Run your own Attestor Server](/docs/run-server.md): Understand how to run your own attestor server locally or deploy
86
+ it to the cloud.
68
87
  8. [AVS](/docs/avs.md): Understand how we use an Eigen AVS to decentralize the attestor server.
69
88
 
70
89
  ## Contributing to Our Project
71
90
 
72
- We're excited that you're interested in contributing to our project! Before you get started, please take a moment to review the following guidelines.
91
+ We're excited that you're interested in contributing to our project! Before you get started, please take a moment to
92
+ review the following guidelines.
73
93
 
74
94
  ## Code of Conduct
75
95
 
76
- Please read and follow our [Code of Conduct](https://github.com/reclaimprotocol/.github/blob/main/Code-of-Conduct.md) to ensure a positive and inclusive environment for all contributors.
96
+ Please read and follow our [Code of Conduct](https://github.com/reclaimprotocol/.github/blob/main/Code-of-Conduct.md) to
97
+ ensure a positive and inclusive environment for all contributors.
77
98
 
78
99
  ## Security
79
100
 
80
- If you discover any security-related issues, please refer to our [Security Policy](https://github.com/reclaimprotocol/.github/blob/main/SECURITY.md) for information on how to responsibly disclose vulnerabilities.
101
+ If you discover any security-related issues, please refer to
102
+ our [Security Policy](https://github.com/reclaimprotocol/.github/blob/main/SECURITY.md) for information on how to
103
+ responsibly disclose vulnerabilities.
81
104
 
82
105
  ## Contributor License Agreement
83
106
 
84
- Before contributing to this project, please read and sign our [Contributor License Agreement (CLA)](https://github.com/reclaimprotocol/.github/blob/main/CLA.md).
107
+ Before contributing to this project, please read and sign
108
+ our [Contributor License Agreement (CLA)](https://github.com/reclaimprotocol/.github/blob/main/CLA.md).
85
109
 
86
110
  ## Indie Hackers
87
111
 
88
- For Indie Hackers: [Check out our guidelines and potential grant opportunities](https://github.com/reclaimprotocol/.github/blob/main/Indie-Hackers.md)
112
+ For Indie
113
+ Hackers: [Check out our guidelines and potential grant opportunities](https://github.com/reclaimprotocol/.github/blob/main/Indie-Hackers.md)
89
114
 
90
115
  ## License
91
116
 
92
- This project is licensed under a [AGPL v3](./LICENSE). By contributing to this project, you agree that your contributions will be licensed under its terms.
117
+ This project is licensed under a [AGPL v3](./LICENSE). By contributing to this project, you agree that your
118
+ contributions will be licensed under its terms.
93
119
 
94
- Thank you for your contributions!
120
+ Thank you for your contributions!