@algorandfoundation/xgov

This is an npm package that provides a set of tools to interact with the xGov smart contracts. The workflow is automated and dispatched from the xgov-beta-sc repository. The workflow can also be triggered manually.

The package has three modules it exports, Proposal, XGovRegistry and Council. These are typed clients generated from the smart contract's ARC-56 ABI definition. This repository simply handles the generation and packaging of the artifacts.

Installation

npm install @algorandfoundation/xgov --save

Usage

Proposal

import { ProposalClient } from '@algorandfoundation/xgov';

Registry

import { XGovRegistryClient } from '@algorandfoundation/xgov';

Contributing

Ensure you have Node.js and Algokit installed on your machine.

Clone the project

git clone [email protected]:algorandfoundation/xgov-beta-ts.git

Ensure submodule is up to date

git submodule update --init --recursive

Install dependencies

npm install

Build the project

npm run build