Skip to content

Latest commit

 

History

History
65 lines (37 loc) · 2.27 KB

README.md

File metadata and controls

65 lines (37 loc) · 2.27 KB
Raw

Axiom-VScode

A VS code extension designed for Axiom. You can use this extension to compile a circuit and prove & send queries.

Features

Axiom-VScode offers a user-friendly view for managing your Axiom circuit and its queries.

Managing Circuits

Circuits are loaded from a specified location using a customizable glob pattern in the extension settings. The circuit name is extracted from the circuit file.

Compile a Circuit

Compilation requires that the defaultInputs be exported from the circuit file.

The output will be written to the directory set in the extension settings.

Managing Queries

Queries are managed by Axiom-VScode and saved to the VS code workspace state.

Add a query

Proving queries

You must compile the circuit and set the query input file before proving.

You must also set PROVIDER_URI_SEPOLIA in the config file defined in the extension settings.

Sending queries

You must set the callback address before sending.

You must also set PRIVATE_KEY_SEPOLIA in the config file defined in the extension settings.

Setup

# install dependencies
yarn install
# typescript compile
yarn compile

Running/Debugging the Extension

Run the extension by using the Run and Debug tab in VS code. This will create a new VS code window where you can open a new workspace folder. Use the axiom-quickstart project for testing.

Note: You may need to run yarn recompile for changes to reflect.

Extension Settings

This extension contributes the following settings:

  • axiom.configFilePath: File in which PRIVATE_KEY_SEPOLIA and PROVIDER_URI_SEPOLIA are defined. Default is .env.
  • axiom.circuitFilesPattern: Glob pattern to used to automatically discover files containing circuit definitions. Default is **/axiom/**/*.ts.
  • axiom.buildDirectory: Path where circuit outputs from compiled circuits will be written. Default is build/axiom.