Skip to content

Latest commit

 

History

History

examples

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
PriceOracle.ts
PriceOracle.ts
 
 
README.md
README.md
 
 
announcement.cash
announcement.cash
 
 
announcement.ts
announcement.ts
 
 
common-js.js
common-js.js
 
 
common.ts
common.ts
 
 
hodl_vault.cash
hodl_vault.cash
 
 
hodl_vault.ts
hodl_vault.ts
 
 
mecenas.cash
mecenas.cash
 
 
mecenas.ts
mecenas.ts
 
 
mecenas_locktime.cash
mecenas_locktime.cash
 
 
p2pkh.cash
p2pkh.cash
 
 
p2pkh.js
p2pkh.js
 
 
p2pkh.ts
p2pkh.ts
 
 
package.json
package.json
 
 
transfer_with_timeout.cash
transfer_with_timeout.cash
 
 
transfer_with_timeout.ts
transfer_with_timeout.ts
 
 

README.md

CashScript examples

This folder contains a number of example CashScript contracts to show off its functionality and usage. The .cash files contain example contracts, and the .ts/.js files contain example usage of the CashScript SDK with these contracts.

The "Hello World" of cash contracts is defining the P2PKH pattern inside a cash contract, which can be found under p2pkh.cash. Its usage can be found under p2pkh.ts.

Running the examples

To run the examples, clone this repository and navigate to the examples/ directory. Since the examples depend on the SDK, be sure to run yarn inside the examples/ directory, which installs all required packages.

git clone [email protected]:CashScript/cashscript.git
cd cashscript/examples
yarn

All .ts files can then be executed with ts-node-esm.

npm install -g ts-node
ts-node-esm p2pkh.ts

All .js files can be executed with node.

node p2pkh.js