https://github.com/iExecBlockchainComputing/iexec-sdk

CLI and JS library allowing developers to easily interact with the iExec stack
https://github.com/iExecBlockchainComputing/iexec-sdk

blockchain ethereum iexec

Last synced: 27 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/iExecBlockchainComputing/iexec-sdk
• Owner: iExecBlockchainComputing
• License: other
• Created: 2017-07-20T12:48:58.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-05-21T14:10:08.000Z (7 months ago)
• Last Synced: 2024-05-22T10:40:04.975Z (7 months ago)
• Topics: blockchain, ethereum, iexec
• Language: JavaScript
• Homepage: https://iex.ec
• Size: 9.58 MB
• Stars: 408
• Watchers: 43
• Forks: 37
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• best-of-crypto - GitHub - 21% open · ⏱️ 28.05.2024): (Others)

README

        
![iExec SDK logo](./iexec_sdk_logo.jpg)

# iExec SDK

[![npm version](https://badge.fury.io/js/iexec.svg)](https://www.npmjs.com/package/iexec) [![npm version](https://img.shields.io/npm/dm/iexec.svg)](https://www.npmjs.com/package/iexec) [![license](https://img.shields.io/github/license/iExecBlockchainComputing/iexec-sdk.svg)](LICENSE) [![Twitter Follow](https://img.shields.io/twitter/follow/iex_ec.svg?style=social&label=Follow)](https://twitter.com/iex_ec)

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.

## [Library](./docs/README.md)

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

install

```sh

npm install iexec

```

import

```js

import { IExec } from 'iexec';

```

Check the [documentation](./docs/README.md)

## [CLI](./CLI.md)

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

install

```sh

npm install -g iexec

# check commands

iexec help

```

Check the [documentation](./CLI.md)

## Contributing

### Install

```sh

npm ci

```

### Build

```sh

npm run build

```

### Test

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

```sh

# 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

```sh

npm run test

```

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

>

> - ALCHEMY_API_KEY (obtained from )

> - ETHERSCAN_API_KEY (obtained from )

> - INFURA_PROJECT_ID (obtained from )

## Changelog

Find changes in the [CHANGELOG](./CHANGELOG.md)

## Resources

- [iExec main documentation](https://docs.iex.ec/for-developers/)

- [The iExec Explorer](https://explorer.iex.ec)