@solarity/zkit 0.3.1 → 0.3.2
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.
- package/README.md +5 -4
- package/dist/core/CircuitZKit.d.ts +11 -4
- package/dist/core/CircuitZKit.d.ts.map +1 -1
- package/dist/core/CircuitZKit.js +14 -7
- package/dist/core/CircuitZKit.js.map +1 -1
- package/dist/core/protocols/AbstractImplementer.d.ts +2 -2
- package/dist/core/protocols/AbstractImplementer.d.ts.map +1 -1
- package/dist/core/protocols/AbstractImplementer.js +5 -4
- package/dist/core/protocols/AbstractImplementer.js.map +1 -1
- package/dist/types/protocols/index.d.ts +2 -2
- package/dist/types/protocols/index.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/core/CircuitZKit.ts +14 -7
- package/src/core/protocols/AbstractImplementer.ts +4 -4
- package/src/types/protocols/index.ts +1 -2
package/README.md
CHANGED
|
@@ -53,12 +53,13 @@ The `implementer` is the instance of a certain proving system. Currently `groth1
|
|
|
53
53
|
|
|
54
54
|
---
|
|
55
55
|
|
|
56
|
-
- **`async createVerifier("sol" | "vy")`**
|
|
56
|
+
- **`async createVerifier("sol" | "vy", verifierNameSuffix?: string)`**
|
|
57
57
|
|
|
58
|
-
Creates a Solidity | Vyper verifier contract on `verifierDirPath` path, which was specified in the config.
|
|
58
|
+
Creates a Solidity | Vyper verifier contract with the optional `verifierNameSuffix` on `verifierDirPath` path, which was specified in the config.
|
|
59
59
|
|
|
60
60
|
```typescript
|
|
61
61
|
await circuit.createVerifier("sol");
|
|
62
|
+
await circuit.createVerifier("sol", "_suffix_");
|
|
62
63
|
```
|
|
63
64
|
|
|
64
65
|
- **`async calculateWitness(inputs) -> bigint[]`**
|
|
@@ -101,12 +102,12 @@ const calldata = await circuit.generateCalldata(proof);
|
|
|
101
102
|
|
|
102
103
|
Returns the name of the circuit from the config.
|
|
103
104
|
|
|
104
|
-
- **`getVerifierName() -> string`**
|
|
105
|
+
- **`getVerifierName(verifierNameSuffix?: string) -> string`**
|
|
105
106
|
|
|
106
107
|
Returns the name of the verifier in the following form:
|
|
107
108
|
|
|
108
109
|
```typescript
|
|
109
|
-
<Circuit name><Proving system>Verifier
|
|
110
|
+
<Circuit name><Suffix><Proving system>Verifier
|
|
110
111
|
```
|
|
111
112
|
|
|
112
113
|
- **`getProvingSystemType() -> "groth16" | "plonk"`**
|
|
@@ -9,9 +9,13 @@ export declare class CircuitZKit<Type extends ProvingSystemType> {
|
|
|
9
9
|
private readonly _implementer;
|
|
10
10
|
constructor(_config: CircuitZKitConfig, _implementer: IProtocolImplementer<Type>);
|
|
11
11
|
/**
|
|
12
|
-
* Creates a verifier contract for the specified contract language.
|
|
12
|
+
* Creates a verifier contract for the specified contract language with optional name suffix.
|
|
13
|
+
* For more details regarding the structure of the contract verifier name, see {@link getVerifierName} description.
|
|
14
|
+
*
|
|
15
|
+
* @param {VerifierLanguageType} languageExtension - The verifier contract language extension.
|
|
16
|
+
* @param {string} verifierNameSuffix - The optional verifier name suffix.
|
|
13
17
|
*/
|
|
14
|
-
createVerifier(languageExtension: VerifierLanguageType): Promise<void>;
|
|
18
|
+
createVerifier(languageExtension: VerifierLanguageType, verifierNameSuffix?: string): Promise<void>;
|
|
15
19
|
/**
|
|
16
20
|
* Calculates a witness for the given inputs.
|
|
17
21
|
*
|
|
@@ -54,11 +58,14 @@ export declare class CircuitZKit<Type extends ProvingSystemType> {
|
|
|
54
58
|
*/
|
|
55
59
|
getCircuitName(): string;
|
|
56
60
|
/**
|
|
57
|
-
* Returns the verifier name. The verifier name
|
|
61
|
+
* Returns the verifier name. The verifier name has the next structure:
|
|
62
|
+
* `<template name><suffix><proving system>Verifier.<extension>`.
|
|
63
|
+
*
|
|
64
|
+
* @param {string} verifierNameSuffix - The optional verifier name suffix.
|
|
58
65
|
*
|
|
59
66
|
* @returns {string} The verifier name.
|
|
60
67
|
*/
|
|
61
|
-
getVerifierName(): string;
|
|
68
|
+
getVerifierName(verifierNameSuffix?: string): string;
|
|
62
69
|
/**
|
|
63
70
|
* Returns the type of the proving protocol
|
|
64
71
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CircuitZKit.d.ts","sourceRoot":"","sources":["../../src/core/CircuitZKit.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AACnG,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAExH;;GAEG;AACH,qBAAa,WAAW,CAAC,IAAI,SAAS,iBAAiB;IAEnD,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,YAAY;gBADZ,OAAO,EAAE,iBAAiB,EAC1B,YAAY,EAAE,oBAAoB,CAAC,IAAI,CAAC;IAG3D
|
|
1
|
+
{"version":3,"file":"CircuitZKit.d.ts","sourceRoot":"","sources":["../../src/core/CircuitZKit.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AACnG,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAExH;;GAEG;AACH,qBAAa,WAAW,CAAC,IAAI,SAAS,iBAAiB;IAEnD,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,YAAY;gBADZ,OAAO,EAAE,iBAAiB,EAC1B,YAAY,EAAE,oBAAoB,CAAC,IAAI,CAAC;IAG3D;;;;;;OAMG;IACU,cAAc,CAAC,iBAAiB,EAAE,oBAAoB,EAAE,kBAAkB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAUhH;;;;;OAKG;IACU,gBAAgB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAiBjE;;;;;;;;OAQG;IACU,aAAa,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAOjF;;;;;;;;OAQG;IACU,WAAW,CAAC,KAAK,EAAE,qBAAqB,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAM9E;;;;;;OAMG;IACU,gBAAgB,CAAC,KAAK,EAAE,qBAAqB,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;IAIpG;;;;OAIG;IACI,cAAc,IAAI,MAAM;IAI/B;;;;;;;OAOG;IACI,eAAe,CAAC,kBAAkB,CAAC,EAAE,MAAM,GAAG,MAAM;IAI3D;;;;OAIG;IACI,oBAAoB,IAAI,iBAAiB;IAIhD;;;;OAIG;IACI,mBAAmB,CAAC,iBAAiB,EAAE,oBAAoB,GAAG,MAAM;IAI3E;;;;;OAKG;IACI,wBAAwB,CAAC,QAAQ,EAAE,iBAAiB,GAAG,MAAM;IAUpE;;;;;OAKG;IACI,oBAAoB,CAAC,QAAQ,EAAE,iBAAiB,GAAG,MAAM;CAgCjE"}
|
package/dist/core/CircuitZKit.js
CHANGED
|
@@ -42,12 +42,16 @@ class CircuitZKit {
|
|
|
42
42
|
this._implementer = _implementer;
|
|
43
43
|
}
|
|
44
44
|
/**
|
|
45
|
-
* Creates a verifier contract for the specified contract language.
|
|
45
|
+
* Creates a verifier contract for the specified contract language with optional name suffix.
|
|
46
|
+
* For more details regarding the structure of the contract verifier name, see {@link getVerifierName} description.
|
|
47
|
+
*
|
|
48
|
+
* @param {VerifierLanguageType} languageExtension - The verifier contract language extension.
|
|
49
|
+
* @param {string} verifierNameSuffix - The optional verifier name suffix.
|
|
46
50
|
*/
|
|
47
|
-
async createVerifier(languageExtension) {
|
|
51
|
+
async createVerifier(languageExtension, verifierNameSuffix) {
|
|
48
52
|
const vKeyFilePath = this.mustGetArtifactsFilePath("vkey");
|
|
49
|
-
const verifierFilePath = path_1.default.join(this._config.verifierDirPath, `${this.
|
|
50
|
-
this._implementer.createVerifier(
|
|
53
|
+
const verifierFilePath = path_1.default.join(this._config.verifierDirPath, `${this.getVerifierName(verifierNameSuffix)}.${languageExtension}`);
|
|
54
|
+
this._implementer.createVerifier(vKeyFilePath, verifierFilePath, languageExtension);
|
|
51
55
|
}
|
|
52
56
|
/**
|
|
53
57
|
* Calculates a witness for the given inputs.
|
|
@@ -112,12 +116,15 @@ class CircuitZKit {
|
|
|
112
116
|
return this._config.circuitName;
|
|
113
117
|
}
|
|
114
118
|
/**
|
|
115
|
-
* Returns the verifier name. The verifier name
|
|
119
|
+
* Returns the verifier name. The verifier name has the next structure:
|
|
120
|
+
* `<template name><suffix><proving system>Verifier.<extension>`.
|
|
121
|
+
*
|
|
122
|
+
* @param {string} verifierNameSuffix - The optional verifier name suffix.
|
|
116
123
|
*
|
|
117
124
|
* @returns {string} The verifier name.
|
|
118
125
|
*/
|
|
119
|
-
getVerifierName() {
|
|
120
|
-
return this._implementer.getVerifierName(this._config.circuitName);
|
|
126
|
+
getVerifierName(verifierNameSuffix) {
|
|
127
|
+
return this._implementer.getVerifierName(this._config.circuitName, verifierNameSuffix);
|
|
121
128
|
}
|
|
122
129
|
/**
|
|
123
130
|
* Returns the type of the proving protocol
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CircuitZKit.js","sourceRoot":"","sources":["../../src/core/CircuitZKit.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4CAAoB;AACpB,gDAAwB;AACxB,uCAAyB;AACzB,iDAAmC;AAMnC;;GAEG;AACH,MAAa,WAAW;IAEH;IACA;IAFnB,YACmB,OAA0B,EAC1B,YAAwC;QADxC,YAAO,GAAP,OAAO,CAAmB;QAC1B,iBAAY,GAAZ,YAAY,CAA4B;IACxD,CAAC;IAEJ
|
|
1
|
+
{"version":3,"file":"CircuitZKit.js","sourceRoot":"","sources":["../../src/core/CircuitZKit.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4CAAoB;AACpB,gDAAwB;AACxB,uCAAyB;AACzB,iDAAmC;AAMnC;;GAEG;AACH,MAAa,WAAW;IAEH;IACA;IAFnB,YACmB,OAA0B,EAC1B,YAAwC;QADxC,YAAO,GAAP,OAAO,CAAmB;QAC1B,iBAAY,GAAZ,YAAY,CAA4B;IACxD,CAAC;IAEJ;;;;;;OAMG;IACI,KAAK,CAAC,cAAc,CAAC,iBAAuC,EAAE,kBAA2B;QAC9F,MAAM,YAAY,GAAW,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;QACnE,MAAM,gBAAgB,GAAG,cAAI,CAAC,IAAI,CAChC,IAAI,CAAC,OAAO,CAAC,eAAe,EAC5B,GAAG,IAAI,CAAC,eAAe,CAAC,kBAAkB,CAAC,IAAI,iBAAiB,EAAE,CACnE,CAAC;QAEF,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,YAAY,EAAE,gBAAgB,EAAE,iBAAiB,CAAC,CAAC;IACtF,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,gBAAgB,CAAC,MAAe;QAC3C,MAAM,MAAM,GAAG,cAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;QAE/C,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3B,YAAE,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC5C,CAAC;QAED,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QACpE,MAAM,QAAQ,GAAG,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;QAEvD,MAAM,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAEzD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAEzD,OAAO,QAAoB,CAAC;IAC9B,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,aAAa,CAAC,MAAe;QACxC,MAAM,QAAQ,GAAG,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;QACvD,MAAM,QAAQ,GAAG,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;QAEvD,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,WAAW,CAAC,KAAkC;QACzD,MAAM,QAAQ,GAAG,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;QAEvD,OAAO,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,gBAAgB,CAAC,KAAkC;QAC9D,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,cAAc;QACnB,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;IAClC,CAAC;IAED;;;;;;;OAOG;IACI,eAAe,CAAC,kBAA2B;QAChD,OAAO,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAAC;IACzF,CAAC;IAED;;;;OAIG;IACI,oBAAoB;QACzB,OAAO,IAAI,CAAC,YAAY,CAAC,oBAAoB,EAAE,CAAC;IAClD,CAAC;IAED;;;;OAIG;IACI,mBAAmB,CAAC,iBAAuC;QAChE,OAAO,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;OAKG;IACI,wBAAwB,CAAC,QAA2B;QACzD,MAAM,IAAI,GAAG,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QAEjD,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,sBAAsB,IAAI,YAAY,CAAC,CAAC;QAC1D,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,oBAAoB,CAAC,QAA2B;QACrD,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAE1C,IAAI,QAAgB,CAAC;QACrB,IAAI,OAAO,GAAW,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC;QAExD,QAAQ,QAAQ,EAAE,CAAC;YACjB,KAAK,MAAM;gBACT,QAAQ,GAAG,GAAG,WAAW,OAAO,CAAC;gBACjC,MAAM;YACR,KAAK,MAAM;gBACT,QAAQ,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC/D,MAAM;YACR,KAAK,MAAM;gBACT,QAAQ,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC/D,MAAM;YACR,KAAK,KAAK;gBACR,QAAQ,GAAG,GAAG,WAAW,MAAM,CAAC;gBAChC,MAAM;YACR,KAAK,MAAM;gBACT,QAAQ,GAAG,GAAG,WAAW,mBAAmB,CAAC;gBAC7C,MAAM;YACR,KAAK,MAAM;gBACT,QAAQ,GAAG,GAAG,WAAW,OAAO,CAAC;gBACjC,OAAO,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,WAAW,KAAK,CAAC,CAAC;gBAClD,MAAM;YACR;gBACE,MAAM,IAAI,KAAK,CAAC,wBAAwB,QAAQ,GAAG,CAAC,CAAC;QACzD,CAAC;QAED,OAAO,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACtC,CAAC;CACF;AArLD,kCAqLC"}
|
|
@@ -2,13 +2,13 @@ import { Signals } from "../../types/proof-utils";
|
|
|
2
2
|
import { IProtocolImplementer, ProvingSystemType, ProofStructByProtocol, CalldataByProtocol } from "../../types/protocols";
|
|
3
3
|
import { VerifierLanguageType } from "../../types/circuit-zkit";
|
|
4
4
|
export declare abstract class AbstractProtocolImplementer<T extends ProvingSystemType> implements IProtocolImplementer<T> {
|
|
5
|
-
createVerifier(
|
|
5
|
+
createVerifier(vKeyFilePath: string, verifierFilePath: string, languageExtension: VerifierLanguageType): Promise<void>;
|
|
6
6
|
abstract generateProof(inputs: Signals, zKeyFilePath: string, wasmFilePath: string): Promise<ProofStructByProtocol<T>>;
|
|
7
7
|
abstract verifyProof(proof: ProofStructByProtocol<T>, vKeyFilePath: string): Promise<boolean>;
|
|
8
8
|
abstract generateCalldata(proof: ProofStructByProtocol<T>): Promise<CalldataByProtocol<T>>;
|
|
9
9
|
abstract getProvingSystemType(): ProvingSystemType;
|
|
10
10
|
getTemplate(languageExtension: VerifierLanguageType): string;
|
|
11
|
-
getVerifierName(circuitName: string): string;
|
|
11
|
+
getVerifierName(circuitName: string, verifierNameSuffix?: string): string;
|
|
12
12
|
getZKeyFileName(circuitName: string): string;
|
|
13
13
|
getVKeyFileName(circuitName: string): string;
|
|
14
14
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AbstractImplementer.d.ts","sourceRoot":"","sources":["../../../src/core/protocols/AbstractImplementer.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAClD,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,EACnB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAEhE,8BAAsB,2BAA2B,CAAC,CAAC,SAAS,iBAAiB,CAAE,YAAW,oBAAoB,CAAC,CAAC,CAAC;IAClG,cAAc,CACzB,
|
|
1
|
+
{"version":3,"file":"AbstractImplementer.d.ts","sourceRoot":"","sources":["../../../src/core/protocols/AbstractImplementer.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAClD,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EACjB,qBAAqB,EACrB,kBAAkB,EACnB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAEhE,8BAAsB,2BAA2B,CAAC,CAAC,SAAS,iBAAiB,CAAE,YAAW,oBAAoB,CAAC,CAAC,CAAC;IAClG,cAAc,CACzB,YAAY,EAAE,MAAM,EACpB,gBAAgB,EAAE,MAAM,EACxB,iBAAiB,EAAE,oBAAoB,GACtC,OAAO,CAAC,IAAI,CAAC;aAeA,aAAa,CAC3B,MAAM,EAAE,OAAO,EACf,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;aAEpB,WAAW,CAAC,KAAK,EAAE,qBAAqB,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;aAEpF,gBAAgB,CAAC,KAAK,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;aAEjF,oBAAoB,IAAI,iBAAiB;IAElD,WAAW,CAAC,iBAAiB,EAAE,oBAAoB,GAAG,MAAM;IAO5D,eAAe,CAAC,WAAW,EAAE,MAAM,EAAE,kBAAkB,CAAC,EAAE,MAAM,GAAG,MAAM;IAOzE,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM;IAI5C,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM;CAGpD"}
|
|
@@ -8,22 +8,23 @@ const fs_1 = __importDefault(require("fs"));
|
|
|
8
8
|
const ejs_1 = __importDefault(require("ejs"));
|
|
9
9
|
const path_1 = __importDefault(require("path"));
|
|
10
10
|
class AbstractProtocolImplementer {
|
|
11
|
-
async createVerifier(
|
|
11
|
+
async createVerifier(vKeyFilePath, verifierFilePath, languageExtension) {
|
|
12
12
|
const verifierTemplate = this.getTemplate(languageExtension);
|
|
13
13
|
if (!fs_1.default.existsSync(path_1.default.dirname(verifierFilePath))) {
|
|
14
14
|
fs_1.default.mkdirSync(path_1.default.dirname(verifierFilePath), { recursive: true });
|
|
15
15
|
}
|
|
16
16
|
const templateParams = JSON.parse(fs_1.default.readFileSync(vKeyFilePath, "utf-8"));
|
|
17
|
-
templateParams["verifier_id"] =
|
|
17
|
+
templateParams["verifier_id"] = path_1.default.parse(verifierFilePath).name;
|
|
18
18
|
const verifierCode = ejs_1.default.render(verifierTemplate, templateParams);
|
|
19
19
|
fs_1.default.writeFileSync(verifierFilePath, verifierCode, "utf-8");
|
|
20
20
|
}
|
|
21
21
|
getTemplate(languageExtension) {
|
|
22
22
|
return fs_1.default.readFileSync(path_1.default.join(__dirname, "..", "templates", `verifier_${this.getProvingSystemType()}.${languageExtension}.ejs`), "utf8");
|
|
23
23
|
}
|
|
24
|
-
getVerifierName(circuitName) {
|
|
24
|
+
getVerifierName(circuitName, verifierNameSuffix) {
|
|
25
25
|
const protocolType = this.getProvingSystemType();
|
|
26
|
-
|
|
26
|
+
const nameSuffix = verifierNameSuffix ?? "";
|
|
27
|
+
return `${circuitName}${nameSuffix}${protocolType.charAt(0).toUpperCase() + protocolType.slice(1)}Verifier`;
|
|
27
28
|
}
|
|
28
29
|
getZKeyFileName(circuitName) {
|
|
29
30
|
return `${circuitName}.${this.getProvingSystemType()}.zkey`;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AbstractImplementer.js","sourceRoot":"","sources":["../../../src/core/protocols/AbstractImplementer.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAoB;AACpB,8CAAsB;AACtB,gDAAwB;AAWxB,MAAsB,2BAA2B;IACxC,KAAK,CAAC,cAAc,CACzB,
|
|
1
|
+
{"version":3,"file":"AbstractImplementer.js","sourceRoot":"","sources":["../../../src/core/protocols/AbstractImplementer.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAoB;AACpB,8CAAsB;AACtB,gDAAwB;AAWxB,MAAsB,2BAA2B;IACxC,KAAK,CAAC,cAAc,CACzB,YAAoB,EACpB,gBAAwB,EACxB,iBAAuC;QAEvC,MAAM,gBAAgB,GAAW,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;QAErE,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,cAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,EAAE,CAAC;YACnD,YAAE,CAAC,SAAS,CAAC,cAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACpE,CAAC;QAED,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,YAAE,CAAC,YAAY,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC;QAC1E,cAAc,CAAC,aAAa,CAAC,GAAG,cAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC;QAElE,MAAM,YAAY,GAAG,aAAG,CAAC,MAAM,CAAC,gBAAgB,EAAE,cAAc,CAAC,CAAC;QAElE,YAAE,CAAC,aAAa,CAAC,gBAAgB,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAcM,WAAW,CAAC,iBAAuC;QACxD,OAAO,YAAE,CAAC,YAAY,CACpB,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,YAAY,IAAI,CAAC,oBAAoB,EAAE,IAAI,iBAAiB,MAAM,CAAC,EAC3G,MAAM,CACP,CAAC;IACJ,CAAC;IAEM,eAAe,CAAC,WAAmB,EAAE,kBAA2B;QACrE,MAAM,YAAY,GAAsB,IAAI,CAAC,oBAAoB,EAAE,CAAC;QACpE,MAAM,UAAU,GAAW,kBAAkB,IAAI,EAAE,CAAC;QAEpD,OAAO,GAAG,WAAW,GAAG,UAAU,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC;IAC9G,CAAC;IAEM,eAAe,CAAC,WAAmB;QACxC,OAAO,GAAG,WAAW,IAAI,IAAI,CAAC,oBAAoB,EAAE,OAAO,CAAC;IAC9D,CAAC;IAEM,eAAe,CAAC,WAAmB;QACxC,OAAO,GAAG,WAAW,IAAI,IAAI,CAAC,oBAAoB,EAAE,YAAY,CAAC;IACnE,CAAC;CACF;AArDD,kEAqDC"}
|
|
@@ -5,13 +5,13 @@ import { VerifierLanguageType } from "../circuit-zkit";
|
|
|
5
5
|
export * from "./groth16";
|
|
6
6
|
export * from "./plonk";
|
|
7
7
|
export interface IProtocolImplementer<T extends ProvingSystemType> {
|
|
8
|
-
createVerifier(
|
|
8
|
+
createVerifier(vKeyFilePath: string, verifierFilePath: string, languageExtension: VerifierLanguageType): Promise<void>;
|
|
9
9
|
generateProof(inputs: Signals, zKeyFilePath: string, wasmFilePath: string): Promise<ProofStructByProtocol<T>>;
|
|
10
10
|
verifyProof(proof: ProofStructByProtocol<T>, vKeyFilePath: string): Promise<boolean>;
|
|
11
11
|
generateCalldata(proof: ProofStructByProtocol<T>): Promise<CalldataByProtocol<T>>;
|
|
12
12
|
getProvingSystemType(): ProvingSystemType;
|
|
13
13
|
getTemplate(fileExtension: VerifierLanguageType): string;
|
|
14
|
-
getVerifierName(circuitName: string): string;
|
|
14
|
+
getVerifierName(circuitName: string, verifierNameSuffix?: string): string;
|
|
15
15
|
getZKeyFileName(circuitName: string): string;
|
|
16
16
|
getVKeyFileName(circuitName: string): string;
|
|
17
17
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/protocols/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE1D,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AACzC,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAEvD,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AAExB,MAAM,WAAW,oBAAoB,CAAC,CAAC,SAAS,iBAAiB;IAC/D,cAAc,CACZ,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/protocols/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE1D,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AACzC,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAEvD,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AAExB,MAAM,WAAW,oBAAoB,CAAC,CAAC,SAAS,iBAAiB;IAC/D,cAAc,CACZ,YAAY,EAAE,MAAM,EACpB,gBAAgB,EAAE,MAAM,EACxB,iBAAiB,EAAE,oBAAoB,GACtC,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB,aAAa,CAAC,MAAM,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC;IAE9G,WAAW,CAAC,KAAK,EAAE,qBAAqB,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAErF,gBAAgB,CAAC,KAAK,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;IAElF,oBAAoB,IAAI,iBAAiB,CAAC;IAE1C,WAAW,CAAC,aAAa,EAAE,oBAAoB,GAAG,MAAM,CAAC;IAEzD,eAAe,CAAC,WAAW,EAAE,MAAM,EAAE,kBAAkB,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAE1E,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC;IAE7C,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC;CAC9C;AAED,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE;QACP,WAAW,EAAE,kBAAkB,CAAC;QAChC,QAAQ,EAAE,eAAe,CAAC;KAC3B,CAAC;IACF,KAAK,EAAE;QACL,WAAW,EAAE,gBAAgB,CAAC;QAC9B,QAAQ,EAAE,aAAa,CAAC;KACzB,CAAC;CACH;AAED,MAAM,MAAM,iBAAiB,GAAG,MAAM,sBAAsB,CAAC;AAE7D,MAAM,MAAM,qBAAqB,CAAC,CAAC,SAAS,iBAAiB,IAAI,sBAAsB,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;AAC1G,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,iBAAiB,IAAI,sBAAsB,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC"}
|
package/package.json
CHANGED
package/src/core/CircuitZKit.ts
CHANGED
|
@@ -17,16 +17,20 @@ export class CircuitZKit<Type extends ProvingSystemType> {
|
|
|
17
17
|
) {}
|
|
18
18
|
|
|
19
19
|
/**
|
|
20
|
-
* Creates a verifier contract for the specified contract language.
|
|
20
|
+
* Creates a verifier contract for the specified contract language with optional name suffix.
|
|
21
|
+
* For more details regarding the structure of the contract verifier name, see {@link getVerifierName} description.
|
|
22
|
+
*
|
|
23
|
+
* @param {VerifierLanguageType} languageExtension - The verifier contract language extension.
|
|
24
|
+
* @param {string} verifierNameSuffix - The optional verifier name suffix.
|
|
21
25
|
*/
|
|
22
|
-
public async createVerifier(languageExtension: VerifierLanguageType): Promise<void> {
|
|
26
|
+
public async createVerifier(languageExtension: VerifierLanguageType, verifierNameSuffix?: string): Promise<void> {
|
|
23
27
|
const vKeyFilePath: string = this.mustGetArtifactsFilePath("vkey");
|
|
24
28
|
const verifierFilePath = path.join(
|
|
25
29
|
this._config.verifierDirPath,
|
|
26
|
-
`${this.
|
|
30
|
+
`${this.getVerifierName(verifierNameSuffix)}.${languageExtension}`,
|
|
27
31
|
);
|
|
28
32
|
|
|
29
|
-
this._implementer.createVerifier(
|
|
33
|
+
this._implementer.createVerifier(vKeyFilePath, verifierFilePath, languageExtension);
|
|
30
34
|
}
|
|
31
35
|
|
|
32
36
|
/**
|
|
@@ -104,12 +108,15 @@ export class CircuitZKit<Type extends ProvingSystemType> {
|
|
|
104
108
|
}
|
|
105
109
|
|
|
106
110
|
/**
|
|
107
|
-
* Returns the verifier name. The verifier name
|
|
111
|
+
* Returns the verifier name. The verifier name has the next structure:
|
|
112
|
+
* `<template name><suffix><proving system>Verifier.<extension>`.
|
|
113
|
+
*
|
|
114
|
+
* @param {string} verifierNameSuffix - The optional verifier name suffix.
|
|
108
115
|
*
|
|
109
116
|
* @returns {string} The verifier name.
|
|
110
117
|
*/
|
|
111
|
-
public getVerifierName(): string {
|
|
112
|
-
return this._implementer.getVerifierName(this._config.circuitName);
|
|
118
|
+
public getVerifierName(verifierNameSuffix?: string): string {
|
|
119
|
+
return this._implementer.getVerifierName(this._config.circuitName, verifierNameSuffix);
|
|
113
120
|
}
|
|
114
121
|
|
|
115
122
|
/**
|
|
@@ -13,7 +13,6 @@ import { VerifierLanguageType } from "../../types/circuit-zkit";
|
|
|
13
13
|
|
|
14
14
|
export abstract class AbstractProtocolImplementer<T extends ProvingSystemType> implements IProtocolImplementer<T> {
|
|
15
15
|
public async createVerifier(
|
|
16
|
-
circuitName: string,
|
|
17
16
|
vKeyFilePath: string,
|
|
18
17
|
verifierFilePath: string,
|
|
19
18
|
languageExtension: VerifierLanguageType,
|
|
@@ -25,7 +24,7 @@ export abstract class AbstractProtocolImplementer<T extends ProvingSystemType> i
|
|
|
25
24
|
}
|
|
26
25
|
|
|
27
26
|
const templateParams = JSON.parse(fs.readFileSync(vKeyFilePath, "utf-8"));
|
|
28
|
-
templateParams["verifier_id"] =
|
|
27
|
+
templateParams["verifier_id"] = path.parse(verifierFilePath).name;
|
|
29
28
|
|
|
30
29
|
const verifierCode = ejs.render(verifierTemplate, templateParams);
|
|
31
30
|
|
|
@@ -51,10 +50,11 @@ export abstract class AbstractProtocolImplementer<T extends ProvingSystemType> i
|
|
|
51
50
|
);
|
|
52
51
|
}
|
|
53
52
|
|
|
54
|
-
public getVerifierName(circuitName: string): string {
|
|
53
|
+
public getVerifierName(circuitName: string, verifierNameSuffix?: string): string {
|
|
55
54
|
const protocolType: ProvingSystemType = this.getProvingSystemType();
|
|
55
|
+
const nameSuffix: string = verifierNameSuffix ?? "";
|
|
56
56
|
|
|
57
|
-
return `${circuitName}${protocolType.charAt(0).toUpperCase() + protocolType.slice(1)}Verifier`;
|
|
57
|
+
return `${circuitName}${nameSuffix}${protocolType.charAt(0).toUpperCase() + protocolType.slice(1)}Verifier`;
|
|
58
58
|
}
|
|
59
59
|
|
|
60
60
|
public getZKeyFileName(circuitName: string): string {
|
|
@@ -9,7 +9,6 @@ export * from "./plonk";
|
|
|
9
9
|
|
|
10
10
|
export interface IProtocolImplementer<T extends ProvingSystemType> {
|
|
11
11
|
createVerifier(
|
|
12
|
-
circuitName: string,
|
|
13
12
|
vKeyFilePath: string,
|
|
14
13
|
verifierFilePath: string,
|
|
15
14
|
languageExtension: VerifierLanguageType,
|
|
@@ -25,7 +24,7 @@ export interface IProtocolImplementer<T extends ProvingSystemType> {
|
|
|
25
24
|
|
|
26
25
|
getTemplate(fileExtension: VerifierLanguageType): string;
|
|
27
26
|
|
|
28
|
-
getVerifierName(circuitName: string): string;
|
|
27
|
+
getVerifierName(circuitName: string, verifierNameSuffix?: string): string;
|
|
29
28
|
|
|
30
29
|
getZKeyFileName(circuitName: string): string;
|
|
31
30
|
|