fix(docs): fix MaybeGetSnarkArtifacts signature

privacy-scaling-explorations · Apr 29, 2024 · 2cfe7ed · 2cfe7ed
1 parent 7039eb3
commit 2cfe7ed
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 5 deletions.
diff --git a/packages/utils/src/snark-artifacts/snark-artifacts.browser.ts b/packages/utils/src/snark-artifacts/snark-artifacts.browser.ts
@@ -1,15 +1,15 @@
 import { GetSnarkArtifactUrls } from "./config"
-import { Proof, SnarkArtifacts, Version } from "../types"
+import { Artifact, Proof, Version } from "../types"
 
-function MaybeGetSnarkArtifacts(proof: Proof.EDDSA, version?: Version): () => Promise<SnarkArtifacts>
+function MaybeGetSnarkArtifacts(proof: Proof.EDDSA, version?: Version): () => Promise<Record<Artifact,string[]>>
 function MaybeGetSnarkArtifacts(
     proof: Proof.POSEIDON,
     version?: Version
-): (numberOfInputs: number) => Promise<SnarkArtifacts>
+): (numberOfInputs: number) => Promise<Record<Artifact,string[]>>
 function MaybeGetSnarkArtifacts(
     proof: Proof.SEMAPHORE,
     version?: Version
-): (treeDepth: number) => Promise<SnarkArtifacts>
+): (treeDepth: number) => Promise<Record<Artifact,string[]>>
 function MaybeGetSnarkArtifacts(proof: Proof, version?: Version) {
     switch (proof) {
         case Proof.POSEIDON:

diff --git a/packages/utils/src/types/index.ts b/packages/utils/src/types/index.ts
@@ -45,7 +45,10 @@ export enum Artifact {
  */
 export type SnarkArtifacts = Record<Artifact, string>
 
-type Digit = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9"
+/**
+ * @internal
+ */
+export type Digit = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9"
 
 /**
  * Semantic version.