Skip to content

Commit aa9c442

Browse files
merklejerkmerklejerk
committed
First commit
0 parents  commit aa9c442

10 files changed

+1456
-0
lines changed

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/node_modules
2+
**/*.log

‎.npmignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/.travis.yml
2+
/test

‎.travis.yml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
language: node_js
2+
install:
3+
- yarn -D install
4+
node_js:
5+
- "node"

‎LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md

+130
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
![build status](https://travis-ci.org/merklejerk/bn-str-256.svg?branch=master)
2+
![npm package](https://badge.fury.io/js/bn-str-256.svg)
3+
4+
# **bn-str-256**
5+
A simple, functional library for big number math,
6+
with up to 80 digits of precision, suitable for 256-bit/32-byte numbers used in
7+
domains like blockchain.
8+
9+
What sets this apart from other big number libraries is a very simple
10+
functional syntax where most operations result in a **decimal
11+
string** (e.g., `'412.959'`), which, depending on
12+
your application, may be a more useful representation.
13+
14+
Additionally, all functions accept plain numbers, decimal strings, exponential
15+
strings (e.g., `'1.5e-8'`), hex (e.g., `'0xf00b47'`),
16+
binary (e.g., `'0b10011'`), or octal (e.g., `'04471'`) encodings,
17+
as well as node `Buffer` objects as input. The library can likewise convert
18+
numbers to any of these encodings or `Buffer` objects.
19+
20+
This library is built as a wrapper around the awesome [decimal.js-light](https://github.com/MikeMcl/decimal.js-light) library.
21+
22+
### Examples
23+
```js
24+
const bn = require('bn-str-256');
25+
26+
// Add two numbers.
27+
bn.add(1234, '0x4953'); // '20005'
28+
// Subtract two numbers.
29+
bn.sub(1234, '1.5e-3'); // '1233.9985''
30+
// Multiply two numbers.
31+
bn.mul('1234.521', '305'); // output '376528.905'
32+
// Divide two numbers.
33+
bn.div(1234, '0x4953'); // '0.06573970486...'
34+
// Take the modulo of two numbers.
35+
bn.mod('1.412e8', 33); // '29'
36+
// Raise to a power.
37+
bn.pow(1234, 8); // '5376767751082385640407296'
38+
// Take the 3rd root.
39+
bn.pow(1234, 1/3); // '10.7260146688...'
40+
// Remove decimals.
41+
bn.int(44.4121); // '44'
42+
// Round.
43+
bn.round(44.68); // '45'
44+
// Count decimal places.
45+
bn.dp(44.312); // 3
46+
// Count significant digits.
47+
bn.dp(44.312); // 5
48+
// Truncate decimal places.
49+
bn.dp(44.312, 2); // '44.31'
50+
// Truncate significant digits.
51+
bn.dp(44.312, 3); // '44.3'
52+
// Get the sign of a number.
53+
bn.sign('-31.4121'); // -1
54+
// Work with some big numbers
55+
bn.sub('0x8ffffffffffffffffffffffffffffffffffffff',
56+
'1591029491249109201931039109512131121212') // '51380915346385064...'
57+
58+
// Compare numbers a variety of ways.
59+
bn.cmp(1, 2); // -1
60+
bn.gt(321, 321); // false
61+
bn.gte(321, 321); // true
62+
bn.lt(320, 321); // true
63+
bn.lte(320, 321); // true
64+
65+
// Take the minimum of two values.
66+
bn.min('1294.31221944', '5.421e6'); // '1294.31221944'
67+
// Take the maximum of two values.
68+
bn.min('1294.31221944', '5.421e6'); // '5421000'
69+
70+
// Just parse a hex value.
71+
bn.parse('0x49121') // '299297'
72+
// Just parse a binary value.
73+
bn.parse('0b1001') // '9'
74+
// Just parse a Buffer object.
75+
bn.parse(Buffer.from('foo')); // 6713199
76+
77+
// Do some math and output a hex string.
78+
bn.toHex(bn.mul('3043131212', '495')); // 0x15eb97423f4
79+
// Left pad a hex string to 20 digits.
80+
bn.toHex('4491959969129121', 20); // 0x0000000ff569ee4e22a1
81+
// Convert to a buffer.
82+
bn.toBuffer('99129129412'); // <Buffer 17 14 8e 79 c4>
83+
// Convert to native javascript Number type.
84+
bn.toNumber('0x491fc712d'); // 19629109549
85+
86+
// Split a number up into its parts.
87+
bn.split('-34.99'); // { sign: '-', integer: '34', decimal: '99' }
88+
89+
```
90+
91+
### All Functions
92+
| name (*alias*) | description |
93+
|----------------|-------------|
94+
| **parse** (*expand*) | convert a Number, exponential string, hex/octal/binary-encoded string, or buffer object into a decimal string |
95+
| `add(a, b)` (*plus*) | Add `a` and `b` |
96+
| `sub(a, b)` (*minus*) | Subtract `b` from `a` |
97+
| `mul(a, b)` (*times*) | Multiply `a` and `b` |
98+
| `div(a, b)` (*over*) | Divide `a` over `b` |
99+
| `idiv(a, b)` | Divide `a` by `b` and return the integer portion |
100+
| `mod(a, b)` | `a` modulo `b` |
101+
| `pow(x, y)` (*raise*) | Raise `x` to the `y` power |
102+
| `int(x)` | Return the integer portion of `x` (no rounding) |
103+
| `round(x)` | Round `x` to an integer |
104+
| `sum(...args)` | Sum all arguments |
105+
| `neg(x)` (*negate*) | Negate `x` |
106+
| `abs(x)` | Take the absolute value of `x` |
107+
| `sqrt(x)` | Take the square root of `x` |
108+
| `max(a, b)` | Take the maximum of `a` and `b` |
109+
| `min(a, b)` | Take the minimum of `a` and `b` |
110+
| `sd(x)` | Get the number of significant digits of `x` |
111+
| `sd(x, n)` | Set the number of significant digits of `x` to `n` |
112+
| `dp(x)` | Get the number of decimal places of `x` |
113+
| `dp(x, n)` | Set the number of decimal places of `x` to `n` |
114+
| `sign(x)` | Get the sign of `x` (`-1` if `x < 0`, `1` otherwise) |
115+
| `cmp(a, b)` | Compare `a` with `b`(where `-1` if `a < b`, `0` if `a == b`, `1` if a > b) |
116+
| `eq(a, b)` | Test if `a == b` |
117+
| `ne(a, b)` | Test if `a != b` |
118+
| `gt(a, b)` | Test if `a > b` |
119+
| `lt(a, b)` | Test if `a < b` |
120+
| `gte(a, b)` | Test if `a >= b` |
121+
| `lte(a, b)` | Test if `a <= b` |
122+
| `toHex(x)` | Convert `x` to a hex string (e.g., `0xf3abb`) |
123+
| `toHex(x, length)` | Convert `x` to a hex string and either truncate or left-pad it to `length` digits |
124+
| `toOctal(x)` | Convert `x` to an octal string (e.g., `04335`) |
125+
| `toOctal(x, length)` | Convert `x` to an octal string and either truncate or left-pad it to `length` digits |
126+
| `toBinary(x)` | Convert `x` to a binary string (e.g., `0b10111010`)|
127+
| `toBinary(x, length)` | Convert `x` to a binary string and either truncate or left-pad it to `length` digits |
128+
| `toBuffer(x)` | Convert `x` to a `Buffer` object |
129+
| `toBuffer(x, size)` | Convert `x` to a `Buffer` object, and either truncate or left-pad it to `size` bytes |
130+
| `toNumber(x)` | Convert `x` to a native `Number` type. Precision loss may occur. |

0 commit comments

Comments
 (0)