Skip to content

CLI and JS library allowing developers to easily interact with the iExec stack

License

Notifications You must be signed in to change notification settings

iExecBlockchainComputing/iexec-sdk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

iExec SDK logo

iExec SDK

npm version npm version license Twitter Follow

The iExec SDK is a CLI and a JS library that allows easy interactions with iExec decentralized marketplace in order to run off-chain computations.

The iExec javascript SDK can be imported in your frontend or backend JS project.

install

npm install iexec

import

import { IExec } from 'iexec';

Check the documentation

The iExec SDK comes with a command line interface enabling interactions with the decentralized marketplace from a terminal.

install

npm install -g iexec

# check commands
iexec help

Check the documentation

Contributing

Install

npm ci

Build

npm run build

Test

Tests run on a local dockerized stack, the test stack must be started prior to running tests

# once before testing
npm run start-test-stack

-After some times the test stack may become desynchronized, run npm run start-test-stack to refresh it.

npm run stop-test-stack will teardown the test stack

Run tests when the stack is up

npm run test

Some tests relies on RPC API providers, to have them running smoothly you can provide the following envs

Changelog

Find changes in the CHANGELOG

Resources