Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update doc: Reown and Primus Branding Integration #887

Closed
wants to merge 13 commits into from
65 changes: 0 additions & 65 deletions docs/get-started/tooling/attestations/pado.mdx

This file was deleted.

61 changes: 61 additions & 0 deletions docs/get-started/tooling/attestations/primus.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: Primus
image: /img/socialCards/primus.jpg
---

[Primus](https://www.primuslabs.xyz) is a cryptography-based attestation protocol to bring all Internet
data into smart contracts. Primus relies heavily on cryptography to minimize trust, and enables end

Check warning on line 7 in docs/get-started/tooling/attestations/primus.mdx

View workflow job for this annotation

GitHub Actions / Spelling

[vale] reported by reviewdog 🐶 [Microsoft.Adverbs] Remove 'heavily' if it's not important to the meaning of the statement. Raw Output: {"message": "[Microsoft.Adverbs] Remove 'heavily' if it's not important to the meaning of the statement.", "location": {"path": "docs/get-started/tooling/attestations/primus.mdx", "range": {"start": {"line": 7, "column": 42}}}, "severity": "WARNING"}
users to prove the correctness of their personal web data in a privacy-preserving manner.

The core techniques used in Primus include zkTLS and zkFHE. End users run Primus client apps to attest their personal web data, and create related data proofs with the help of Primus nodes. These data proofs are cryptographically verified attestations with security guarantees including:

- **Data authenticity**: The user web data is honestly retrieved from the indicated data source, and

Check warning on line 12 in docs/get-started/tooling/attestations/primus.mdx

View workflow job for this annotation

GitHub Actions / Spelling

[vale] reported by reviewdog 🐶 [Microsoft.Adverbs] Remove 'honestly' if it's not important to the meaning of the statement. Raw Output: {"message": "[Microsoft.Adverbs] Remove 'honestly' if it's not important to the meaning of the statement.", "location": {"path": "docs/get-started/tooling/attestations/primus.mdx", "range": {"start": {"line": 12, "column": 47}}}, "severity": "WARNING"}
the integrity is secured by zkTLS and other advanced cryptographic techniques.
- **Privacy**: When coupled with specific application logic, users' sensitive information is
well-protected under the zero-knowledge property.

The zkTLS and zkFHE techniques are general enough for both data source integration and data
computation. For instance, you can create your own attestations including but not limited to:

- Proofs of CEX assets, e.g., Alice has more than 1000 USD for her total token values in Coinbase;

Check failure on line 20 in docs/get-started/tooling/attestations/primus.mdx

View workflow job for this annotation

GitHub Actions / Spelling

[vale] reported by reviewdog 🐶 [Microsoft.Foreign] Use 'for example' instead of 'e.g.,'. Raw Output: {"message": "[Microsoft.Foreign] Use 'for example' instead of 'e.g.,'.", "location": {"path": "docs/get-started/tooling/attestations/primus.mdx", "range": {"start": {"line": 20, "column": 25}}}, "severity": "ERROR"}
- Proofs of specific token holding, e.g., Alice holds more than 2 ETH in Binance;

Check failure on line 21 in docs/get-started/tooling/attestations/primus.mdx

View workflow job for this annotation

GitHub Actions / Spelling

[vale] reported by reviewdog 🐶 [Microsoft.Foreign] Use 'for example' instead of 'e.g.,'. Raw Output: {"message": "[Microsoft.Foreign] Use 'for example' instead of 'e.g.,'.", "location": {"path": "docs/get-started/tooling/attestations/primus.mdx", "range": {"start": {"line": 21, "column": 37}}}, "severity": "ERROR"}
- Proofs of nationality, e.g., Alice is a verified bank user with British nationality;

Check failure on line 22 in docs/get-started/tooling/attestations/primus.mdx

View workflow job for this annotation

GitHub Actions / Spelling

[vale] reported by reviewdog 🐶 [Microsoft.Foreign] Use 'for example' instead of 'e.g.,'. Raw Output: {"message": "[Microsoft.Foreign] Use 'for example' instead of 'e.g.,'.", "location": {"path": "docs/get-started/tooling/attestations/primus.mdx", "range": {"start": {"line": 22, "column": 26}}}, "severity": "ERROR"}
- Proofs of a heavy gamer, e.g., Bob plays more than 10 hours per day on Steam games.

Check failure on line 23 in docs/get-started/tooling/attestations/primus.mdx

View workflow job for this annotation

GitHub Actions / Spelling

[vale] reported by reviewdog 🐶 [Microsoft.Foreign] Use 'for example' instead of 'e.g.,'. Raw Output: {"message": "[Microsoft.Foreign] Use 'for example' instead of 'e.g.,'.", "location": {"path": "docs/get-started/tooling/attestations/primus.mdx", "range": {"start": {"line": 23, "column": 28}}}, "severity": "ERROR"}

## For developers

The Primus team is creating a template-based SDK (in progress) for developers to build their own
applications using Primus' off-chain attestation capabilities. The SDK will encapsulate the details
of underlying cryptographic algorithms and protocols, and provide high-level interfaces for
application developers to manage the data retrieval and data computation. Developers can leverage
the SDK in two aspects:

- Use the data source templates to integrate with any preferred Internet data source, and to attest
the corresponding type of data.
- Define and implement their own application logic by integrating with data consumption templates.

## Networks

Primus is deployed on Linea, and integrated with [Verax](https://github.com/Consensys/verax-documentation),
a public attestation registry to store and manage attestation data that can be accessed by any
party. This means Primus users can submit these data proofs to Linea via Verax, which can be further
accessed by other dapps. The following contract address is the Primus portal contract:

| Network | Contract address |
| --- | --- |
| Linea Mainnet | [`0x50bd377EB8D4236Bb587AB3FB1eeafd888AEeC58`](https://lineascan.build/address/0x50bd377EB8D4236Bb587AB3FB1eeafd888AEeC58) |

## Resources

Learn more and start using Primus!

- [Product tutorial](https://docs.primuslabs.xyz/)
- [Technical whitepaper](https://eprint.iacr.org/2023/964.pdf)

Check failure on line 53 in docs/get-started/tooling/attestations/primus.mdx

View workflow job for this annotation

GitHub Actions / Spelling

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'whitepaper'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'whitepaper'?", "location": {"path": "docs/get-started/tooling/attestations/primus.mdx", "range": {"start": {"line": 53, "column": 14}}}, "severity": "ERROR"}

## Learn more

- [Twitter](https://x.com/primus_labs)
- [Discord](https://discord.gg/YxJftNRxhh)
- [Website](https://www.primuslabs.xyz)
- [Medium](https://medium.com/@primuslabs)
- [Github](https://github.com/primus-labs)

Check failure on line 61 in docs/get-started/tooling/attestations/primus.mdx

View workflow job for this annotation

GitHub Actions / Spelling

[vale] reported by reviewdog 🐶 [Vale.Terms] Use 'GitHub' instead of 'Github'. Raw Output: {"message": "[Vale.Terms] Use 'GitHub' instead of 'Github'.", "location": {"path": "docs/get-started/tooling/attestations/primus.mdx", "range": {"start": {"line": 61, "column": 4}}}, "severity": "ERROR"}
8 changes: 8 additions & 0 deletions docs/get-started/tooling/libraries/reown.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Reown
image: /img/socialCards/reown.jpg
---

Use the Reown protocol to enable users from a multitude of wallets to log into decentralized applications. Linea is now listed inside the chain list for any project configuration on [Reown Cloud](https://cloud.reown.com).

Check failure on line 6 in docs/get-started/tooling/libraries/reown.mdx

View workflow job for this annotation

GitHub Actions / Spelling

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'Reown'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'Reown'?", "location": {"path": "docs/get-started/tooling/libraries/reown.mdx", "range": {"start": {"line": 6, "column": 9}}}, "severity": "ERROR"}

Check failure on line 6 in docs/get-started/tooling/libraries/reown.mdx

View workflow job for this annotation

GitHub Actions / Spelling

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'Reown'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'Reown'?", "location": {"path": "docs/get-started/tooling/libraries/reown.mdx", "range": {"start": {"line": 6, "column": 184}}}, "severity": "ERROR"}

To learn more about Reown, take a look at the official [page](https://reown.com/).

Check failure on line 8 in docs/get-started/tooling/libraries/reown.mdx

View workflow job for this annotation

GitHub Actions / Spelling

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'Reown'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'Reown'?", "location": {"path": "docs/get-started/tooling/libraries/reown.mdx", "range": {"start": {"line": 8, "column": 21}}}, "severity": "ERROR"}
11 changes: 0 additions & 11 deletions docs/get-started/tooling/libraries/walletconnect.mdx

This file was deleted.

10 changes: 5 additions & 5 deletions redirects.json
Original file line number Diff line number Diff line change
Expand Up @@ -224,8 +224,8 @@
]
},
{
"to": "/get-started/tooling/libraries/walletconnect",
"from": "/developers/tooling/libraries/wallet-connect"
"to": "/get-started/tooling/libraries/reown",
"from": "/developers/tooling/libraries/reown"
},
{
"to": "/get-started/concepts/architecture",
Expand Down Expand Up @@ -280,8 +280,8 @@
"from": "/developers/tooling/attestations"
},
{
"to": "/get-started/tooling/attestations/pado",
"from": "/developers/tooling/attestations/pado"
"to": "/get-started/tooling/attestations/primus",
"from": "/developers/tooling/attestations/primus"
},
{
"to": "/get-started/tooling/privacy/secret",
Expand Down Expand Up @@ -702,4 +702,4 @@
"to": "/api/reference/linea-getproof",
"from": "/developers/reference/api/linea-getproof"
}
]
]
4 changes: 2 additions & 2 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ const sidebars = {
},
items: [
"get-started/tooling/attestations/verax",
"get-started/tooling/attestations/pado",
"get-started/tooling/attestations/primus",
],
},
{
Expand Down Expand Up @@ -455,4 +455,4 @@ const sidebars = {
]
}

module.exports = sidebars;
module.exports = sidebars;
Binary file added static/img/socialCards/primus.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/socialCards/reown.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading