tipccjs/tipcc.js

The complete tip.cc API client for Node.js

tipcc.js's Issues

Move exchange rates to own manager

Duplicate transaction detection

Detect duplicate transactions in the transaction emitter and do not emit the event if they already occured.

Move wallets to own manager

Add proper README and tutorials

There are some documentation improvements which need to be made:

• Add a README
• Add an introduction and/or getting started page

Format Amount

This feature would give library users the option to format a tip in the currently know tip.cc format by calling a function in the amount class. Preferably, at client initalization there is a new option, which allows to pass a currencies-emojis map to the client, which would be used for this feature too (ex. BTC => <BTC:12312312312312312>...). The format for tips would be as follows

<#Amount>.toString(withUsd defaults to true)

<emojiName:emojiId> currencyAmount currencySymbol (≈ $usdValue)
currencyAmount would represent the this.humanValue.toFixed(currency.format.scale)

File structure

Reordering the files in a standard structure following compareable API wrappers improves the quality of the code and helps other developers to understand the code better.

Make documentation easier to understand

The documentation needs an overhaul, so it is easy to understand. This will involve making names shorter, changing the order of items being displayed and so on.
Closing this issue will require changing the exports on the library in a way that renders well on Typedoc.
This will also make the project more organized in general.

Converting currency amounts to USD value natively

This feature would improve the quality of the library, because people would have a native function in the Amount class which would convert the amount in the USD value by using the cached currencies.

<#Amount>.toFiat(fiatCurrency defaults to USD)

Move transactions, exchange rates and wallets to own managers

TipccClient needs to become less complex, rather referencing managers (classes) instead of having a bunch of functions and properties which could be distributed better.

• #21
• #22
• #23

Move transactions to own manager

CI for npm publishing

Add Prettier for code formatting

While everyone has their own coding style, using one code formatter with a configuration file will make sure everyone is following one code style.

Implement @tipccjs/tipcc-api-types

Replace local types by the type library.