Merge pull request #2219 from o1-labs/chore/rename-clarity-snarky

Trivo25 · web-flow · commit 664682b27f2d · 2025-05-29T11:38:12.000+07:00
Rename `snarky.js` -&gt; `bindings.js` for clarity
diff --git a/flake.nix b/flake.nix
@@ -254,7 +254,7 @@
                 ./dune-project
                 ./.prettierrc.cjs
                 ./src/build
-                ./src/snarky.d.ts
+                ./src/bindings.d.ts
               ];
             });
           inherit (inputs.mina.devShells."${system}".default)
diff --git a/src/bindings.d.ts b/src/bindings.d.ts
diff --git a/src/bindings.js b/src/bindings.js
diff --git a/src/bindings.web.js b/src/bindings.web.js
diff --git a/src/bindings/crypto/bindings.ts b/src/bindings/crypto/bindings.ts
@@ -1,7 +1,7 @@
 /**
  * This file contains bindings for JSOO written in TS and integrated with our normal code base.
  * It is exposed to JSOO by populating a global variable with an object.
- * It gets imported as the first thing in ../../snarky.js so that the global variable is ready by the time JSOO code gets executed.
+ * It gets imported as the first thing in ../../bindings.js so that the global variable is ready by the time JSOO code gets executed.
  */
 import { prefixHashes, prefixHashesLegacy } from '../crypto/constants.js';
 import { Bigint256Bindings } from './bindings/bigint256.js';
diff --git a/src/bindings/crypto/poseidon.unit-test.ts b/src/bindings/crypto/poseidon.unit-test.ts
@@ -4,7 +4,7 @@ import { testPoseidonLegacyFp } from './test-vectors/poseidon-legacy.js';
 import { expect } from 'expect';
 import { bigIntToBytes, parseHexString32 } from './bigint-helpers.js';
 import { test, Random } from '../../lib/testing/property.js';
-import { Test } from '../../snarky.js';
+import { Test } from '../../bindings.js';
 import { FieldConst } from '../../lib/provable/core/fieldvar.js';
 import { MlArray } from '../../lib/ml/base.js';
 import { Fp } from './finite-field.js';
