Allows to generate receipts for your EOS based crypto purchases.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
types
.gitignore
.travis.yml
LICENSE
README.md
index.ts
package.json
test.ts
tsconfig.json
tslint.json

README.md

EOS Receipt

Build Status npm version MIT licensed

EOSReceipt.io is where you can generate receipts for your EOS based crypto purchases.

A collaboration of EOS Tribe + EOS Nation at the 2018 Wyoming Hackathon.

image

Install

npm

$ yarn add eos-receipt

web

<script src="https://wzrd.in/standalone/eos-receipt@latest"></script>

Quickstart

import eosReceipt from "eos-receipt";

(async () => {
    const receipt = await eosReceipt("31e684605dadf43894ef1bde2f59a5995dabf3e249ddf6f691a44f6641403566")
    // {
    //   block_num: 15393068,
    //   block_time: '2018-09-08T16:20:50.000',
    //   from: 'eosnationdon',
    //   to: 'giftexchange',
    //   quantity: '30.0000 EOS',
    //   memo: 'EOS Nation Community Engagement Fund to EOS Gift Exchange',
    //   amount: 30,
    //   symbol: 'EOS',
    //   price: 5.1286650606,
    //   currency: 'USD',
    //   value: 153.859951818
    // }
})();

Related

API

Table of Contents

getReceipt

Get Receipt

Parameters

  • id string EOSIO Transaction ID
  • currency string FIAT Currency (optional, default "USD")
  • options object Optional Parameters (optional, default {})
    • options.endpoint string? EOSIO endpoint API

Examples

const receipt = await getReceipt("b7bf...649f");

Returns Promise<(Receipt | null)> Receipt JSON

getTicker

Get Ticker

Parameters

  • options Optional Parameters (optional, default {})
    • options.ticker Ticker (optional, default 1765)
    • options.structure Specify the structure for the main data field. Possible values are dictionary and array (default is dictionary). (optional, default "dictionary")
    • options.convert return pricing info in terms of another currency.

Examples

const ticker = await getTicker({ticker: 1765});

Returns Promise<GetTicker> Coinmarketcap GetTicker

tickerTable

Ticker Table

getTickerPrice

Get Ticker Price

Parameters

  • symbol Ticker Symbol (optional, default "EOS")
  • convert Type of Currency (optional, default "USD")

Examples

const currency = await getTickerPrice("EOS", "USD");
//=> 4.7717692928

Returns Promise<number> Price of Ticker

getTransaction

Get Transaction

Parameters

  • id string Transaction ID
  • options object Optional Parameters (optional, default {})
    • options.endpoint string? EOSIO endpoint API

Examples

const transaction = await getTransaction("b7bf...649f");

Returns Promise<GetTransaction> EOSIO Transaction

getTokenTransfer

Get Token Transfer

Parameters

  • trx_id Transaction ID
  • options object Optional Parameters (optional, default {})
    • options.api string? EOSIO API

Examples

const tokenTransfer = await getTokenTransfer("b7bf...649f");

Returns Promise<EosioTokenData> EOSIO Token Data