# @atpar/ap-helper

> Helper service for working with ap.js.

Latest version **0.1.0-alpha.25-demo** (published 2019-06-27) · UNLICENSED license · 0 weekly downloads

## Install

```sh
npm install @atpar/ap-helper
pnpm add @atpar/ap-helper
yarn add @atpar/ap-helper
bun add @atpar/ap-helper
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0-alpha.25-demo |
| Published | 2019-06-27 |
| First published | 2019-03-29 |
| Weekly downloads | 0 |
| License | UNLICENSED |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 31.6 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 15 |
| Author | jo-es |
| Maintainers | andreirykov, jo-es, jo-tud, nbundi |

## Links

- npm: https://www.npmjs.com/package/@atpar/ap-helper
- Repository: https://github.com/atpar/ap-monorepo
- Homepage: https://github.com/atpar/ap-monorepo#readme
- Issues: https://github.com/atpar/ap-monorepo/issues
- npm.io page: https://npm.io/package/@atpar/ap-helper

## Dependencies (9)

- [cors](https://npm.io/package/cors.md) ^2.8.4
- [web3](https://npm.io/package/web3.md) 1.0.0-beta.46
- [lowdb](https://npm.io/package/lowdb.md) ^1.0.0
- [dotenv](https://npm.io/package/dotenv.md) ^6.1.0
- [express](https://npm.io/package/express.md) ^4.16.3
- [@atpar/ap.js](https://npm.io/package/@atpar/ap.js.md) ^0.1.0-alpha.25-demo
- [bignumber.js](https://npm.io/package/bignumber.js.md) ^7.2.1
- [actus-solidity](https://npm.io/package/actus-solidity.md) ^0.1.1
- [@atpar/ap-contracts](https://npm.io/package/@atpar/ap-contracts.md) ^0.1.0-alpha.25-demo

## Recent versions

- 0.1.0-alpha.25-demo (latest) — 2019-06-27
- 0.1.0-alpha.25 — 2019-06-27
- 0.1.0-alpha.24 — 2019-06-13
- 0.1.0-alpha.24-demo — 2019-06-13
- 0.1.0-alpha.23 — 2019-05-23
- 0.1.0-alpha.22 — 2019-05-18
- 0.1.0-alpha.21 — 2019-05-12
- 0.1.0-alpha.20 — 2019-05-01
- 0.1.0-alpha.18 — 2019-04-29
- 0.1.0-alpha.17 — 2019-04-28
- 0.1.0-alpha.16 — 2019-04-27
- 0.1.0-alpha.15 — 2019-04-20
- 0.1.0-alpha.14 — 2019-04-18
- 0.1.0-alpha.13 — 2019-04-17
- 0.1.0-alpha.12 — 2019-04-17
- … 10 more at https://npm.io/package/@atpar/ap-helper/versions

## README

# AP-Helper

Helper service for working with `ap.js`. 
Contains:
- orderbook-relayer
- ether and erc20 sample token faucet
- api for retrieving ACTUS test terms
- api for progress the state of an asset
- api for updating ClaimsToken contracts

## API
- **Order**
  
  `POST /orders` Post an unfilled or filled order to the orderbook

  `GET /orders` Retrieve unfilled orders from the orderbook

- **Resources**

  `GET /terms` Retrieve ACTUS test terms
  
- **Asset**

  `POST /asset/progress` Progress the state of an asset given its assetId and a timestamp
  
- **Tokenization**

  `POST /tokenization/updateClaimsToken` Update funds received of a ClaimsToken contract

- **Faucet**

  `POST /faucet/ether` Request Ether for an address
  
  `POST /faucet/sampleToken` Request ERC20 sample tokens for an address
  
  `GET /faucet/ether` Retrieve the address of the ERC20 sample token

## Usage
Quick start:
```sh
yarn add @atpar/ap-helper

node ./node_modules/@atpar/ap-helper
```

To clear the orderbook and channel message database:
```sh
echo "" > ./node_modules/@atpar/ap-helper/Orderbook-Database.json
```

## Development

### Requirements
- NPM (6.2.0)

### Run
1. install dependencies
```sh
# ap-monorepo/ap-helper/
yarn install
yarn build
```

2. start ap-helper
```sh
yarn start
```

---
_Source: https://npm.io/package/@atpar/ap-helper · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._