StarGate Contracts

//        ✦     *        .         ✶         *        .       ✦       .
//  ✦   _______..___________.    ___      .______        _______      ___   .___________. _______   ✦
//     /       ||           |   /   \     |   _  \      /  _____|    /   \  |           ||   ____|  *
//    |   (----``---|  |----`  /  ^  \    |  |_)  |    |  |  __     /  ^  \ `---|  |----`|  |__      .
//     \   \        |  |      /  /_\  \   |      /     |  | |_ |   /  /_\  \    |  |     |   __|     ✶
// .----)   |       |  |     /  _____  \  |  |\  \----.|  |__| |  /  _____  \   |  |     |  |____   *
// |_______/        |__|    /__/     \__\ | _| `._____| \______| /__/     \__\  |__|     |_______|  ✦
//         *       .      ✦      *      .        ✶       *      ✦       .       *        ✶

This package contains all the types and artifacts of the StarGate contracts (StargateNFT, StargateDelegation, NodeManagementV3, etc.) so you do not need to manually import the ABI files and you can have full types support in your queries / clause building.

Installation:

yarn add @vechain/stargate-contracts-artifacts

or

npm install @vechain/stargate-contracts-artifacts

Usage (with SDK):

import { StargateNFT__factory } from "@vechain/stargate-contracts-artifacts";

const res = await thor.contracts
  .load(stargateContractAddress, StargateNFT__factory.abi)
  .read.balanceOf(address);

Usage (JSON Artifacts)

You should be also able to get the JSON artifacts from this package

import * as StargateNFTArtifact from "@vechain/stargate-contracts-artifacts/artifacts/contracts/StargateNFT.sol/StargateNFT.json";

Multiple versions

This package will pull the latest version of the contracts. If you want to use a specific version, you can install it by appending @{version} to the package name.

For example, to install version 1.0.0:

yarn add @vechain/[email protected]

or

npm install @vechain/[email protected]

If you want to install multiple versions at the same time, you can add them like this in your package.json:

{
  "@vechain/stargate-contracts-artifacts-1-0-0": "npm:@vechain/[email protected]",
  "@vechain/stargate-contracts-artifacts-2-0-0": "npm:@vechain/[email protected]",
  "@vechain/stargate-contracts-artifacts-3-0-0": "npm:@vechain/[email protected]"
}

Then in your code you can import the contracts like this:

import { StargateNFT__factory as StargateNFTV1__factory } from "@vechain/stargate-contracts-artifacts-1-0-0";
import { StargateNFT__factory as StargateNFTV2__factory } from "@vechain/stargate-contracts-artifacts-2-0-0";

This way all the version can be accesed from the same project.

Checkout the release notes to see the changes between versions

Release notes