diff --git a/src/build/build-web.js b/src/build/build-web.js
@@ -48,8 +48,8 @@ async function buildWeb({ production }) {
   // copy over pure js files
   await copy({
     './src/bindings/compiled/web_bindings/': './dist/web/web_bindings/',
-    './src/snarky.d.ts': './dist/web/snarky.d.ts',
-    './src/snarky.web.js': './dist/web/snarky.js',
+    './src/bindings.d.ts': './dist/web/bindings.d.ts',
+    './src/bindings.web.js': './dist/web/bindings.js',
     './src/bindings/js/web/': './dist/web/bindings/js/web/',
   });
 
diff --git a/src/build/copy-to-dist.js b/src/build/copy-to-dist.js
@@ -3,7 +3,7 @@ import { copyFromTo } from './utils.js';
 
 await copyFromTo(
   [
-    'src/snarky.d.ts',
+    'src/bindings.d.ts',
     'src/bindings/compiled/_node_bindings',
     'src/bindings/compiled/node_bindings/plonk_wasm.d.cts',
   ],
diff --git a/src/index.ts b/src/index.ts
@@ -1,6 +1,6 @@
 export { TupleN } from './lib/util/types.js';
 export type { ProvablePure } from './lib/provable/types/provable-intf.js';
-export { Ledger, initializeBindings } from './snarky.js';
+export { Ledger, initializeBindings } from './bindings.js';
 export { Field, Bool, Group, Scalar } from './lib/provable/wrapped.js';
 export {
   createForeignField,
diff --git a/src/lib/mina/v1/account-update.ts b/src/lib/mina/v1/account-update.ts
@@ -2,7 +2,7 @@ import { cloneCircuitValue, FlexibleProvable, StructNoJson } from '../../provabl
 import { provable, provableExtends, provablePure } from '../../provable/types/provable-derivers.js';
 import { memoizationContext, memoizeWitness, Provable } from '../../provable/provable.js';
 import { Field, Bool } from '../../provable/wrapped.js';
-import { Pickles } from '../../../snarky.js';
+import { Pickles } from '../../../bindings.js';
 import { jsLayout } from '../../../bindings/mina-transaction/gen/v1/js-layout.js';
 import { Types, toJSONEssential } from '../../../bindings/mina-transaction/v1/types.js';
 import { PrivateKey, PublicKey } from '../../provable/crypto/signature.js';
diff --git a/src/lib/mina/v1/account-update.unit-test.ts b/src/lib/mina/v1/account-update.unit-test.ts
@@ -1,6 +1,6 @@
 import { mocks } from '../../../bindings/crypto/constants.js';
 import { AccountUpdate, PrivateKey, Field, Bool, Mina, Int64, Types } from '../../../index.js';
-import { Test } from '../../../snarky.js';
+import { Test } from '../../../bindings.js';
 import { expect } from 'expect';
 
 let mlTest = await Test();
diff --git a/src/lib/mina/v1/hash-input.unit-test.ts b/src/lib/mina/v1/hash-input.unit-test.ts
@@ -6,7 +6,7 @@ import { packToFields } from '../../provable/crypto/poseidon.js';
 import { Random, test } from '../../testing/property.js';
 import { MlHashInput } from '../../ml/conversion.js';
 import { MlFieldConstArray } from '../../ml/fields.js';
-import { Test } from '../../../snarky.js';
+import { Test } from '../../../bindings.js';
 
 let { hashInputFromJson } = await Test();
 
diff --git a/src/lib/mina/v1/local-blockchain.ts b/src/lib/mina/v1/local-blockchain.ts
@@ -1,7 +1,7 @@
 import { SimpleLedger } from './transaction-logic/ledger.js';
 import { Ml } from '../../ml/conversion.js';
 import { transactionCommitments } from '../../../mina-signer/src/sign-zkapp-command.js';
-import { Ledger, Test, initializeBindings } from '../../../snarky.js';
+import { Ledger, Test, initializeBindings } from '../../../bindings.js';
 import { Field } from '../../provable/wrapped.js';
 import { UInt32, UInt64 } from '../../provable/int.js';
 import { PrivateKey, PublicKey } from '../../provable/crypto/signature.js';
diff --git a/src/lib/mina/v1/mina.ts b/src/lib/mina/v1/mina.ts
@@ -1,4 +1,4 @@
-import { Test } from '../../../snarky.js';
+import { Test } from '../../../bindings.js';
 import { Field } from '../../provable/wrapped.js';
 import { UInt64 } from '../../provable/int.js';
 import { PublicKey } from '../../provable/crypto/signature.js';
diff --git a/src/lib/mina/v1/token/forest-iterator.unit-test.ts b/src/lib/mina/v1/token/forest-iterator.unit-test.ts
@@ -8,7 +8,7 @@ import {
   hashAccountUpdate,
 } from '../account-update.js';
 import { TypesBigint } from '../../../../bindings/mina-transaction/v1/types.js';
-import { Pickles, initializeBindings } from '../../../../snarky.js';
+import { Pickles, initializeBindings } from '../../../../bindings.js';
 import {
   accountUpdatesToCallForest,
   callForestHash,
diff --git a/src/lib/mina/v1/zkapp.ts b/src/lib/mina/v1/zkapp.ts
@@ -1,5 +1,5 @@
 import 'reflect-metadata';
-import { Gate, Pickles } from '../../../snarky.js';
+import { Gate, Pickles } from '../../../bindings.js';
 import { Field, Bool } from '../../provable/wrapped.js';
 import {
   AccountUpdate,
diff --git a/src/lib/mina/v2/account-update.ts b/src/lib/mina/v2/account-update.ts
@@ -10,7 +10,7 @@ import { Option, TokenId, Update, ZkappUri, mapUndefined } from './core.js';
 import { Permissions, PermissionsDescription } from './permissions.js';
 import { Preconditions, PreconditionsDescription } from './preconditions.js';
 import { GenericStateUpdates, StateDefinition, StateLayout, StateUpdates } from './state.js';
-import { Pickles } from '../../../snarky.js';
+import { Pickles } from '../../../bindings.js';
 import { Bool } from '../../provable/bool.js';
 import { Field } from '../../provable/field.js';
 import { Int64, UInt64 } from '../../provable/int.js';
diff --git a/src/lib/ml/consistency.unit-test.ts b/src/lib/ml/consistency.unit-test.ts
@@ -1,4 +1,4 @@
-import { Test } from '../../snarky.js';
+import { Test } from '../../bindings.js';
 import { Random, test } from '../testing/property.js';
 import { Field, Bool } from '../provable/wrapped.js';
 import { PrivateKey, PublicKey } from '../provable/crypto/signature.js';
diff --git a/src/lib/ml/conversion.ts b/src/lib/ml/conversion.ts
@@ -2,7 +2,7 @@
  * this file contains conversion functions between JS and OCaml
  */
 
-import type { MlPublicKey, MlPublicKeyVar } from '../../snarky.js';
+import type { MlPublicKey, MlPublicKeyVar } from '../../bindings.js';
 import { HashInput } from '../provable/types/struct.js';
 import { Bool, Field } from '../provable/wrapped.js';
 import { FieldVar, FieldConst } from '../provable/core/fieldvar.js';
diff --git a/src/lib/proof-system/circuit.ts b/src/lib/proof-system/circuit.ts
@@ -1,7 +1,7 @@
 import 'reflect-metadata';
-import { Snarky, initializeBindings } from '../../snarky.js';
+import { Snarky, initializeBindings } from '../../bindings.js';
 import { MlFieldArray, MlFieldConstArray } from '../ml/fields.js';
-import { withThreadPool } from '../../snarky.js';
+import { withThreadPool } from '../../bindings.js';
 import { Provable } from '../provable/provable.js';
 import { snarkContext, gatesFromJson } from '../provable/core/provable-context.js';
 import { prettifyStacktrace, prettifyStacktracePromise } from '../util/errors.js';
diff --git a/src/lib/proof-system/feature-flags.ts b/src/lib/proof-system/feature-flags.ts
@@ -1,4 +1,4 @@
-import { MlFeatureFlags, Gate, GateType } from '../../snarky.js';
+import { MlFeatureFlags, Gate, GateType } from '../../bindings.js';
 import { MlBool, MlOption, MlArrayOptionalElements } from '../ml/base.js';
 import type { analyzeMethod } from './zkprogram.js';
 
diff --git a/src/lib/proof-system/proof-system.unit-test.ts b/src/lib/proof-system/proof-system.unit-test.ts
@@ -11,7 +11,7 @@ import {
 } from './zkprogram.js';
 import { Proof } from './proof.js';
 import { expect } from 'expect';
-import { Pickles, Snarky } from '../../snarky.js';
+import { Pickles, Snarky } from '../../bindings.js';
 import { AnyFunction } from '../util/types.js';
 import { snarkContext } from '../provable/core/provable-context.js';
 import { it } from 'node:test';
diff --git a/src/lib/proof-system/proof.ts b/src/lib/proof-system/proof.ts
@@ -1,5 +1,5 @@
-import { areBindingsInitialized, initializeBindings, withThreadPool } from '../../snarky.js';
-import { Pickles, Base64ProofString } from '../../snarky.js';
+import { areBindingsInitialized, initializeBindings, withThreadPool } from '../../bindings.js';
+import { Pickles, Base64ProofString } from '../../bindings.js';
 import { Field, Bool } from '../provable/wrapped.js';
 import type { FlexibleProvable, InferProvable } from '../provable/types/struct.js';
 import { FeatureFlags } from './feature-flags.js';
diff --git a/src/lib/proof-system/prover-keys.ts b/src/lib/proof-system/prover-keys.ts
@@ -9,7 +9,7 @@ import {
   WasmPastaFpPlonkIndex,
   WasmPastaFqPlonkIndex,
 } from '../../bindings/compiled/node_bindings/plonk_wasm.cjs';
-import { Pickles, wasm } from '../../snarky.js';
+import { Pickles, wasm } from '../../bindings.js';
 import { VerifierIndex } from '../../bindings/crypto/bindings/kimchi-types.js';
 import { getRustConversion } from '../../bindings/crypto/bindings.js';
 import { MlString } from '../ml/base.js';
diff --git a/src/lib/proof-system/verification-key.ts b/src/lib/proof-system/verification-key.ts
@@ -1,4 +1,4 @@
-import { initializeBindings, Pickles } from '../../snarky.js';
+import { initializeBindings, Pickles } from '../../bindings.js';
 import { synchronousRunners } from '../provable/core/provable-context.js';
 import { provable } from '../provable/types/provable-derivers.js';
 import { Struct } from '../provable/types/struct.js';
diff --git a/src/lib/proof-system/zkprogram.ts b/src/lib/proof-system/zkprogram.ts
@@ -5,8 +5,8 @@ import {
   Snarky,
   initializeBindings,
   withThreadPool,
-} from '../../snarky.js';
-import { Pickles, Gate } from '../../snarky.js';
+} from '../../bindings.js';
+import { Pickles, Gate } from '../../bindings.js';
 import { Field } from '../provable/wrapped.js';
 import { FlexibleProvable, InferProvable, ProvablePureExtended } from '../provable/types/struct.js';
 import { InferProvableType } from '../provable/types/provable-derivers.js';
diff --git a/src/lib/provable/bool.ts b/src/lib/provable/bool.ts
@@ -1,4 +1,4 @@
-import { Snarky } from '../../snarky.js';
+import { Snarky } from '../../bindings.js';
 import { Field, readVarMessage, withMessage } from './field.js';
 import { FieldVar, FieldConst, FieldType } from './core/fieldvar.js';
 import { defineBinable } from '../../bindings/lib/binable.js';
diff --git a/src/lib/provable/core/exists.ts b/src/lib/provable/core/exists.ts
@@ -1,4 +1,4 @@
-import { Snarky } from '../../../snarky.js';
+import { Snarky } from '../../../bindings.js';
 import { FieldConst, VarFieldVar } from './fieldvar.js';
 import type { VarField } from '../field.js';
 import { MlArray, MlOption } from '../../ml/base.js';
diff --git a/src/lib/provable/core/provable-context.ts b/src/lib/provable/core/provable-context.ts
@@ -1,5 +1,5 @@
 import { Context } from '../../util/global-context.js';
-import { Gate, GateType, JsonGate, Snarky, initializeBindings } from '../../../snarky.js';
+import { Gate, GateType, JsonGate, Snarky, initializeBindings } from '../../../bindings.js';
 import { parseHexString32 } from '../../../bindings/crypto/bigint-helpers.js';
 import { prettifyStacktrace } from '../../util/errors.js';
 import { Fp } from '../../../bindings/crypto/finite-field.js';
diff --git a/src/lib/provable/crypto/poseidon.ts b/src/lib/provable/crypto/poseidon.ts
@@ -1,5 +1,5 @@
 import { HashInput, ProvableExtended, Struct } from '../types/struct.js';
-import { Snarky } from '../../../snarky.js';
+import { Snarky } from '../../../bindings.js';
 import { Field } from '../wrapped.js';
 import { createHashHelpers } from './hash-generic.js';
 import { Provable } from '../provable.js';
diff --git a/src/lib/provable/field.ts b/src/lib/provable/field.ts
@@ -1,4 +1,4 @@
-import { Snarky } from '../../snarky.js';
+import { Snarky } from '../../bindings.js';
 import { Fp } from '../../bindings/crypto/finite-field.js';
 import { BinableFp, SignableFp } from '../../mina-signer/src/field-bigint.js';
 import { defineBinable } from '../../bindings/lib/binable.js';
diff --git a/src/lib/provable/gadgets/compatible.ts b/src/lib/provable/gadgets/compatible.ts
@@ -8,7 +8,7 @@ import { FieldVar } from '../core/fieldvar.js';
 import { assert } from './common.js';
 import { Gates } from '../gates.js';
 import { ScaledVar, emptyCell, reduceToScaledVar } from './basic.js';
-import { Snarky } from '../../../snarky.js';
+import { Snarky } from '../../../bindings.js';
 
 export {
   assertMulCompatible as assertMul,
diff --git a/src/lib/provable/gadgets/native-curve.ts b/src/lib/provable/gadgets/native-curve.ts
@@ -8,7 +8,7 @@ import { exists } from '../core/exists.js';
 import { assert, bit, bitSlice, isConstant } from './common.js';
 import { l, multiRangeCheck, rangeCheck64, rangeCheckLessThan64 } from './range-check.js';
 import { createBool, createBoolUnsafe, createField, getField } from '../core/field-constructor.js';
-import { Snarky } from '../../../snarky.js';
+import { Snarky } from '../../../bindings.js';
 import { Provable } from '../provable.js';
 import { MlPair } from '../../ml/base.js';
 import { provable } from '../types/provable-derivers.js';
diff --git a/src/lib/provable/gadgets/range-check.ts b/src/lib/provable/gadgets/range-check.ts
@@ -1,4 +1,4 @@
-import { Snarky } from '../../../snarky.js';
+import { Snarky } from '../../../bindings.js';
 import { Fp } from '../../../bindings/crypto/finite-field.js';
 import { BinableFp } from '../../../mina-signer/src/field-bigint.js';
 import type { Field } from '../field.js';
diff --git a/src/lib/provable/gates.ts b/src/lib/provable/gates.ts
@@ -1,4 +1,4 @@
-import { Snarky } from '../../snarky.js';
+import { Snarky } from '../../bindings.js';
 import type { Field } from './field.js';
 import { FieldVar, FieldConst } from './core/fieldvar.js';
 import { MlArray, MlTuple } from '../ml/base.js';
diff --git a/src/lib/provable/test/bitwise.unit-test.ts b/src/lib/provable/test/bitwise.unit-test.ts
@@ -18,7 +18,7 @@ import {
   and,
   withoutGenerics,
 } from '../../testing/constraint-system.js';
-import { GateType } from '../../../snarky.js';
+import { GateType } from '../../../bindings.js';
 
 const maybeField = {
   ...field,
diff --git a/src/lib/provable/test/foreign-field-gadgets.unit-test.ts b/src/lib/provable/test/foreign-field-gadgets.unit-test.ts
@@ -26,7 +26,7 @@ import {
   repeat,
   withoutGenerics,
 } from '../../testing/constraint-system.js';
-import { GateType } from '../../../snarky.js';
+import { GateType } from '../../../bindings.js';
 import { AnyTuple } from '../../util/types.js';
 import { foreignField, throwError, unreducedForeignField } from './test-utils.js';
 import { l2 } from '../gadgets/range-check.js';
diff --git a/src/lib/provable/types/unconstrained.ts b/src/lib/provable/types/unconstrained.ts
@@ -1,4 +1,4 @@
-import { Snarky } from '../../../snarky.js';
+import { Snarky } from '../../../bindings.js';
 import type { Field } from '../field.js';
 import type { Provable } from '../provable.js';
 import { assert } from '../../util/errors.js';
diff --git a/src/lib/testing/constraint-system.ts b/src/lib/testing/constraint-system.ts
@@ -4,7 +4,7 @@
  * An essential feature is that `constraintSystem()` automatically generates a
  * variety of fieldvar types for the inputs: constants, variables, and combinators.
  */
-import { Gate, GateType } from '../../snarky.js';
+import { Gate, GateType } from '../../bindings.js';
 import { randomBytes } from '../../bindings/crypto/random.js';
 import { Field } from '../provable/field.js';
 import { FieldType, FieldVar } from '../provable/core/fieldvar.js';
diff --git a/src/lib/util/base58.unit-test.ts b/src/lib/util/base58.unit-test.ts
@@ -1,5 +1,5 @@
 import { fromBase58Check, toBase58Check } from './base58.js';
-import { Test } from '../../snarky.js';
+import { Test } from '../../bindings.js';
 import { expect } from 'expect';
 import { test, Random, withHardCoded } from '../testing/property.js';
 
diff --git a/src/mina-signer/src/sign-zkapp-command.unit-test.ts b/src/mina-signer/src/sign-zkapp-command.unit-test.ts
@@ -22,7 +22,7 @@ import {
 import { Random, test, withHardCoded } from '../../lib/testing/property.js';
 import { PrivateKey, PublicKey } from './curve-bigint.js';
 import { hashWithPrefix, packToFields, prefixes } from './poseidon-bigint.js';
-import { Pickles, Test } from '../../snarky.js';
+import { Pickles, Test } from '../../bindings.js';
 import { Memo } from './memo.js';
 import { RandomTransaction } from './random-transaction.js';
 import {
diff --git a/src/mina-signer/src/signature.unit-test.ts b/src/mina-signer/src/signature.unit-test.ts
@@ -1,7 +1,7 @@
 // unit tests dedicated to testing consistency of the signature algorithm
 import { expect } from 'expect';
 import { sign, Signature, signFieldElement, verify, verifyFieldElement } from './signature.js';
-import { Test } from '../../snarky.js';
+import { Test } from '../../bindings.js';
 import { Field } from './field-bigint.js';
 import { PrivateKey, PublicKey } from './curve-bigint.js';
 import { PrivateKey as PrivateKeySnarky } from '../../lib/provable/crypto/signature.js';
diff --git a/src/mina-signer/src/transaction-hash.unit-test.ts b/src/mina-signer/src/transaction-hash.unit-test.ts
@@ -1,4 +1,4 @@
-import { Test } from '../../snarky.js';
+import { Test } from '../../bindings.js';
 import {
   Common,
   hashPayment,
diff --git a/tsconfig.node.json b/tsconfig.node.json
@@ -2,7 +2,7 @@
   "extends": "./tsconfig.json",
   "include": [
     "./src/index.ts",
-    "./src/snarky.js",
+    "./src/bindings.js",
     "./src/mina-signer/src",
     "./src/mina-signer/mina-signer.ts",
     "./src/js_crypto",
diff --git a/tsconfig.test.json b/tsconfig.test.json
@@ -1,6 +1,6 @@
 {
   "extends": "./tsconfig.json",
-  "include": ["./src/**/*.unit-test.ts", "./src/lib/**/*.ts", "./src/snarky.js"],
+  "include": ["./src/**/*.unit-test.ts", "./src/lib/**/*.ts", "./src/bindings.js"],
   "compilerOptions": {
     "outDir": "dist/node"
   }
diff --git a/tsconfig.web.json b/tsconfig.web.json
@@ -1,6 +1,6 @@
 {
   "extends": "./tsconfig.json",
-  "include": ["./src/index.ts", "./src/snarky.js", "./src/**/*.web.ts"],
+  "include": ["./src/index.ts", "./src/bindings.js", "./src/**/*.web.ts"],
   "compilerOptions": {
     "outDir": "dist/web"
   }

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ import { copyFromTo } from './utils.js';`
`3`	`3`
`4`	`4`	`await copyFromTo(`
`5`	`5`	`[`
`6`		`- 'src/snarky.d.ts',`
	`6`	`+ 'src/bindings.d.ts',`
`7`	`7`	`'src/bindings/compiled/_node_bindings',`
`8`	`8`	`'src/bindings/compiled/node_bindings/plonk_wasm.d.cts',`
`9`	`9`	`],`