README.md

Starknet Hardhat Plugin

If you've used Hardhat 👷‍♀️👷‍♂️ and want to develop for Starknet , this plugin might come in hand. If you've never set up a Hardhat project, check out this guide.

Contents

• Install
• CLI commands
• API
• Testing
  • Important notes
  • Examples
  • Devnet examples
• Configure the plugin
• Account support
• More examples
• Contribute

Install

npm i @shardlabs/starknet-hardhat-plugin --save-dev

Add the following line to the top of your hardhat.config.ts (or hardhat.config.js):

import "@shardlabs/starknet-hardhat-plugin";
// or
require("@shardlabs/starknet-hardhat-plugin");

Requirements

This plugin was tested with:

• Node.js v14.17.3
• npm/npx v7.19.1
• Docker v20.10.8 (optional):
  • Since plugin version 0.3.4, Docker is no longer necessary if you opt for a Python environment (more info in Config).
  • If you opt for the containerized version, make sure you have a running Docker daemon.
  • If you're experiencing Docker access issues, check this.
• Linux / macOS:
  • On Windows, we recommend using WSL 2.

CLI commands

This plugin defines the following Hardhat commands (also called tasks):

starknet-compile

npx hardhat starknet-compile [PATH...] [--cairo-path "<LIB_PATH1>:<LIB_PATH2>:..."] [--account-contract] [--disable-hint-validation]

If no paths are provided, all Starknet contracts in the default contracts directory are compiled. Paths can be files and directories.

--cairo-path allows specifying the locations of imported files, if necessary. Separate them with a colon (:), e.g. --cairo-path='path/to/lib1:path/to/lib2'

--account-contract allows compiling an account contract.

--disable-hint-validation allows compiling a contract without hint validation (any python code is allowed in hints, ex: print ...).

starknet-deploy

npx hardhat starknet-deploy [--starknet-network <NAME>] [--wait] [--gateway-url <URL>] [ARTIFACT_PATH...] [--inputs <CONSTRUCTOR_ARGUMENTS>] [--salt <SALT>]

If no paths are provided, all Starknet artifacts from the default artifacts directory are deployed. Paths can be files and directories.

If you're passing constructor arguments, pass them space separated, but as a single string (due to limitations of the plugin system).

If the --wait flag is passed, the task will wait until the transaction status of the deployment is one of (PENDING, ACCEPTED_ON_L2, ACCEPTED_ON_L1).

The --salt parameter should be a hex string which, when provided, causes the contract to always be deployed to the same address.

The --token parameter indicates that your deployment is whitelisted on alpha-mainnet.

Notice that this plugin relies on --starknet-network (or STARKNET_NETWORK environment variable) and not on Hardhat's --network. So if you define

module.exports = {
    networks: {
        myNetwork: {
            url: "http://127.0.0.1:5050"
        }
    }
};

you can use it by calling npx hardhat starknet-deploy --starknet-network myNetwork.

The Alpha networks and integrated Devnet are available by default, you don't need to define them in the config file; just pass:

• --starknet-network alpha or --starknet-network alpha-goerli for Alpha Testnet (on Goerli)
• --starknet-network alpha-mainnet for Alpha Mainnet
• --starknet-network integrated-devnet for integrated Devnet

npx hardhat starknet-deploy starknet-artifacts/contract.cairo/ --inputs "1 2 3"

You would typically use the input feature when deploying a single contract requiring constructor arguments. If you are deploying multiple contracts, they'll all use the same input.

starknet-verify

npx hardhat starknet-verify [--starknet-network <NAME>] [--path <PATH>] [<DEPENDENCY_PATH> ...] [--address <CONTRACT_ADDRESS>] [--compiler-version <COMPILER_VERSION>] [--license <LICENSE_SCHEME>] [--contract-name <CONTRACT_NAME>] [--acount-contract <BOOLEAN>]

Queries Voyager to verify the contract deployed at <CONTRACT_ADDRESS> using the source files at <PATH> and any number of <DEPENDENCY_PATH>.

Like in the previous command, this plugin relies on --starknet-network, but will default to 'alpha' network in case this parameter is not passed.

The verifier expects <COMPILER_VERSION> to be passed on request. Supported compiler versions are listed here in the dropdown menu.

