Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into pn-any-to-erc20-swap-payment-processor
- Loading branch information
Showing
16 changed files
with
709 additions
and
264 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,185 @@ | ||
| import { RequestLogicTypes } from '@requestnetwork/types'; | ||
| import Utils from '@requestnetwork/utils'; | ||
| import { | ||
| getSupportedERC20Currencies, | ||
| getErc20Currency, | ||
| getErc20Symbol, | ||
| getErc20Decimals, | ||
| } from './erc20'; | ||
| import iso4217 from './iso4217'; | ||
| import otherCurrencies from './others'; | ||
|
|
||
| /** | ||
| * @class Currency implements ICurrency with helpers | ||
| * Represents a currency supported by the Request Logic, with minimum required | ||
| * information: value, type and network (optional). | ||
| */ | ||
| export class Currency implements RequestLogicTypes.ICurrency { | ||
| public readonly value: string; | ||
| public readonly type: RequestLogicTypes.CURRENCY; | ||
| public readonly network?: string; | ||
|
|
||
| constructor(currency: RequestLogicTypes.ICurrency) { | ||
| ({ value: this.value, type: this.type, network: this.network } = currency); | ||
| } | ||
|
|
||
| /** | ||
| * Gets a supported currency from a symbol, symbol-network or address. | ||
| * Iterates over all the supported networks if needed | ||
| * @param symbolOrAddress e.g. 'DAI', 'FAU', 'FAU-rinkeby' or '0xFab46E002BbF0b4509813474841E0716E6730136' | ||
| * @returns an ICurrency object | ||
| */ | ||
| static from(symbolOrAddress: string): Currency { | ||
| if (symbolOrAddress === '') { | ||
| throw new Error(`Cannot guess currency from empty string.`); | ||
| } | ||
| try { | ||
| const currencyFromSymbol = this.fromSymbol( | ||
| symbolOrAddress.split('-')[0], | ||
| symbolOrAddress.split('-')[1], | ||
| ); | ||
| return currencyFromSymbol; | ||
| } catch (e) { | ||
| const erc20Currencies = getSupportedERC20Currencies(); | ||
| const currencyFromAddress = erc20Currencies.find( | ||
| (c) => c.value.toLowerCase() === symbolOrAddress.toLowerCase(), | ||
| ); | ||
| if (!currencyFromAddress) { | ||
| throw new Error(`The currency ${symbolOrAddress} does not exist or is not supported`); | ||
| } | ||
| return new Currency(currencyFromAddress); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Get currency from its symbol and network. | ||
| * @param symbol | ||
| * @param network | ||
| * @returns RequestLogicTypes.ICurrency | ||
| */ | ||
| static fromSymbol = (symbol: string, network?: string): Currency => { | ||
| if (symbol === '') { | ||
| throw new Error(`Cannot guess currency from empty symbol.`); | ||
| } | ||
| // Check if it's a supported cryptocurrency | ||
| if (symbol === 'BTC' && (!network || network === 'mainnet')) { | ||
| return new Currency({ | ||
| type: RequestLogicTypes.CURRENCY.BTC, | ||
| value: 'BTC', | ||
| network: 'mainnet', | ||
| }); | ||
| } | ||
| if (symbol === 'ETH' && (!network || network === 'mainnet' || network === 'rinkeby')) { | ||
| return new Currency({ | ||
| type: RequestLogicTypes.CURRENCY.ETH, | ||
| value: 'ETH', | ||
| network: network || 'mainnet', | ||
| }); | ||
| } | ||
|
|
||
| // Check if it's an ERC20 token and return it if found | ||
| const erc20Currency = getErc20Currency(symbol, network); | ||
| if (erc20Currency) { | ||
| return new Currency(erc20Currency); | ||
| } | ||
|
|
||
| // Check if it's one of ISO4217 currencies | ||
| if (iso4217.find((i) => i.code === symbol)) { | ||
| return new Currency({ | ||
| type: RequestLogicTypes.CURRENCY.ISO4217, | ||
| value: symbol, | ||
| }); | ||
| } | ||
| throw new Error( | ||
| `The currency symbol '${symbol}'${ | ||
| network ? ` on ${network}` : '' | ||
| } is unknown or not supported`, | ||
| ); | ||
| }; | ||
|
|
||
| /** | ||
| * @returns Symbol if known (FAU, DAI, ETH etc.) | ||
| */ | ||
| public getSymbol(): string | 'unknown' { | ||
| let symbol: string; | ||
|
|
||
| switch (this.type) { | ||
| case RequestLogicTypes.CURRENCY.BTC: | ||
| case RequestLogicTypes.CURRENCY.ETH: | ||
| symbol = this.type; | ||
| break; | ||
| case RequestLogicTypes.CURRENCY.ISO4217: | ||
| symbol = this.value; | ||
| break; | ||
| case RequestLogicTypes.CURRENCY.ERC20: | ||
| symbol = getErc20Symbol(this) || 'unknown'; | ||
| break; | ||
| default: | ||
| symbol = 'unknown'; | ||
| } | ||
| return symbol; | ||
| } | ||
|
|
||
| /** | ||
| * Gets the hash of a currency | ||
| * | ||
| * @returns the hash of the currency | ||
| * @todo It onlys supports Ethereum-based currencies, fiat and BTC. | ||
| */ | ||
| public getHash(): string { | ||
| if (this.type === RequestLogicTypes.CURRENCY.ERC20) { | ||
| return this.value; | ||
| } | ||
| if ( | ||
| this.type === RequestLogicTypes.CURRENCY.ETH || | ||
| this.type === RequestLogicTypes.CURRENCY.BTC | ||
| ) { | ||
| // ignore the network | ||
| return Utils.crypto.last20bytesOfNormalizedKeccak256Hash({ | ||
| type: this.type, | ||
| value: this.value, | ||
| }); | ||
| } | ||
| return Utils.crypto.last20bytesOfNormalizedKeccak256Hash(this); | ||
| } | ||
|
|
||
| /** | ||
| * Returns the number of decimals | ||
| */ | ||
| public getDecimals(): number { | ||
| // Return decimals if currency is an ERC20 | ||
| if (this.type === RequestLogicTypes.CURRENCY.ERC20) { | ||
| return getErc20Decimals(this); | ||
| } | ||
|
|
||
| // Return the number of decimals for ISO-4217 currencies | ||
| if (this.type === RequestLogicTypes.CURRENCY.ISO4217) { | ||
| const iso = iso4217.find((i) => i.code === this.value); | ||
| if (!iso) { | ||
| throw new Error(`Unsupported ISO currency ${this.value}`); | ||
| } | ||
| return iso.digits; | ||
| } | ||
|
|
||
| // other currencies | ||
| const otherCurrency = otherCurrencies[this.type]; | ||
| if (!otherCurrency) { | ||
| throw new Error(`Currency ${this.type} not implemented`); | ||
| } | ||
|
|
||
| return otherCurrency.decimals; | ||
| } | ||
|
|
||
| /** | ||
| * @returns e.g.: 'ETH', 'ETH-rinkeby', 'FAU-rinkeby' etc. | ||
| */ | ||
| public toString(): string | 'unknown' { | ||
| const symbol = this.getSymbol(); | ||
|
|
||
| // Append currency network if relevant | ||
| const network = | ||
| this.network && this.network !== 'mainnet' && symbol !== 'unknown' ? `-${this.network}` : ''; | ||
|
|
||
| return symbol + network; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.