Merge pull request #21 from confio/remove-bn.js

Remove bn.js dependency
This commit is contained in:
Ethan Frey 2020-01-30 12:09:05 +01:00 committed by GitHub
commit 53981bfbc1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 26 additions and 57 deletions

View File

@ -40,7 +40,6 @@
"@iov/multichain": "^2.0.0-alpha.7",
"@koa/cors": "^3.0.0",
"axios": "^0.19.0",
"bn.js": "^5.1.1",
"fast-deep-equal": "^3.1.1",
"koa": "^2.11.0",
"koa-bodyparser": "^4.2.1",
@ -48,7 +47,6 @@
"xstream": "^11.11.0"
},
"devDependencies": {
"@types/bn.js": "^4.11.6",
"@types/koa": "^2.11.0",
"@types/koa-bodyparser": "^4.3.0",
"@types/koa__cors": "^3.0.1"

View File

@ -15,7 +15,7 @@ export async function generate(args: ReadonlyArray<string>): Promise<void> {
const codecName = codecFromString(args[0]);
const chainId = args[1] as ChainId;
const mnemonic = Bip39.encode(await Random.getBytes(16)).toString();
const mnemonic = Bip39.encode(Random.getBytes(16)).toString();
console.info(`FAUCET_MNEMONIC="${mnemonic}"`);
const profile = new UserProfile();

View File

@ -1,7 +1,5 @@
import BN = require("bn.js");
import { Account, Amount, TokenTicker } from "@iov/bcp";
import { Int53 } from "@iov/encoding";
import { Decimal, Uint53 } from "@iov/encoding";
/** Send `factor` times credit amount on refilling */
const defaultRefillFactor = 20;
@ -24,15 +22,14 @@ export function getFractionalDigits(): number {
}
/** The amount of tokens that will be sent to the user */
export function creditAmount(token: TokenTicker, factor = 1): Amount {
export function creditAmount(token: TokenTicker, factor: Uint53 = new Uint53(1)): Amount {
const amountFromEnv = process.env[`FAUCET_CREDIT_AMOUNT_${token}`];
const wholeNumber = amountFromEnv ? Int53.fromString(amountFromEnv).toNumber() : 10;
const total = wholeNumber * factor;
const amount = amountFromEnv ? Uint53.fromString(amountFromEnv).toNumber() : 10;
const value = new Uint53(amount * factor.toNumber());
const fractionalDigits = getFractionalDigits();
// replace BN with BigInt with TypeScript 3.2 and node 11
const quantity = new BN(total).imul(new BN(10).pow(new BN(fractionalDigits))).toString();
return {
quantity: quantity,
quantity: value.toString() + "0".repeat(fractionalDigits),
fractionalDigits: fractionalDigits,
tokenTicker: token,
};
@ -40,21 +37,28 @@ export function creditAmount(token: TokenTicker, factor = 1): Amount {
export function refillAmount(token: TokenTicker): Amount {
const factorFromEnv = Number.parseInt(process.env.FAUCET_REFILL_FACTOR || "0", 10) || undefined;
const factor = factorFromEnv || defaultRefillFactor;
const factor = new Uint53(factorFromEnv || defaultRefillFactor);
return creditAmount(token, factor);
}
export function refillThreshold(token: TokenTicker): Amount {
const factorFromEnv = Number.parseInt(process.env.FAUCET_REFILL_THRESHOLD || "0", 10) || undefined;
const factor = factorFromEnv || defaultRefillThresholdFactor;
const factor = new Uint53(factorFromEnv || defaultRefillThresholdFactor);
return creditAmount(token, factor);
}
/** true iff the distributor account needs a refill */
export function needsRefill(account: Account, token: TokenTicker): boolean {
const coin = account.balance.find(balance => balance.tokenTicker === token);
const balanceAmount = account.balance.find(b => b.tokenTicker === token);
const tokenBalance = coin ? coin.quantity : "0";
const refillQty = new BN(refillThreshold(token).quantity);
return new BN(tokenBalance).lt(refillQty);
const balance = balanceAmount
? Decimal.fromAtomics(balanceAmount.quantity, balanceAmount.fractionalDigits)
: Decimal.fromAtomics("0", 0);
const thresholdAmount = refillThreshold(token);
const threshold = Decimal.fromAtomics(thresholdAmount.quantity, thresholdAmount.fractionalDigits);
// TODO: perform < operation on Decimal type directly
// https://github.com/iov-one/iov-core/issues/1375
return balance.toFloatApproximation() < threshold.toFloatApproximation();
}

View File

@ -1,38 +1,18 @@
import { Account, Amount } from "@iov/bcp";
import { Decimal } from "@iov/encoding";
import { MultiChainSigner } from "@iov/multichain";
import { SendJob } from "./types";
export function amountToNumber(amount: Amount): number {
const { quantity, fractionalDigits } = amount;
if (!quantity.match(/^[0-9]+$/)) {
throw new Error(`quantity must be a number, got ${quantity}`);
}
if (fractionalDigits < 0) {
throw new Error(`invalid fractional digits: ${fractionalDigits}`);
}
// let's remove those leading zeros...
const temp = quantity.replace(/^0+/, "");
// unless we need them to reach a decimal point
const pad = fractionalDigits - temp.length;
const trimmed = pad > 0 ? "0".repeat(pad) + temp : temp;
const cut = trimmed.length - fractionalDigits;
const whole = cut === 0 ? "0" : trimmed.slice(0, cut);
const decimal = fractionalDigits === 0 ? "" : `.${trimmed.slice(cut)}`;
const value = `${whole}${decimal}`;
return Number(value);
}
/** A string representation of a coin in a human-readable format that can change at any time */
export function debugCoin(coin: Amount): string {
return `${amountToNumber(coin)} ${coin.tokenTicker}`;
function debugAmount(amount: Amount): string {
const value = Decimal.fromAtomics(amount.quantity, amount.fractionalDigits).toString();
return `${value} ${amount.tokenTicker}`;
}
/** A string representation of a balance in a human-readable format that can change at any time */
export function debugBalance(data: ReadonlyArray<Amount>): string {
return `[${data.map(debugCoin).join(", ")}]`;
return `[${data.map(debugAmount).join(", ")}]`;
}
/** A string representation of an account in a human-readable format that can change at any time */
@ -53,6 +33,6 @@ export function logAccountsState(accounts: ReadonlyArray<Account>): void {
export function logSendJob(signer: MultiChainSigner, job: SendJob): void {
const from = signer.identityToAddress(job.sender);
const to = job.recipient;
const amount = debugCoin(job.amount);
const amount = debugAmount(job.amount);
console.info(`Sending ${amount} from ${from} to ${to} ...`);
}

View File

@ -4,7 +4,6 @@ export function main(args: ReadonlyArray<string>): void {
if (args.length < 1) {
help();
process.exit(1);
return;
}
const action = args[0];

View File

@ -1002,13 +1002,6 @@
dependencies:
"@types/node" "*"
"@types/bn.js@^4.11.6":
version "4.11.6"
resolved "https://registry.yarnpkg.com/@types/bn.js/-/bn.js-4.11.6.tgz#c306c70d9358aaea33cd4eda092a742b9505967c"
integrity sha512-pqr857jrp2kPuO9uRjZ3PwnJTjoQy+fcdxvBTvHm6dkmEL9q+hDD/2j/0ELOBPtPnS8LjCX0gI9nbl8lVkadpg==
dependencies:
"@types/node" "*"
"@types/body-parser@*":
version "1.17.1"
resolved "https://registry.yarnpkg.com/@types/body-parser/-/body-parser-1.17.1.tgz#18fcf61768fb5c30ccc508c21d6fd2e8b3bf7897"
@ -1854,11 +1847,6 @@ bn.js@^4.0.0, bn.js@^4.1.0, bn.js@^4.1.1, bn.js@^4.11.8, bn.js@^4.4.0:
resolved "https://registry.yarnpkg.com/bn.js/-/bn.js-4.11.8.tgz#2cde09eb5ee341f484746bb0309b3253b1b1442f"
integrity sha512-ItfYfPLkWHUjckQCk8xC+LwxgK8NYcXywGigJgSwOP8Y2iyWT4f2vsZnoOXTTbo+o5yXmIUJ4gn5538SO5S3gA==
bn.js@^5.1.1:
version "5.1.1"
resolved "https://registry.yarnpkg.com/bn.js/-/bn.js-5.1.1.tgz#48efc4031a9c4041b9c99c6941d903463ab62eb5"
integrity sha512-IUTD/REb78Z2eodka1QZyyEk66pciRcP6Sroka0aI3tG/iwIdYLrBD62RsubR7vqdt3WyX8p4jxeatzmRSphtA==
body-parser@^1.16.1:
version "1.19.0"
resolved "https://registry.yarnpkg.com/body-parser/-/body-parser-1.19.0.tgz#96b2709e57c9c4e09a6fd66a8fd979844f69f08a"