Skip to content

Latest commit

 

History

History
69 lines (44 loc) · 2.38 KB

README.md

File metadata and controls

69 lines (44 loc) · 2.38 KB
Raw

Agoric Platform Extension for Visual Studio Code

This extension automates the installation and setup of Agoric SDK for DeFi development in JavaScript.

It assits in setting up your environment for building and deploying secure DeFi on Agoric - a Proof-of-Stake chain, with composable JavaScript Smart Contracts.

Prerequisites

  • Node.js LTS (version 14.15.0 or higher)
  • node-gyp (you can check for this by running node-gyp help in your terminal)
  • Yarn (npm install -g yarn)

Platform specific requirements are found at the Agoric SDK repo

Installation

  1. Open the Extensions sidebar in VS Code. View → Extensions
  2. Search for Agoric, choose "Agoric" by danbmky
  3. Click Install to install it

This Extension is now available on Gitpod and Github Codespaces

Options

agoric.autoUpdate

By default, on startup, Agoric checks for SDK updates and updates the version locally. If you want to opt out of this, set the agoric.autoUpdate option to false. Eg:

{
  "agoric.autoUpdate": false
}

agoric.installDir

By default, this extension clones the Agoric SDK into the home directory. Configure a custom directory to clone the SDK into by changing the field. Eg:

{
  "agoric.installDir": "/another-path"
}

Keyboard Shortcuts

  • CTRL/CMD + Shift + A : Checks for SDK updates then installs & setups the new Agoric SDK version.

Viewing Debug logs

You can view the debug logs of the setup in the 'Agoric' output channel by:

  • pressing CTRL/CMD + Shift + U on your keyboard
  • switching to the Agoric output channel as seen in the image below: image of the agoric vscode extension output channel

Running this extension locally

  • Clone this repo
  • Cd into the project folder
  • Install the project dependencies
  • Type F5 then choose 'Run Extension' to interact with the extension or choose 'Extension Tests' to Run the extension integration tests.

Created by Dan Bamikiya. Go follow me on Twitter!

LICENSE

Agoric Extension is released under the Apache License 2.0