Skip to content

gear-sv/gear-contracts

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gear-contracts

Example test, compile, deploy harness for BSV powered c++ contracts.

deLorean Time Machine


Install Emscripten

MacOS Installation Instructions:

  1. brew install emscripten
Installs to /usr/local/Cellar/emscripten/[version].

Generates default config file at `~/.emscripten`.
  1. Follow configuration steps by updating your ~/.emscripten file accordingly.
Manually set LLVM_ROOT to
  /usr/local/opt/emscripten/libexec/llvm/bin
and comment out BINARYEN_ROOT
in ~/.emscripten after running `emcc` for the first time.

Install gear-contracts

npm i gear-contracts -g


Create Project

gear-contracts init [project_name]

Generates a minimal contract harness.

contracts
  FungibleToken.h
  FungibleToken.cpp
  NamingService.h
  NamingService.cpp
  NonFungibleToken.h
  NonFungibleToken.cpp

tests
  FungibleToken.test.js
  NamingService.test.js
  NonFungibleToken.test.js

output
  [compiled emscripten modules]
  [compiled wasm binaries]
  [gzip contract package tar]

Create account

  1. gear-contracts keys
Creates key pair.
Saves privateKey, publicKey, and address to key.json.
Generates QR code image of address to address.png.
  1. Fund account by sending some bsv to the generated address in key.json. You can easily scan the QR code and send payment with HandCash.

Compile

gear-contracts compile [contract_name]

Compiles c++ code to wasm bytecode to out/[contract_name].out.wasm.
Generates javascript module interface to out/[contract_name].out.js.

Package

gear-contracts package [contract_name]

Packages and gzips contract files to out/[contract_name].tar.gz

Test

gear-contracts test [contract_name]

Deploy

gear-contracts deploy [contract_name]

Packages contract files (.wasm) (.cpp) (.js) (.json).
Formats gearsv contract deploy call.
Broadcasts transaction.

Check for the deployment transaction at https://whatsonchain.com/address/[address]

About

compile, test, deploy cpp code to bitcoin

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published