@atpar/ap-helper
v0.1.0-alpha.25-demo
Published
Helper service for working with ap.js.
Downloads
42
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 orderbookGET /orders
Retrieve unfilled orders from the orderbookResources
GET /terms
Retrieve ACTUS test termsAsset
POST /asset/progress
Progress the state of an asset given its assetId and a timestampTokenization
POST /tokenization/updateClaimsToken
Update funds received of a ClaimsToken contractFaucet
POST /faucet/ether
Request Ether for an addressPOST /faucet/sampleToken
Request ERC20 sample tokens for an addressGET /faucet/ether
Retrieve the address of the ERC20 sample token
Usage
Quick start:
yarn add @atpar/ap-helper
node ./node_modules/@atpar/ap-helper
To clear the orderbook and channel message database:
echo "" > ./node_modules/@atpar/ap-helper/Orderbook-Database.json
Development
Requirements
- NPM (6.2.0)
Run
- install dependencies
# ap-monorepo/ap-helper/
yarn install
yarn build
- start ap-helper
yarn start