We pass --acount-contract to tell the verifier that the contract is of type account.

For <LICENSE_SCHEME> the command takes No License (None) as default license scheme. Here is a list of available options.

starknet-deploy-account

npx hardhat starknet-deploy-account [--starknet-network <NAME>] [--wallet <WALLET_NAME>]

Deploys the wallet wallets["WALLET_NAME"] configured in the hardhat.config file

npx hardhat starknet-deploy-account --starknet-network myNetwork --wallet MyWallet

starknet-invoke

npx hardhat starknet-invoke [--starknet-network <NAME>] [--gateway-url <URL>] [--contract <CONTRACT_NAME>] [--address <CONTRACT_ADDRESS>] [--function <FUNCTION_NAME>] [--inputs <FUNCTION_INPUTS>] [--signature <INVOKE_SIGNATURE>] [--wallet <WALLET_NAME>]

Invokes a function on the target contract. If the function takes any inputs, they should be passed as a single string, separated by space. If the wallet argument is passed, the wallet wallets["WALLET_NAME"] configured in the hardhat.config file will be used. If omitted, the Starknet argument --no_wallet will be used by default.

npx hardhat starknet-invoke --starknet-network myNetwork --contract contract --function increase_balance --address $CONTRACT_ADDRESS --inputs "10 20" --wallet MyWallet

starknet-call

npx hardhat starknet-call [--starknet-network <NAME>] [--gateway-url <URL>] [--contract <CONTRACT_NAME>] [--address <CONTRACT_ADDRESS>] [--function <FUNCTION_NAME>] [--inputs <FUNCTION_INPUTS>] [--signature <INVOKE_SIGNATURE>] [--wallet <WALLET_NAME>] [--block-number <BLOCK_NUMBER>]

Calls a function on the target contract and returns its return value. If the function takes any inputs, they should be passed as a single string, separated by space. The pending block will always be queried by default, and if there's no pending block, the default behaviour is to query the last block. Using the --block-number argument will query the specified block. If the wallet argument is passed, the wallet wallets["WALLET_NAME"] configured in the hardhat.config file will be used. If omitted, the Starknet argument --no_wallet will be used by default.

npx hardhat starknet-call --starknet-network myNetwork --contract contract --function sum_points_to_tuple --address $CONTRACT_ADDRESS --inputs "10 20 30 40"

starknet-estimate-fee

npx hardhat starknet-estimate-fee [--starknet-network <NAME>] [--gateway-url <URL>] [--contract <CONTRACT_NAME>] [--address <CONTRACT_ADDRESS>] [--function <FUNCTION_NAME>] [--inputs <FUNCTION_INPUTS>] [--signature <INVOKE_SIGNATURE>] [--wallet <WALLET_NAME>] [--block-number <BLOCK_NUMBER>]

Estimates the gas fee of a function execution.

run

No CLI options introduced to the original hardhat run, but a starknet network can be specified using the config file. See Runtime network.

test

Introduces the --starknet-network option to the existing hardhat test task.

API

Adding this plugin to your project expands Hardhat's runtime with a starknet object. It can be imported with:

import { starknet } from "hardhat";
// or
const starknet = require("hardhat").starknet;

To see all the utilities introduced by the starknet object, check this out.

Testing

Relying on the above described API makes it easier to interact with your contracts and test them.

To test Starknet contracts with Mocha, use the regular Hardhat test task which expects test files in your designated test directory:

npx hardhat test

Read more about the network used in tests in the Runtime network section. These examples are inspired by the official Starknet Python tutorial.

Important notes

• BigInt is used because felt may be too big for javascript. Use it like BigInt("10") or, since ES2020, like 10n.
• All function names, argument names and return value names should be referred to by the names specified in contract source files.
• The argument of getContractFactory is the name or the path of the source of the target contract:
  • if providing a path, it should be relative to the project root or the contracts directory:
    • getContractFactory("contracts/subdir/MyContract.cairo")
    • getContractFactory("subdir/MyContract.cairo")
  • the extension can be omitted:
    • getContractFactory("subdir/MyContract")
    • getContractFactory("MyContract")

Test examples

Setup

import { expect } from "chai";
import { starknet } from "hardhat";
// or
const expect = require("chai").expect;
const starknet = require("hardhat").starknet;

