yaJSapi

The JS/TS port of yapapi, Golem's Python API

Prerequisites

• node >= v14.17.0
• yarn >= v1.22.3
  
  

Building the Library

(not needed for running examples)

Installation

• run yarn in main folder

Building

• run yarn build in main folder
• build is ready in dist folder!
  
  

Testing

Command	Description
yarn test:unit	Run all unit test
yarn cov	Show tests coverage
yarn cov:html	GeneratedDetailed test coverage report (HTML in coverage directory)
yarn cov:lcov	Generate lcov.info file

Running Examples

Installation

• cd examples will take you to examples folder
• yarn will install dependencies for the examples
• yarn build will build typescript examples
• add YAGNA_APPKEY as environment variable;

export YAGNA_APPKEY=your_yagna_app_key_here

When ready

• npm run js:hello will start hello world javascript example
• npm run js:blender will start blender javascript example
• npm run ts:blender will start blender typescript example
• npm run js:low will start javascript low level api example
• npm run ts:low will start typescript low level api example
• npm run ts:yacat will start typescript yacat example
• npm run js:fibonacci will start nodejs example
• npm run js:ssh will start javascript ssh example

To run yacat using npm, special characters like $ have to be escaped using \, e.g.:

npm run ts:yacat -- --mask '?a?a?a' --hash '\$P\$5ZDzPE45CLLhEx/72qt3NehVzwN2Ry/'

yarn accepts all characters:

yarn run ts:yacat --mask '?a?a?a' --hash '$P$5ZDzPE45CLLhEx/72qt3NehVzwN2Ry/'

Need more logs

Call -d or --debug flag on your example script, e.g. npm run ts:blender -- -d

Subnet

Use the --subnet-tag option, e.g. npm run ts:blender -- --subnet-tag YOUR_SUBNET.