Skip to content
This repository has been archived by the owner on Aug 2, 2022. It is now read-only.

Add Gitpod config #661

Open
wants to merge 10 commits into
base: v20.0
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitpod.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
tasks:
- init: yarn install && yarn run build
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/EOSIO/eosjs)

# eosjs ![npm](https://img.shields.io/npm/dw/eosjs.svg)

Javascript API for integration with EOSIO-based blockchains using [EOSIO RPC API](https://developers.eos.io/eosio-nodeos/reference).
Expand All @@ -10,7 +12,7 @@ Documentation can be found [here](https://eosio.github.io/eosjs)

The official distribution package can be found at [npm](https://www.npmjs.com/package/eosjs).

### NodeJS Dependency
### Add dependency to your project

`yarn add eosjs`

Expand All @@ -22,15 +24,15 @@ Clone this repository locally then run `yarn build-web`. The browser distributi

### ES Modules

Importing using ES6 module syntax in the browser is supported if you have a transpiler, such as Babel.
Importing using ESM syntax is supported using TypeScript, [webpack](https://webpack.js.org/api/module-methods), or [Node.js with `--experimental-modules` flag](https://nodejs.org/api/esm.html)
```js
import { Api, JsonRpc, RpcError } from 'eosjs';
import { JsSignatureProvider } from 'eosjs/dist/eosjs-jssig'; // development only
```

### CommonJS

Importing using commonJS syntax is supported by NodeJS out of the box.
Importing using commonJS syntax is supported by Node.js out of the box.
```js
const { Api, JsonRpc, RpcError } = require('eosjs');
const { JsSignatureProvider } = require('eosjs/dist/eosjs-jssig'); // development only
Expand All @@ -54,7 +56,7 @@ const signatureProvider = new JsSignatureProvider([defaultPrivateKey]);

### JSON-RPC

Open a connection to JSON-RPC, include `fetch` when on NodeJS.
Open a connection to JSON-RPC, include `fetch` when on Node.js.
```js
const rpc = new JsonRpc('http://127.0.0.1:8888', { fetch });
```
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "eosjs",
"version": "20.0.0",
"version": "20.0.2",
"description": "Talk to eos API",
"main": "dist/index.js",
"scripts": {
Expand All @@ -12,7 +12,7 @@
"test": "jest src/tests/*eosjs*",
"test-node": "jest src/tests/*node*",
"test-all": "yarn test && yarn test-node && yarn cypress",
"build": "tsc -p ./tsconfig.json && cp src/ripemd.es5.js dist/ripemd.js",
"build": "tsc -p ./tsconfig.json && node scripts/copy-ripe-md.js",
"build-web": "webpack --config webpack.prod.js && webpack --config webpack.debug.js",
"build-production": "yarn build && yarn build-web && yarn test-all",
"clean": "rm -rf dist",
Expand All @@ -29,7 +29,7 @@
},
"dependencies": {
"babel-runtime": "6.26.0",
"eosjs-ecc": "4.0.4",
"eosjs-ecc": "4.0.7",
"text-encoding": "0.7.0"
},
"devDependencies": {
Expand Down
8 changes: 8 additions & 0 deletions scripts/copy-ripe-md.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
var fs = require('fs');
var path = require('path');
var root = __dirname.replace('scripts', '');

if(!fs.existsSync(path.join(root + 'dist')))
fs.mkdirSync(path.join(root + 'dist'));

fs.copyFileSync(path.join(root + 'src/ripemd.es5.js'), path.join(root + 'dist/ripemd.js'));