describe("My Test", function () {
  this.timeout(300_000); // 5 min - recommended if used with Alpha testnet (alpha-goerli)
  // this.timeout(30_000); // 30 seconds - recommended if used with starknet-devnet

Deploy / load contract

  /**
   * Assumes there is a file MyContract.cairo whose compilation artifacts have been generated.
   * The contract is assumed to have:
   * - constructor function constructor(initial_balance: felt)
   * - external function increase_balance(amount: felt) -> (res: felt)
   * - view function get_balance() -> (res: felt)
   */
  it("should work with old-style deployment", async function () {
    const contractFactory = await starknet.getContractFactory("MyContract");

    await contract.invoke("increase_balance", { amount: 10 }); // invoke method by name and pass arguments by name
    await contract.invoke("increase_balance", { amount: BigInt("20") });

    const { res } = await contract.call("get_balance"); // call method by name and receive the result by name
    expect(res).to.deep.equal(BigInt(40)); // you can also use 40n instead of BigInt(40)
  });

  it("should load a previously deployed contract", async function () {
    const contractFactory = await starknet.getContractFactory("MyContract");
    const contract = contractFactory.getContractAt("0x123..."); // address of a previously deployed contract
  });

  it("should declare and deploy", async function() {
    const contractFactory = await starknet.getContractFactory("MyContract");
    const classHash = await contractFactory.declare();

    // You are expected to have a Deployer contract with a deploy method
    const deployer = await starknet.getContractFactory("Deployer");
    const account = await starknet.getAccountFromAddress(...);
    const opts = { maxFee: BigInt(...) };
    const txHash = await account.invoke(deployer, "my_deploy", { class_hash: classHash }, opts);
    const deploymentAddress = ...; // get the address, e.g. from an event emitted by deploy
    const contract = contractFactory.getContractAt(deploymentAddress);
  });

Arrays

/**
 * Assumes there is a file MyContract.cairo whose compilation artifacts have been generated.
 * The contract is assumed to have:
 * - view function sum_array(a_len: felt, a: felt*) -> (res: felt)
 */
it("should work with arrays", async function () {
    const contractFactory = await starknet.getContractFactory("MyContract");
    const contract = await contractFactory.deploy(); // no constructor -> no constructor arguments
    const { res } = await contract.call("sum_array", { a: [1, 2, 3] });
    expect(res).to.deep.equal(BigInt(6));
});

Tuples

/**
 * Assumes there is a file MyContract.cairo whose compilation artifacts have been generated.
 * The contract is assumed to have:
 * - view function sum_pair(pair: (felt, felt)) -> (res : felt)
 * - view func sum_named_pair(pair : (x : felt, y : felt) -> (res : felt)
 * - using PairAlias = (x : felt, y : felt)
 * - view func sum_type_alias(pair : PairAlias) -> (res : felt)
 */
it("should work with tuples", async function () {
    const contractFactory = await starknet.getContractFactory("MyContract");
    const contract = await contractFactory.deploy();
    // notice how the pair tuple is passed as javascript array
    const { res } = await contract.call("sum_pair", { pair: [10, 20] });
    expect(res).to.deep.equal(BigInt(30));
    ... = await contract.call("sum_named_pair", { pair: { x: 10, y: 20 } });
    ... = await contract.call("sum_type_alias", { pair: { x: 10, y: 20 } });
});

Accounts

More detailed documentation can be found here.

  /**
   * Assumes there is a file MyContract.cairo, together with OpenZeppelin Account.cairo file and its dependencies.
   * Assumes their compilation artifacts have been generated.
   * MyContract is assumed to have:
   * - external function increase_balance(amount: felt) -> ()
   * - view function get_balance() -> (res: felt)
   */
  it("should succeed when using the account to invoke a function on another contract", async function() {
    const contractFactory = await starknet.getContractFactory("MyContract");
    const contract = await contractFactory.deploy()

    const account = await starknet.deployAccount("OpenZeppelin");
    // or
    const account = await starknet.getAccountFromAddress(accountAddress, process.env.PRIVATE_KEY, "OpenZeppelin");
    console.log("Account:", account.address, account.privateKey, account.publicKey);

    const { res: currBalance } = await account.call(contract, "get_balance");
    const amount = BigInt(10);
    // Passing max_fee is currently optional
    await account.invoke(contract, "increase_balance", { amount }, { maxFee: BigInt("123") });

    const { res: newBalance } = await account.call(contract, "get_balance");
    expect(newBalance).to.deep.equal(currBalance + amount);
  });
});

