Rebrand SnarkyJS to o1js (#481)

Author: ymekuria

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.11.2] - 2023-09-05
+
+### Changed
+
+- Update all instances of `SnarkyJS` to `o1js` throught the CLI to coincide with the rebrand of the package [#481](https://github.com/o1-labs/zkapp-cli/pull/481)    
+
 ## [0.11.1] - 2023-08-16
 
 ### Added
@@ -21,8 +27,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 - Release `0.11.0` [#459](https://github.com/o1-labs/zkapp-cli/pull/459)
-  - SnarkyJS minor version dependency updated in cli package.json to 0.12.\*.
-  - SnarkyJS minor version peer dependency updated in template/example contract package.json to 0.12.\*.
+  - o1js minor version dependency updated in cli package.json to 0.12.\*.
+  - o1js minor version peer dependency updated in template/example contract package.json to 0.12.\*.
 
 ## [0.10.2] - 2023-07-09
 
@@ -62,8 +68,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 - Release `0.9.0` [#426](https://github.com/o1-labs/zkapp-cli/pull/426)
-  - SnarkyJS minor version dependency updated in cli package.json to 0.11.\*.
-  - SnarkyJS minor version peer dependency updated in template/example contract package.json to 0.11.\*.
+  - o1js minor version dependency updated in cli package.json to 0.11.\*.
+  - o1js minor version peer dependency updated in template/example contract package.json to 0.11.\*.
   - Replace deprecated `Circuit.if` with `Provable.if` in the `tictactoe` example.
   - Replace deprecated `Circuit.array` with `Provable.Array` in the `sudoku` example.
 
@@ -87,7 +93,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
   - Remove deprecated isReady and shutdown from cli, template/examples contracts, and UI scaffolds for each supported framework.
   - Add state.getAndAssertEquals() to examples and test contracts.
-  - Configure UI scaffolds for NextJS, Svelte, and Nuxt to support top-level await used in the latest SnarkyJS release.
+  - Configure UI scaffolds for NextJS, Svelte, and Nuxt to support top-level await used in the latest o1js release.
   - Exit the cli config and deploy processes on success and error.
   - Increase the template/example project jest test timeout.
 
@@ -127,23 +133,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- Updates the template projects to use the SnarkyJS version of `0.9.*`. [#376](https://github.com/o1-labs/zkapp-cli/pull/376)
+- Updates the template projects to use the o1js version of `0.9.*`. [#376](https://github.com/o1-labs/zkapp-cli/pull/376)
 
 ## [0.7.2] - 2023-03-07
 
 ### Changed
 
-- Upgraded SnarkyJS to `0.9.2`. [#367](https://github.com/o1-labs/zkapp-cli/pull/367)
+- Upgraded o1js to `0.9.2`. [#367](https://github.com/o1-labs/zkapp-cli/pull/367)
 
 ## [0.7.1] - 2023-02-27
 
-- Update for snarkyjs state getting fix. [#367](https://github.com/o1-labs/zkapp-cli/pull/367)
+- Update for o1js state getting fix. [#367](https://github.com/o1-labs/zkapp-cli/pull/367)
 
 ## [0.7.0] - 2023-02-14
 
 ### Changed
 
-- Upgraded SnarkyJS to `0.9.0`. [#367](https://github.com/o1-labs/zkapp-cli/pull/367)
+- Upgraded o1js to `0.9.0`. [#367](https://github.com/o1-labs/zkapp-cli/pull/367)
 
 ## [0.6.3] - 2023-02-14
 
@@ -169,13 +175,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- Upgraded SnarkyJS to `0.8.0`. [#349](https://github.com/o1-labs/zkapp-cli/pull/347)
+- Upgraded o1js to `0.8.0`. [#349](https://github.com/o1-labs/zkapp-cli/pull/347)
 
 ## [0.5.5] - 2023-01-011
 
 ### Changed
 
-- Fix to show SnarkyJS version with `zk system` command. [#349](https://github.com/o1-labs/zkapp-cli/pull/349)
+- Fix to show o1js version with `zk system` command. [#349](https://github.com/o1-labs/zkapp-cli/pull/349)
 - Allow '.js' imports to work in Jest. [#339](https://github.com/o1-labs/zkapp-cli/pull/339)
 - Minor fix to exit the cli process after generating a new project. [#330](https://github.com/o1-labs/zkapp-cli/pull/330)
 
@@ -195,28 +201,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- Fix template contract, add interaction script, and upgrade to SnarkyJS `0.7.3`. [#320](https://github.com/o1-labs/zkapp-cli/pull/320)
+- Fix template contract, add interaction script, and upgrade to o1js `0.7.3`. [#320](https://github.com/o1-labs/zkapp-cli/pull/320)
 - Fix tictactoe example. [#318](https://github.com/o1-labs/zkapp-cli/pull/318)
 
 ## [0.5.2]
 
 ### Changed
 
-- Upgraded SnarkyJS to `0.7.2` [#316](https://github.com/o1-labs/zkapp-cli/pull/316)
+- Upgraded o1js to `0.7.2` [#316](https://github.com/o1-labs/zkapp-cli/pull/316)
 - Fix Sudoku and enable CLI to create init() proofs. [#315](https://github.com/o1-labs/zkapp-cli/pull/315)
 
 ## [0.5.1]
 
 ### Changed
 
-- Upgraded SnarkyJS to `0.7.1`. [#309](https://github.com/o1-labs/zkapp-cli/pull/309)
+- Upgraded o1js to `0.7.1`. [#309](https://github.com/o1-labs/zkapp-cli/pull/309)
 - Fix GraphQL error handling. [#307](https://github.com/o1-labs/zkapp-cli/pull/307/files)
 
 ## [0.5.0]
 
 ### Changed
 
-- Upgraded SnarkyJS to `0.7.0`. [#306](https://github.com/o1-labs/zkapp-cli/pull/306)
+- Upgraded o1js to `0.7.0`. [#306](https://github.com/o1-labs/zkapp-cli/pull/306)
 - Update tsconfig ES target. [#303](https://github.com/o1-labs/zkapp-cli/pull/303)
 
 ### Added
@@ -242,7 +248,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
   - Add an option to NextJS to set it up for github pages. [#292](https://github.com/o1-labs/zkapp-cli/pull/292)
   - Import a smart contract into the NextJS UI project scaffold. [#290](https://github.com/o1-labs/zkapp-cli/pull/290)
-  - Fixes to the NextJS project for snarkyjs + typescript. [#287](https://github.com/o1-labs/zkapp-cli/pull/287)
+  - Fixes to the NextJS project for o1js + typescript. [#287](https://github.com/o1-labs/zkapp-cli/pull/287)
   - Add a NextJS typescript prompt. [#285](https://github.com/o1-labs/zkapp-cli/pull/285)
   - Add COOP & COEP headers for SvelteKit, NextJS, & NuxtJS. [#279](https://github.com/o1-labs/zkapp-cli/pull/279)
   - Working mvp of UI monorepo. [#266](https://github.com/o1-labs/zkapp-cli/pull/266)
@@ -265,8 +271,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- Upgraded SnarkyJS to `0.6.0`. [#249](https://github.com/o1-labs/zkapp-cli/pull/249)
-- Renamed the references of Party to AccountUpdate and parties to zkappCommand in CLI and template/examples to match changes in Mina Protocol and SnarkyJS.
+- Upgraded o1js to `0.6.0`. [#249](https://github.com/o1-labs/zkapp-cli/pull/249)
+- Renamed the references of Party to AccountUpdate and parties to zkappCommand in CLI and template/examples to match changes in Mina Protocol and o1js.
 
 ## [0.4.7] - 2022-06-14
 
@@ -277,7 +283,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- Upgraded SnarkyJS to `0.4.1`. [#207](https://github.com/o1-labs/zkapp-cli/pull/207)
+- Upgraded o1js to `0.4.1`. [#207](https://github.com/o1-labs/zkapp-cli/pull/207)
 - Renamed the deploy parameter `network` to `alias`. [#218](https://github.com/o1-labs/zkapp-cli/pull/218)
 - Updated template and example file structure to support publishing to npm. [#213](https://github.com/o1-labs/zkapp-cli/pull/213)
 - Fixed bug with CI not cleaning up node_modules after testing. [#219](https://github.com/o1-labs/zkapp-cli/pull/219)

CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 Welcome to the Mina zkApp CLI open source repository. Thank you for being a part of the Mina ecosystem and for your interest in contributing to the Mina zkApp CLI project.
 
-SnarkyJS helps developers build apps powered by zero-knowledge (zk) cryptography. The best way to get started with SnarkyJS is to use the Mina zkApp CLI to [write a zkApp](https://docs.minaprotocol.com/zkapps/how-to-write-a-zkapp).
+o1js helps developers build apps powered by zero-knowledge (zk) cryptography. The best way to get started with o1js is to use the Mina zkApp CLI to [write a zkApp](https://docs.minaprotocol.com/zkapps/how-to-write-a-zkapp).
 
 The best way to contribute to the Mina zkApp CLI is to help us test it broadly to ensure it works as expected on all platforms.
 

README.md

@@ -2,7 +2,7 @@
 
 The Mina zkApp CLI allows you to scaffold, write, test, and deploy zkApps (zero knowledge apps) for [Mina Protocol](https://minaprotocol.com/) using recommended best practices.
 
-Apps are written using [SnarkyJS](https://docs.minaprotocol.com/en/zkapps/snarkyjs-reference), a TypeScript framework for writing zero knowledge proof-based smart contracts. SnarkyJS is automatically included when you create a project using the Mina zkApp CLI.
+Apps are written using [o1js](https://docs.minaprotocol.com/en/zkapps/o1js-reference), a TypeScript framework for writing zero knowledge proof-based smart contracts. o1js is automatically included when you create a project using the Mina zkApp CLI.
 
 ## Getting Started
 
@@ -44,7 +44,7 @@ $ npm update -g zkapp-cli
 
 ### Dependencies
 
-To use the zkApp CLI and SnarkyJS, your environment requires:
+To use the zkApp CLI and o1js, your environment requires:
 
 - NodeJS v16 and later
 - NPM v8 and later

examples/sudoku/ts/src/run.ts

@@ -11,7 +11,7 @@
  */
 import { Sudoku, SudokuZkApp } from './sudoku.js';
 import { cloneSudoku, generateSudoku, solveSudoku } from './sudoku-lib.js';
-import { AccountUpdate, Mina, PrivateKey } from 'snarkyjs';
+import { AccountUpdate, Mina, PrivateKey } from 'o1js';
 
 // setup
 const Local = Mina.LocalBlockchain();

examples/sudoku/ts/src/sudoku.test.ts

@@ -1,6 +1,6 @@
 import { Sudoku, SudokuZkApp } from './sudoku';
 import { cloneSudoku, generateSudoku, solveSudoku } from './sudoku-lib';
-import { PrivateKey, PublicKey, Mina, AccountUpdate } from 'snarkyjs';
+import { PrivateKey, PublicKey, Mina, AccountUpdate } from 'o1js';
 
 describe('sudoku', () => {
   let zkApp: SudokuZkApp,

examples/sudoku/ts/src/sudoku.ts

@@ -8,7 +8,7 @@ import {
   Poseidon,
   Struct,
   Provable,
-} from 'snarkyjs';
+} from 'o1js';
 
 export { Sudoku, SudokuZkApp };
 

examples/tictactoe/ts/src/run.ts

@@ -17,7 +17,7 @@ import {
   Mina,
   AccountUpdate,
   Signature,
-} from 'snarkyjs';
+} from 'o1js';
 import { TicTacToe, Board } from './tictactoe.js';
 
 let Local = Mina.LocalBlockchain({ proofsEnabled: false });

examples/tictactoe/ts/src/tictactoe.test.ts

@@ -7,7 +7,7 @@ import {
   Mina,
   AccountUpdate,
   Signature,
-} from 'snarkyjs';
+} from 'o1js';
 
 describe('tictactoe', () => {
   let player1: PublicKey,

examples/tictactoe/ts/src/tictactoe.ts

@@ -13,7 +13,7 @@ import {
   Provable,
   Signature,
   Struct,
-} from 'snarkyjs';
+} from 'o1js';
 
 export { Board, TicTacToe };