Quikdraw NPM | npm.io

Quikdraw

A CLI sidekick to Kontour, the superpowered web3 private testnet.

Getting started

Install Quikdraw into your project
```
npm install quikdraw
```
Navigate to your smart contract repo. This is normally the path where you've installed Truffle or Hardhat.
Initialize your .quikdrawconfig (learn more) by answering a few simple questions (this example is for a Truffle repo)
```
npx quikdraw init
```
Write some awesome awesome contract code
You're ready to test your contracts and your client dev teammate is waiting for you to deploy to a shared testnet. Have no fear, you don't need to go to a faucet or upload those pesky ABIs anywhere! Just run
```
npx quikdraw go
```
Your contracts will be compiled and added to a new project as a new draft version. We'll give you a handy Kontour link and save these settings for the next time around.
Enjoy using Kontour to browse your private test node and share a one-click SDK url to your teammates! Whenever you want to deploy a new round of contracts, just npx quikdraw go and your team will automatically be up to date, with zero address sharing, zero ABIs, zero test tokens, and zero client changes necessary!

Automatic deploys

Kontour supports automated deploys via npx quikdraw deploy using a script of your choice. Deploy scripts are incredibly easy to write:

// migrate.js
const migrate = require("quikdraw").migrate;

async function main() {
    await migrate("SimpleStorage")
    await migrate("MyContractHere", [arg1, arg2, arg3])
}
main()

Adding "deploy": "./migrate.js" to your .quikdrawconfig will trigger this script each time you run npx quikdraw deploy, and your contracts will show up in the latest Kontour instance.

Details

.quikdrawconfig

This is a JSON configuration file for quikdraw and is created by npx quikdraw init. It has the following fields:

type: truffle | hardhat
truffleConfigPath: For Truffle users only, points to your Truffle config file
apiKey: Your Kontour API key - this authenticates Quikdraw on our servers
projectId: Your Kontour project ID - you can change this if you're switching projects, but likely won't have to!
versionId: The current Kontour version that you're working on. If you publish a version and move on, change this or erase it to have Quikdraw make you a new one.
deploy: The path to a script that you'd like to run using npx quikdraw deploy (more here)

quikdraw init

Are you using truffle or hardhat to manage your environment?
(1) truffle
(2) hardhat
(3) I'm not sure how to get started, help me out? [default - 3]: 1

Location of your truffle-config.js [./truffle-config.js]: ./truffle-development.config.js

Grab your API key from https://kontour.io/key (required!): *********************

Default projectId [null]:

Let's break this down:

Quikdraw only supports Truffle and Hardhat projects right now.
For Truffle projects, we require a path to the config file that you want to use for contract compilation.
You'll need your API key to grant access to Kontour, so grab one here!
Don't worry if you don't have a project ID yet, Quikdraw will make one for you automatically!

quikdraw go url

Uploading compiled sources to Kontour now...
Uploading Bounty
Uploading VotableBounty
Uploaded Bounty
Uploaded VotableBounty

Find your project at https://kontour.io/versions/bd47e6e7-1311-4a7c-8137-f80361c6d2ee

[url] is optional, and can be

kontour.io/projects/{project_id} to automatically generate a new version of your project
kontour.io/versions/{version_id} to automatically update that version

If url is not given, Quikdraw will use the values in your .quikdrawconfig during the run.

Under the hood, Quikdraw triggers your project's Truffle or Hardhat compilation. It then takes those compiled artifacts and sends them to your private Kontour project, which makes them available to add to your node. Whenever you make changes and compile a new set of contracts, your Kontour draft will update to those new versions.

Client developers can point to any version of your smart contract APIs that they want by changing a single URL parameter, and Kontour will make sure all of the web3.js SDKs are automatically generated and kept up to date!

quickdraw deploy

Deploying SimpleStorage
SimpleStorage was deployed at 0x5DC6eD4eC66c291eDDFebFF37A17023B17224fEe!
Check out https://kontour.io/instances/13090f7f-aa89-4b1d-a906-ab2cf75d636e

If you've linked a migration script under the deploy field of your .quikdrawconfig, this command will run that script and deploy the contracts in your version automatically. This deploy is executed by your test node, so you don't have to attach an address or worry about gas fees, it's instantaneous!