Fee estimation

it("should estimate fee", async function () {
    const fee = await contract.estimateFee("increase_balance", { amount: 10n });
    console.log("Estimated fee:", fee.amount, fee.unit, fee.gas_price, fee.gas_amount);
});

Transaction information and receipt with events

it("should return transaction data and transaction receipt", async function () {
    const contract: StarknetContract = await contractFactory.deploy();
    console.log("Deployment transaction hash:", contract.deployTxHash);

    const transaction = await starknet.getTransaction(contract.deployTxHash);
    console.log(transaction);

    const txHash = await contract.invoke("increase_balance", { amount: 10 });

    const receipt = await starknet.getTransactionReceipt(txHash);
    const decodedEvents = await contract.decodeEvents(receipt.events);
    // decodedEvents contains hex data array converted to a structured object
    // { name: "increase_balance_called", data: { current_balance: 0n, amount: 10n } }
});

For more usage examples, including tuple, array and struct support, as well as wallet support, check sample-test.ts of starknet-hardhat-example.

Devnet examples

L1-L2 communication (Postman message exchange with Devnet)

Exchanging messages between L1 (Ganache, Hardhat node, Ethereum testnet) and L2 (only supported for starknet-devnet) can be done using this plugin:

• Ensure there is an available L1 network and that you know its RPC endpoint URL.
• Load an L1 Messaging contract using starknet.devnet.loadL1MessagingContract.
• Call starknet.devnet.flush after you invoke your contract and want to propagate your message.
• When running a hardhat test or script which relies on network["config"], specify the name of an L1 network you defined in hardhat.config. Use npx hardhat test --network <NETWORK_NAME>. Network localhost is predefined in hardhat so --network localhost should work if you're using e.g. npx hardhat node as the L1 network.
• Check this example for more info.

  it("should exchange messages with Devnet", async function() {
    await starknet.devnet.loadL1MessagingContract(...);
    const l1contract = ...;
    const l2contract = ...;

    await l1contract.send(...); // depending on your L1 contract interaction library
    await starknet.devnet.flush();

    await l2contract.invoke(...);
    await starknet.devnet.flush();
  });

Restart

Devnet can be restarted by calling starknet.devnet.restart(). All of the deployed contracts, blocks and storage updates will be restarted to the empty state.

await starknet.devnet.restart();

Dumping

Use starknet.devnet.dump() to maintain the Devnet instance from the plugin.

await starknet.devnet.dump(path); // path to dump file (eg. dump.pkl)

Loading

Dumped Devnet instance can be loaded using starknet.devnet.load().

await starknet.devnet.load(path); // path for dump file (eg. dump.pkl)

Advancing time

The plugin comes with support for Devnet's timestamp management. The time offset for each generated block can be increased by calling starknet.devnet.increaseTime(). The time for the next block can be set by calling starknet.devnet.setTime(), with subsequent blocks keeping the set offset.

Warning: block time can be set in the past and lead to unexpected behaviour!

await starknet.devnet.setTime(1000); // time in seconds
await starknet.devnet.increaseTime(1000); // time in seconds

Configure the plugin

Specify custom configuration by editing your project's hardhat.config.ts (or hardhat.config.js).

Cairo version

Use this configuration option to select the cairo-lang/starknet version used by the underlying Docker container.

A Docker image tailored to the machine will be pulled. The -arm suffix will be applied to the version name, if it's not applied on hardhat.config.ts, if the device's architecture is arm64. (e.g. dockerizedVersion: "0.8.1-arm" and dockerizedVersion: "0.8.1" both will work).

If you specify neither dockerizedVersion nor venv, the latest dockerized version is used.

A list of available dockerized versions can be found here.

module.exports = {
  starknet: {
    dockerizedVersion: "0.8.1"
  }
  ...
};

Existing virtual environment

If you want to use an existing Python virtual environment (pyenv, poetry, conda, miniconda), specify it by using starknet["venv"].

