Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/spelling.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ jobs:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

- name: Vale
uses: Consensys/github-actions/docs-spelling-check@89c262a30cae735be99dc776f9556b796fb456ca # v1.0.0
uses: Consensys-Incorporated/github-actions/docs-spelling-check@89c262a30cae735be99dc776f9556b796fb456ca # v1.0.0
2 changes: 1 addition & 1 deletion .linkspector.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ followRedirects: true
ignorePatterns:
- pattern: '^http(s)?://localhost'
- pattern: '^http(s)?://127.0.0.1'
- pattern: '^http(s)?://gitlab.com/ConsenSys/'
- pattern: '^http(s)?://gitlab.com/Consensys-Incorporated/'
- pattern: '^http(s)?://consensys.net'
- pattern: '^http(s)?://.+.zendesk.com'
- pattern: '^http(s)?://.+.etherscan.io'
Expand Down
2 changes: 1 addition & 1 deletion .releaserc.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ const mainConfig = {
},
],
],
repositoryUrl: "https://github.com/ConsenSys/doc.gnark",
repositoryUrl: "https://github.com/Consensys-Incorporated/doc.gnark",
};

module.exports = mainConfig;
4 changes: 2 additions & 2 deletions CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
* @consensys/protocol-pliny
* @consensys-incorporated/documentation

.github/workflows/ @consensys/protocol-galileo
.github/workflows/ @consensys-incorporated/protocols-dso
2 changes: 1 addition & 1 deletion docs/HowTo/prove.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ If witness is not built within the same process, or in another programming langu

On `ecc.BN254` + `Groth16`, `gnark` can export the `groth16.VerifyingKey` as a solidity smart contract.

Refer to [the code example](https://github.com/ConsenSys/gnark-tests/blob/main/solidity/contract/main.go) and [end-to-end integration test](https://github.com/ConsenSys/gnark-tests/blob/47873ce8e146c1f74477a15972ec63cbfd73c888/solidity/solidity_test.go#L81) using a `geth` simulated blockchain.
Refer to [the code example](https://github.com/Consensys-Incorporated/gnark-tests/blob/main/solidity/contract/main.go) and [end-to-end integration test](https://github.com/Consensys-Incorporated/gnark-tests/blob/47873ce8e146c1f74477a15972ec63cbfd73c888/solidity/solidity_test.go#L81) using a `geth` simulated blockchain.

```go
// 1. Compile (Groth16 + BN254)
Expand Down
2 changes: 1 addition & 1 deletion docs/HowTo/write/instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,6 @@ func (cs *ConstraintSystem) Select(b Variable, i1, i2 interface{}) Variable {

:::note

Work is ongoing to provide a `if` like statement. [Github issue](https://github.com/ConsenSys/gnark/issues/81).
Work is ongoing to provide a `if` like statement. [Github issue](https://github.com/Consensys-Incorporated/gnark/issues/81).

:::
2 changes: 1 addition & 1 deletion docs/Reference/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ Refer to the GoDoc for API documentation and examples.
- [Front end](https://pkg.go.dev/github.com/consensys/gnark/frontend)
- [Back end](https://pkg.go.dev/github.com/consensys/gnark/backend)

Note that the elliptic curve, field arithmetic, FFT, polynomial commitment schemes, hash function, and signature verification is provided by the [`gnark-crypto` package](https://github.com/ConsenSys/gnark-crypto)
Note that the elliptic curve, field arithmetic, FFT, polynomial commitment schemes, hash function, and signature verification is provided by the [`gnark-crypto` package](https://github.com/Consensys-Incorporated/gnark-crypto)
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ In a typical workflow:

:::warning

`gnark` has been [audited](https://github.com/Consensys/gnark/blob/master/audits/2022-10%20-%20Kudelski%20-%20gnark-crypto.pdf) and is provided as-is, use at your own risk.
`gnark` has been [audited](https://github.com/Consensys-Incorporated/gnark/blob/master/audits/2022-10%20-%20Kudelski%20-%20gnark-crypto.pdf) and is provided as-is, use at your own risk.

In particular, `gnark` makes no security guarantees such as constant time implementation or side-channel attack resistance.

Expand Down Expand Up @@ -137,7 +137,7 @@ It is difficult to fairly and accurately compare benchmarks among libraries. Som

:::

On low-level primitives like the pairing or the field multiplication, [gnark-crypto](https://github.com/ConsenSys/gnark-crypto) outperforms most libraries out there. It translates well up-the-stack - `gnark` compiles gigantic circuits in seconds, and its solver (aka witness generation) and provers perform very well on most architectures.
On low-level primitives like the pairing or the field multiplication, [gnark-crypto](https://github.com/Consensys-Incorporated/gnark-crypto) outperforms most libraries out there. It translates well up-the-stack - `gnark` compiles gigantic circuits in seconds, and its solver (aka witness generation) and provers perform very well on most architectures.

Here we benchmark two circuits (65k and 8M constraints) using `gnark`, `arkworks` and `rapidsnark` on the BN254 curve.

Expand Down
12 changes: 6 additions & 6 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ const config = {

// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: "ConsenSys", // Usually your GitHub org/user name.
organizationName: "Consensys-Incorporated", // Usually your GitHub org/user name.
projectName: "doc.gnark", // Usually your repo name.
deploymentBranch: "gh-pages", // Github Pages deploying branch

Expand All @@ -39,7 +39,7 @@ const config = {
breadcrumbs: true,
sidebarPath: require.resolve("./sidebars.js"),
// Set a base path separate from default /docs
editUrl: "https://github.com/ConsenSys/doc.gnark/tree/main/",
editUrl: "https://github.com/Consensys-Incorporated/doc.gnark/tree/main/",
routeBasePath: "/",
path: "docs",
include: ["**/*.md", "**/*.mdx"],
Expand Down Expand Up @@ -140,7 +140,7 @@ const config = {
position: "left",
},
{
href: "https://github.com/ConsenSys/gnark",
href: "https://github.com/Consensys-Incorporated/gnark",
className: "header-github-link",
position: "right",
"aria-label": "gnark on GitHub",
Expand Down Expand Up @@ -179,7 +179,7 @@ const config = {
},
{
label: "Go package",
href: "https://pkg.go.dev/github.com/consensys/gnark",
href: "https://pkg.go.dev/github.com/Consensys-Incorporated/gnark",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Broken Go package documentation link

Medium Severity

The footer Go package link now points at pkg.go.dev/github.com/Consensys-Incorporated/gnark, but the published module path is still github.com/consensys/gnark. pkg.go.dev indexes the Go module path, not the GitHub org, so this site-wide docs link will not resolve.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 7af86cf. Configure here.

},
],
},
Expand All @@ -188,11 +188,11 @@ const config = {
items: [
{
label: "gnark on GitHub",
href: "https://github.com/ConsenSys/gnark",
href: "https://github.com/Consensys-Incorporated/gnark",
},
{
label: "Improve these docs",
href: "https://github.com/ConsenSys/doc.gnark",
href: "https://github.com/Consensys-Incorporated/doc.gnark",
},
],
},
Expand Down
Loading