To use the currently activated environment (or if you have the starknet commands globally installed), set venv to "active".

If you specify neither dockerizedVersion nor venv, the latest dockerized version is used.

module.exports = {
    starknet: {
        // venv: "active" <- for the active virtual environment
        // venv: "path/to/my-venv" <- for env created with e.g. `python -m venv path/to/my-venv`
        venv: "<VENV_PATH>"
    }
};

Paths

module.exports = {
  paths: {
    // Defaults to "contracts" (the same as `paths.sources`).
    starknetSources: "my-own-starknet-path",

    // Defaults to "starknet-artifacts".
    // Has to be different from the value set in `paths.artifacts` (which is used by core Hardhat and has a default value of `artifacts`).
    starknetArtifacts: "also-my-own-starknet-path",

   // Same purpose as the `--cairo-path` argument of the `starknet-compile` command
   // Allows specifying the locations of imported files, if necessary.
    cairoPaths: ["my/own/cairo-path1", "also/my/own/cairo-path2"]
  }
  ...
};

Runtime network

To set the network used in your Hardhat scripts/tests, use starknet["network"] or the --starknet-network CLI option. Not specifying one will default to using alpha-goerli.

A faster approach is to use starknet-devnet, a Ganache-like local testnet.

module.exports = {
  starknet: {
    network: "myNetwork"
  },
  networks: {
    myNetwork: {
      url: "http://127.0.0.1:5050"
    }
  }
  ...
};

Runtime network - Integrated Devnet

starknet-devnet is available out of the box as a starknet network called integrated-devnet. By default, it will spawn Devnet using its Docker image and listening on http://127.0.0.1:5050.

By defining/modifying networks["integratedDevnet"] in your hardhat config file, you can specify:

• the version of Devnet to be used for the underlying Devnet Docker image
• a Python environment with installed starknet-devnet (can be active environment); this will avoid using the dockerized version
• CLI arguments to be used on Devnet startup: options

module.exports = {
  starknet: {
    network: "integrated-devnet"
  },
  networks: {
    integratedDevnet: {
      url: "http://127.0.0.1:5050",

      // venv: "active" <- for the active virtual environment with installed starknet-devnet
      // venv: "path/to/venv" <- for env with installed starknet-devnet (created with e.g. `python -m venv path/to/venv`)
      venv: "<VENV_PATH>",

      // or specify Docker image tag
      dockerizedVersion: "<DEVNET_VERSION>"

      // optional devnet CLI arguments
      args: ["--lite-mode", "--gas-price", "2000000000"]
    }
  }
  ...
};

Installing third-party libraries

If you want to install a third-party Cairo library and be able to import it in your Cairo files, use the following pattern:

With npm packages:

1. Install (example package: influenceth__cairo_math_64x61@npm:@influenceth/cairo-math-64x61)

npm install --save-dev influenceth__cairo_math_64x61@npm:@influenceth/cairo-math-64x61

2. Edit the paths.cairoPaths section of your hardhat.config file (docs):

paths: {
    cairoPaths: ["./node_modules"]
}

3. Import

from influenceth__cairo_math_64x61.contracts.Math64x61 import Math64x61_ONE, Math64x61_mul

With pip packages:

1. Install (example package: openzeppelin-cairo-contracts)

pip install openzeppelin-cairo-contracts

2. If you are installing in a virtual environment, edit the paths.cairoPaths section of your hardhat.config file (docs) as:

paths: {
    // this directory contains the openzeppelin directory
    cairoPaths: ["path/to/cairo_venv/lib/python3.8/site-packages"];
}

3. Import

from openzeppelin.token.erc20.library import ERC20

Wallet

To configure a wallet for your project, specify it by adding an entry to wallets in your hardhat config file. You can specify multiple wallets/accounts.

The parameters for the wallet are:

• accountName: The name to give the account. If omitted, the default value __default__ will be used;
• modulePath: The python module and wallet class of your chosen wallet provider;
• accountPath: The path where your wallet information will be saved.

module.exports = {
  starknet: {
    wallets: {
      MyWallet: {
        accountName: "OpenZeppelin",
        modulePath: "starkware.starknet.wallets.open_zeppelin.OpenZeppelinAccount",
        accountPath: "~/.starknet_accounts"
      },
      AnotherWallet: {
        accountName: "AnotherOpenZeppelin",
        modulePath: "starkware.starknet.wallets.open_zeppelin.OpenZeppelinAccount",
        accountPath: "~/.starknet_accounts"
      }
    }
  }
  ...
};

Accounts are deployed in the same network as the one passed as an argument to the npx hardhat starknet-deploy-account CLI command.

To use the wallet in your scripts, use the getWallet utility function:

import { starknet } from "hardhat";
...
const wallet = starknet.getWallet("MyWallet");
const contract = ...;
await contract.invoke("increase_balance", { amount: 1 }, { wallet });

Account

An Account can be used to make proxy signed calls/transactions to other contracts. Its usage is exemplified earlier in the docs and in the example repo.

You can choose to deploy a new Account, or use an existing one.

To deploy a new Account, use the starknet object's deployAccount method:

function deployAccount(accountType: AccountImplementationType, options?: DeployAccountOptions);

• accountType - the implementation of the Account that you want to use; currently supported implementations:
  • "OpenZeppelin" - v0.2.1
  • "Argent" - v0.2.2
• options - optional deployment parameters:
  • salt - for fixing the account address
  • privateKey - if you don't provide one, it will be randomly generated
  • token - for indicating that the account is whitelisted on alpha-mainnet

Use it like this:

const account = await starknet.deployAccount("OpenZeppelin");
const accountWithPredefinedKey = await starknet.deployAccount("OpenZeppelin", {
    privateKey: process.env.MY_KEY
});

To retrieve an already deployed Account, use the starknet object's getAccountFromAddress method:

function getAccountFromAddress(
    address: string, // the address where the account you want to use is deployed
    privateKey: string, // the account's private key
    accountType: AccountImplementationType // the implementation of the Account that you want to use.
);

E.g.:

const account = await starknet.getAccountFromAddress(
    accountAddress,
    process.env.PRIVATE_KEY,
    "OpenZeppelin"
);

You can then use the Account object to call and invoke your contracts using the invoke and call methods, that take as arguments the target contract, function name, and arguments:

const { res: amount } = await account.call(contract, "get_balance");
await account.invoke(contract, "increase_balance", { amount });

Funds and Fees

• On alpha-goerli
  • Deploy an account using starknet.deployAccount.
  • Give it finds through the faucet.
  • Later load the account using starknet.getAccountFromAddress.
• On starknet-devnet
  • Since v0.2.3, Devnet comes with prefunded OpenZeppelin accounts.
  • To get the addresses and keys of these accounts, the options are:
    • use starknet.devnet.getPredeployedAccounts()
    • observe data logged on Devnet startup
  • Load one of the predeployed accounts using starknet.getAccountFromAddress
  • Read more
  • Alternatively use Devnet's faucet to fund the accounts that you deployed

Once your account has funds, you can specify a max fee greater than zero:

await account.invoke(contract, "foo", { arg1: ... }, { maxFee: BigInt(...) });

Multicalls

You can also use the Account object to perform multi{calls, invokes, fee estimations}.

const interactionArray = [
    {
        toContract: contract1,
        functionName: "increase_balance",
        calldata: { amount: 10n }
    },
    {
        toContract: contract2,
        functionName: "increase_balance",
        calldata: { amount: 20n }
    }
];
const fee = await account.multiEstimateFee(interactionArray);
const txHash = await account.multiInvoke(interactionArray);
const results = await account.multiCall(interactionArray);

OpenZeppelin and Argent accounts have some differences:

• Argent account needs to be initialized after deployment. This has to be done with another funded account.
• Argent account offers guardian functionality. The guardian is by default not set (the guardian key is undefined), but if you want to change it, cast the account to ArgentAccount and execute setGuardian.

import { ArgentAccount } from "hardhat/types/runtime";

const argentAccount = (await starknet.deployAccount("Argent")) as ArgentAccount;

const fundedAccount = ...;
await argentAccount.initialize({
  fundedAccount: fundedAccount,
  maxFee: 1e18
});

argentAccount.setGuardian(process.env.GUARDIAN_PRIVATE_KEY, { maxFee: 1e18 });

More examples

An example Hardhat project using this plugin can be found here.

Contribute

If you're a developer willing to contribute, go through the development readme.