essential-eth 0.4.9-beta.0 → 0.4.9-beta.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/classes/Contract.d.ts +71 -0
- package/dist/cjs/classes/Contract.js +133 -0
- package/dist/cjs/classes/test/Contract/crv-abi.d.ts +2 -0
- package/dist/cjs/classes/test/Contract/crv-abi.js +488 -0
- package/dist/cjs/classes/test/Contract/ens-abi.d.ts +2 -0
- package/dist/cjs/classes/test/Contract/ens-abi.js +453 -0
- package/dist/cjs/classes/test/Contract/fei-abi.d.ts +2 -0
- package/dist/cjs/classes/test/Contract/fei-abi.js +526 -0
- package/dist/cjs/classes/test/Contract/foo-abi.d.ts +2 -0
- package/dist/cjs/classes/test/Contract/foo-abi.js +42 -0
- package/dist/cjs/classes/test/Contract/uniswap-abi.d.ts +2 -0
- package/dist/cjs/classes/test/Contract/uniswap-abi.js +121 -0
- package/dist/cjs/classes/utils/clean-block.d.ts +6 -0
- package/dist/cjs/classes/utils/clean-block.js +46 -0
- package/dist/cjs/classes/utils/clean-transaction.d.ts +5 -0
- package/dist/cjs/classes/utils/clean-transaction.js +38 -0
- package/dist/cjs/classes/utils/encode-decode-transaction.d.ts +3 -0
- package/dist/cjs/classes/utils/encode-decode-transaction.js +114 -0
- package/dist/cjs/classes/utils/fetchers.d.ts +9 -0
- package/dist/cjs/classes/utils/fetchers.js +33 -0
- package/{src/classes/utils/hex-to-decimal.ts → dist/cjs/classes/utils/hex-to-decimal.d.ts} +1 -3
- package/dist/cjs/classes/utils/hex-to-decimal.js +11 -0
- package/{src/index.ts → dist/cjs/index.d.ts} +3 -21
- package/dist/cjs/index.js +36 -0
- package/dist/cjs/providers/JsonRpcProvider.d.ts +23 -0
- package/dist/cjs/providers/JsonRpcProvider.js +94 -0
- package/dist/cjs/providers/utils/chains-info.d.ts +360 -0
- package/dist/cjs/providers/utils/chains-info.js +1081 -0
- package/dist/cjs/shared/tiny-big/helpers.d.ts +1 -0
- package/dist/cjs/shared/tiny-big/helpers.js +71 -0
- package/dist/cjs/shared/tiny-big/tiny-big.d.ts +19 -0
- package/dist/cjs/shared/tiny-big/tiny-big.js +41 -0
- package/dist/cjs/shared/validate-type.d.ts +3 -0
- package/dist/cjs/shared/validate-type.js +9 -0
- package/dist/cjs/tsconfig-cjs.tsbuildinfo +1 -0
- package/dist/cjs/types/Block.types.d.ts +47 -0
- package/dist/cjs/types/Block.types.js +2 -0
- package/dist/cjs/types/Contract.types.d.ts +24 -0
- package/dist/cjs/types/Contract.types.js +2 -0
- package/dist/cjs/types/Network.types.d.ts +8 -0
- package/dist/cjs/types/Network.types.js +2 -0
- package/dist/cjs/types/Transaction.types.d.ts +34 -0
- package/dist/cjs/types/Transaction.types.js +2 -0
- package/{src/utils/ether-to-wei.ts → dist/cjs/utils/ether-to-wei.d.ts} +2 -10
- package/dist/cjs/utils/ether-to-wei.js +32 -0
- package/{src/utils/index.ts → dist/cjs/utils/index.d.ts} +0 -1
- package/dist/cjs/utils/index.js +11 -0
- package/dist/cjs/utils/is-address.d.ts +5 -0
- package/dist/cjs/utils/is-address.js +20 -0
- package/dist/cjs/utils/to-checksum-address.d.ts +17 -0
- package/dist/cjs/utils/to-checksum-address.js +46 -0
- package/{src/utils/wei-to-ether.ts → dist/cjs/utils/wei-to-ether.d.ts} +1 -8
- package/dist/cjs/utils/wei-to-ether.js +34 -0
- package/dist/esm/classes/Contract.d.ts +11 -0
- package/dist/esm/classes/Contract.js +70 -0
- package/dist/esm/classes/test/Contract/crv-abi.d.ts +2 -0
- package/dist/esm/classes/test/Contract/crv-abi.js +470 -0
- package/dist/esm/classes/test/Contract/ens-abi.d.ts +2 -0
- package/dist/esm/classes/test/Contract/ens-abi.js +435 -0
- package/dist/esm/classes/test/Contract/fei-abi.d.ts +2 -0
- package/dist/esm/classes/test/Contract/fei-abi.js +521 -0
- package/dist/esm/classes/test/Contract/foo-abi.d.ts +2 -0
- package/dist/esm/classes/test/Contract/foo-abi.js +33 -0
- package/dist/esm/classes/test/Contract/uniswap-abi.d.ts +2 -0
- package/dist/esm/classes/test/Contract/uniswap-abi.js +116 -0
- package/dist/esm/classes/utils/clean-block.d.ts +3 -0
- package/dist/esm/classes/utils/clean-block.js +35 -0
- package/dist/esm/classes/utils/clean-transaction.d.ts +2 -0
- package/dist/esm/classes/utils/clean-transaction.js +29 -0
- package/dist/esm/classes/utils/encode-decode-transaction.d.ts +3 -0
- package/dist/esm/classes/utils/encode-decode-transaction.js +99 -0
- package/dist/esm/classes/utils/fetchers.d.ts +9 -0
- package/dist/esm/classes/utils/fetchers.js +25 -0
- package/dist/esm/classes/utils/hex-to-decimal.d.ts +1 -0
- package/dist/esm/classes/utils/hex-to-decimal.js +3 -0
- package/dist/esm/index.d.ts +9 -0
- package/dist/esm/index.js +5 -0
- package/dist/esm/providers/JsonRpcProvider.d.ts +10 -0
- package/dist/esm/providers/JsonRpcProvider.js +74 -0
- package/dist/esm/providers/utils/chains-info.d.ts +360 -0
- package/dist/esm/providers/utils/chains-info.js +1077 -0
- package/dist/esm/shared/tiny-big/helpers.d.ts +1 -0
- package/dist/esm/shared/tiny-big/helpers.js +58 -0
- package/dist/esm/shared/tiny-big/tiny-big.d.ts +8 -0
- package/dist/esm/shared/tiny-big/tiny-big.js +22 -0
- package/dist/esm/shared/validate-type.d.ts +3 -0
- package/dist/esm/shared/validate-type.js +5 -0
- package/dist/esm/tsconfig.tsbuildinfo +1 -0
- package/dist/esm/types/Block.types.d.ts +47 -0
- package/dist/esm/types/Block.types.js +1 -0
- package/dist/esm/types/Contract.types.d.ts +24 -0
- package/dist/esm/types/Contract.types.js +1 -0
- package/dist/esm/types/Network.types.d.ts +5 -0
- package/dist/esm/types/Network.types.js +1 -0
- package/dist/esm/types/Transaction.types.d.ts +34 -0
- package/dist/esm/types/Transaction.types.js +1 -0
- package/dist/esm/utils/ether-to-wei.d.ts +3 -0
- package/dist/esm/utils/ether-to-wei.js +7 -0
- package/dist/esm/utils/index.d.ts +5 -0
- package/dist/esm/utils/index.js +5 -0
- package/dist/esm/utils/is-address.d.ts +1 -0
- package/dist/esm/utils/is-address.js +12 -0
- package/dist/esm/utils/to-checksum-address.d.ts +1 -0
- package/dist/esm/utils/to-checksum-address.js +25 -0
- package/dist/esm/utils/wei-to-ether.d.ts +3 -0
- package/dist/esm/utils/wei-to-ether.js +7 -0
- package/package.json +7 -21
- package/..eslintrc.js.un~ +0 -0
- package/..npmignore.un~ +0 -0
- package/.env +0 -1
- package/.eslintignore +0 -4
- package/.eslintrc.js +0 -34
- package/.gitattributes +0 -1
- package/.github/workflows/.test.yml.un~ +0 -0
- package/.github/workflows/test.yml +0 -29
- package/.package.json.un~ +0 -0
- package/.prettierignore +0 -7
- package/.travis.yml +0 -5
- package/jest.config.js +0 -9
- package/scripts/build-website.sh +0 -4
- package/scripts/bump-minor.sh +0 -4
- package/scripts/bump-patch.sh +0 -4
- package/scripts/fetch-chains-info.ts +0 -70
- package/scripts/pre-commit.sh +0 -5
- package/src/classes/Contract.ts +0 -161
- package/src/classes/test/Contract/crv-abi.ts +0 -488
- package/src/classes/test/Contract/crv.test.ts +0 -56
- package/src/classes/test/Contract/ens-abi.ts +0 -452
- package/src/classes/test/Contract/ens.test.ts +0 -39
- package/src/classes/test/Contract/fei-abi.ts +0 -526
- package/src/classes/test/Contract/fei.test.ts +0 -86
- package/src/classes/test/Contract/foo-abi.ts +0 -42
- package/src/classes/test/Contract/foo.test.ts +0 -33
- package/src/classes/test/Contract/uni.test.ts +0 -72
- package/src/classes/test/Contract/uniswap-abi.ts +0 -121
- package/src/classes/utils/clean-block.ts +0 -49
- package/src/classes/utils/clean-transaction.ts +0 -35
- package/src/classes/utils/encode-decode-transaction.ts +0 -126
- package/src/classes/utils/fetchers.ts +0 -27
- package/src/providers/JsonRpcProvider.ts +0 -94
- package/src/providers/test/get-block.test.ts +0 -63
- package/src/providers/test/get-network.test.ts +0 -34
- package/src/providers/utils/chains-info.ts +0 -1079
- package/src/shared/tiny-big/helpers.test.ts +0 -30
- package/src/shared/tiny-big/helpers.ts +0 -89
- package/src/shared/tiny-big/tiny-big.test.ts +0 -10
- package/src/shared/tiny-big/tiny-big.ts +0 -36
- package/src/shared/validate-type.ts +0 -20
- package/src/types/.Contract.types.ts.un~ +0 -0
- package/src/types/Block.types.ts +0 -50
- package/src/types/Contract.types.ts +0 -67
- package/src/types/Network.types.ts +0 -8
- package/src/types/Transaction.types.ts +0 -35
- package/src/utils/is-address.ts +0 -16
- package/src/utils/tests/ether-to-wei.test.ts +0 -65
- package/src/utils/tests/is-address.test.ts +0 -52
- package/src/utils/tests/to-checksum-address.test.ts +0 -43
- package/src/utils/tests/wei-to-ether.test.ts +0 -72
- package/src/utils/to-checksum-address.ts +0 -47
- package/test/global-setup.js +0 -8
- package/test/global-teardown.js +0 -5
- package/test/jest.setup-after-env.js +0 -1
- package/test/server.js +0 -24
- package/tsconfig-cjs.json +0 -8
- package/tsconfig.json +0 -25
- package/typedoc/options-new-version.js +0 -8
- package/typedoc/options.js +0 -9
- package/types/just-omit.d.ts +0 -1
- package/website/.nojekyll +0 -1
- package/website/assets/highlight.css +0 -71
- package/website/assets/icons.css +0 -1043
- package/website/assets/icons.png +0 -0
- package/website/assets/icons@2x.png +0 -0
- package/website/assets/main.js +0 -52
- package/website/assets/search.js +0 -1
- package/website/assets/style.css +0 -1413
- package/website/assets/widgets.png +0 -0
- package/website/assets/widgets@2x.png +0 -0
- package/website/classes/Contract.html +0 -13
- package/website/classes/JsonRpcProvider.html +0 -8
- package/website/classes/TinyBig.html +0 -161
- package/website/index.html +0 -207
- package/website/interfaces/Block.html +0 -1
- package/website/interfaces/JSONABIArgument.html +0 -1
- package/website/interfaces/Network.html +0 -3
- package/website/interfaces/Transaction.html +0 -1
- package/website/modules.html +0 -32
- package/website/versions/0.1.2/assets/highlight.css +0 -57
- package/website/versions/0.1.2/assets/icons.css +0 -1043
- package/website/versions/0.1.2/assets/icons.png +0 -0
- package/website/versions/0.1.2/assets/icons@2x.png +0 -0
- package/website/versions/0.1.2/assets/main.js +0 -52
- package/website/versions/0.1.2/assets/search.js +0 -1
- package/website/versions/0.1.2/assets/style.css +0 -1341
- package/website/versions/0.1.2/assets/widgets.png +0 -0
- package/website/versions/0.1.2/assets/widgets@2x.png +0 -0
- package/website/versions/0.1.2/classes/TinyBig.html +0 -4
- package/website/versions/0.1.2/index.html +0 -20
- package/website/versions/0.1.2/modules.html +0 -23
- package/website/versions/0.1.3/assets/highlight.css +0 -64
- package/website/versions/0.1.3/assets/icons.css +0 -1043
- package/website/versions/0.1.3/assets/icons.png +0 -0
- package/website/versions/0.1.3/assets/icons@2x.png +0 -0
- package/website/versions/0.1.3/assets/main.js +0 -52
- package/website/versions/0.1.3/assets/search.js +0 -1
- package/website/versions/0.1.3/assets/style.css +0 -1341
- package/website/versions/0.1.3/assets/widgets.png +0 -0
- package/website/versions/0.1.3/assets/widgets@2x.png +0 -0
- package/website/versions/0.1.3/classes/TinyBig.html +0 -4
- package/website/versions/0.1.3/index.html +0 -53
- package/website/versions/0.1.3/modules.html +0 -23
- package/website/versions/0.1.4/assets/highlight.css +0 -64
- package/website/versions/0.1.4/assets/icons.css +0 -1043
- package/website/versions/0.1.4/assets/icons.png +0 -0
- package/website/versions/0.1.4/assets/icons@2x.png +0 -0
- package/website/versions/0.1.4/assets/main.js +0 -52
- package/website/versions/0.1.4/assets/search.js +0 -1
- package/website/versions/0.1.4/assets/style.css +0 -1341
- package/website/versions/0.1.4/assets/widgets.png +0 -0
- package/website/versions/0.1.4/assets/widgets@2x.png +0 -0
- package/website/versions/0.1.4/classes/EssentialEth.html +0 -1
- package/website/versions/0.1.4/classes/TinyBig.html +0 -4
- package/website/versions/0.1.4/index.html +0 -58
- package/website/versions/0.1.4/modules.html +0 -23
- package/website/versions/0.2.0/assets/highlight.css +0 -64
- package/website/versions/0.2.0/assets/icons.css +0 -1043
- package/website/versions/0.2.0/assets/icons.png +0 -0
- package/website/versions/0.2.0/assets/icons@2x.png +0 -0
- package/website/versions/0.2.0/assets/main.js +0 -52
- package/website/versions/0.2.0/assets/search.js +0 -1
- package/website/versions/0.2.0/assets/style.css +0 -1341
- package/website/versions/0.2.0/assets/widgets.png +0 -0
- package/website/versions/0.2.0/assets/widgets@2x.png +0 -0
- package/website/versions/0.2.0/classes/EssentialEth.html +0 -5
- package/website/versions/0.2.0/classes/TinyBig.html +0 -146
- package/website/versions/0.2.0/index.html +0 -89
- package/website/versions/0.2.0/modules.html +0 -25
- package/website/versions/0.2.1/assets/highlight.css +0 -64
- package/website/versions/0.2.1/assets/icons.css +0 -1043
- package/website/versions/0.2.1/assets/icons.png +0 -0
- package/website/versions/0.2.1/assets/icons@2x.png +0 -0
- package/website/versions/0.2.1/assets/main.js +0 -52
- package/website/versions/0.2.1/assets/search.js +0 -1
- package/website/versions/0.2.1/assets/style.css +0 -1341
- package/website/versions/0.2.1/assets/widgets.png +0 -0
- package/website/versions/0.2.1/assets/widgets@2x.png +0 -0
- package/website/versions/0.2.1/classes/EssentialEth.html +0 -5
- package/website/versions/0.2.1/classes/TinyBig.html +0 -146
- package/website/versions/0.2.1/index.html +0 -96
- package/website/versions/0.2.1/modules.html +0 -29
- package/website/versions/0.2.2/assets/highlight.css +0 -64
- package/website/versions/0.2.2/assets/icons.css +0 -1043
- package/website/versions/0.2.2/assets/icons.png +0 -0
- package/website/versions/0.2.2/assets/icons@2x.png +0 -0
- package/website/versions/0.2.2/assets/main.js +0 -52
- package/website/versions/0.2.2/assets/search.js +0 -1
- package/website/versions/0.2.2/assets/style.css +0 -1341
- package/website/versions/0.2.2/assets/widgets.png +0 -0
- package/website/versions/0.2.2/assets/widgets@2x.png +0 -0
- package/website/versions/0.2.2/classes/EssentialEth.html +0 -5
- package/website/versions/0.2.2/classes/TinyBig.html +0 -146
- package/website/versions/0.2.2/index.html +0 -96
- package/website/versions/0.2.2/modules.html +0 -29
- package/website/versions/0.3.0/.nojekyll +0 -1
- package/website/versions/0.3.0/assets/highlight.css +0 -71
- package/website/versions/0.3.0/assets/icons.css +0 -1043
- package/website/versions/0.3.0/assets/icons.png +0 -0
- package/website/versions/0.3.0/assets/icons@2x.png +0 -0
- package/website/versions/0.3.0/assets/main.js +0 -52
- package/website/versions/0.3.0/assets/search.js +0 -1
- package/website/versions/0.3.0/assets/style.css +0 -1384
- package/website/versions/0.3.0/assets/widgets.png +0 -0
- package/website/versions/0.3.0/assets/widgets@2x.png +0 -0
- package/website/versions/0.3.0/classes/Contract.html +0 -15
- package/website/versions/0.3.0/classes/TinyBig.html +0 -156
- package/website/versions/0.3.0/index.html +0 -123
- package/website/versions/0.3.0/modules.html +0 -32
- package/website/versions/0.3.1/.nojekyll +0 -1
- package/website/versions/0.3.1/assets/highlight.css +0 -71
- package/website/versions/0.3.1/assets/icons.css +0 -1043
- package/website/versions/0.3.1/assets/icons.png +0 -0
- package/website/versions/0.3.1/assets/icons@2x.png +0 -0
- package/website/versions/0.3.1/assets/main.js +0 -52
- package/website/versions/0.3.1/assets/search.js +0 -1
- package/website/versions/0.3.1/assets/style.css +0 -1384
- package/website/versions/0.3.1/assets/widgets.png +0 -0
- package/website/versions/0.3.1/assets/widgets@2x.png +0 -0
- package/website/versions/0.3.1/classes/Contract.html +0 -15
- package/website/versions/0.3.1/classes/TinyBig.html +0 -156
- package/website/versions/0.3.1/index.html +0 -123
- package/website/versions/0.3.1/modules.html +0 -32
- package/website/versions/0.3.2/.nojekyll +0 -1
- package/website/versions/0.3.2/assets/highlight.css +0 -71
- package/website/versions/0.3.2/assets/icons.css +0 -1043
- package/website/versions/0.3.2/assets/icons.png +0 -0
- package/website/versions/0.3.2/assets/icons@2x.png +0 -0
- package/website/versions/0.3.2/assets/main.js +0 -52
- package/website/versions/0.3.2/assets/search.js +0 -1
- package/website/versions/0.3.2/assets/style.css +0 -1384
- package/website/versions/0.3.2/assets/widgets.png +0 -0
- package/website/versions/0.3.2/assets/widgets@2x.png +0 -0
- package/website/versions/0.3.2/classes/Contract.html +0 -15
- package/website/versions/0.3.2/classes/JsonRpcProvider.html +0 -5
- package/website/versions/0.3.2/classes/TinyBig.html +0 -156
- package/website/versions/0.3.2/index.html +0 -123
- package/website/versions/0.3.2/modules.html +0 -32
- package/website/versions/0.3.3/.nojekyll +0 -1
- package/website/versions/0.3.3/assets/highlight.css +0 -71
- package/website/versions/0.3.3/assets/icons.css +0 -1043
- package/website/versions/0.3.3/assets/icons.png +0 -0
- package/website/versions/0.3.3/assets/icons@2x.png +0 -0
- package/website/versions/0.3.3/assets/main.js +0 -52
- package/website/versions/0.3.3/assets/search.js +0 -1
- package/website/versions/0.3.3/assets/style.css +0 -1384
- package/website/versions/0.3.3/assets/widgets.png +0 -0
- package/website/versions/0.3.3/assets/widgets@2x.png +0 -0
- package/website/versions/0.3.3/classes/Contract.html +0 -15
- package/website/versions/0.3.3/classes/JsonRpcProvider.html +0 -5
- package/website/versions/0.3.3/classes/TinyBig.html +0 -156
- package/website/versions/0.3.3/index.html +0 -123
- package/website/versions/0.3.3/interfaces/Block.html +0 -1
- package/website/versions/0.3.3/interfaces/Transaction.html +0 -1
- package/website/versions/0.3.3/modules.html +0 -32
- package/website/versions/0.4.0/.nojekyll +0 -1
- package/website/versions/0.4.0/assets/highlight.css +0 -71
- package/website/versions/0.4.0/assets/icons.css +0 -1043
- package/website/versions/0.4.0/assets/icons.png +0 -0
- package/website/versions/0.4.0/assets/icons@2x.png +0 -0
- package/website/versions/0.4.0/assets/main.js +0 -52
- package/website/versions/0.4.0/assets/search.js +0 -1
- package/website/versions/0.4.0/assets/style.css +0 -1384
- package/website/versions/0.4.0/assets/widgets.png +0 -0
- package/website/versions/0.4.0/assets/widgets@2x.png +0 -0
- package/website/versions/0.4.0/classes/Contract.html +0 -15
- package/website/versions/0.4.0/classes/JsonRpcProvider.html +0 -6
- package/website/versions/0.4.0/classes/TinyBig.html +0 -156
- package/website/versions/0.4.0/index.html +0 -148
- package/website/versions/0.4.0/interfaces/Block.html +0 -1
- package/website/versions/0.4.0/interfaces/Transaction.html +0 -1
- package/website/versions/0.4.0/modules.html +0 -32
- package/website/versions/0.4.1/.nojekyll +0 -1
- package/website/versions/0.4.1/assets/highlight.css +0 -71
- package/website/versions/0.4.1/assets/icons.css +0 -1043
- package/website/versions/0.4.1/assets/icons.png +0 -0
- package/website/versions/0.4.1/assets/icons@2x.png +0 -0
- package/website/versions/0.4.1/assets/main.js +0 -52
- package/website/versions/0.4.1/assets/search.js +0 -1
- package/website/versions/0.4.1/assets/style.css +0 -1384
- package/website/versions/0.4.1/assets/widgets.png +0 -0
- package/website/versions/0.4.1/assets/widgets@2x.png +0 -0
- package/website/versions/0.4.1/classes/Contract.html +0 -15
- package/website/versions/0.4.1/classes/JsonRpcProvider.html +0 -6
- package/website/versions/0.4.1/classes/TinyBig.html +0 -156
- package/website/versions/0.4.1/index.html +0 -148
- package/website/versions/0.4.1/interfaces/Block.html +0 -1
- package/website/versions/0.4.1/interfaces/Transaction.html +0 -1
- package/website/versions/0.4.1/modules.html +0 -32
- package/website/versions/0.4.2/.nojekyll +0 -1
- package/website/versions/0.4.2/assets/highlight.css +0 -71
- package/website/versions/0.4.2/assets/icons.css +0 -1043
- package/website/versions/0.4.2/assets/icons.png +0 -0
- package/website/versions/0.4.2/assets/icons@2x.png +0 -0
- package/website/versions/0.4.2/assets/main.js +0 -52
- package/website/versions/0.4.2/assets/search.js +0 -1
- package/website/versions/0.4.2/assets/style.css +0 -1384
- package/website/versions/0.4.2/assets/widgets.png +0 -0
- package/website/versions/0.4.2/assets/widgets@2x.png +0 -0
- package/website/versions/0.4.2/classes/Contract.html +0 -15
- package/website/versions/0.4.2/classes/JsonRpcProvider.html +0 -8
- package/website/versions/0.4.2/classes/TinyBig.html +0 -156
- package/website/versions/0.4.2/index.html +0 -199
- package/website/versions/0.4.2/interfaces/Block.html +0 -1
- package/website/versions/0.4.2/interfaces/Transaction.html +0 -1
- package/website/versions/0.4.2/modules.html +0 -34
- package/website/versions/0.4.3/.nojekyll +0 -1
- package/website/versions/0.4.3/assets/highlight.css +0 -71
- package/website/versions/0.4.3/assets/icons.css +0 -1043
- package/website/versions/0.4.3/assets/icons.png +0 -0
- package/website/versions/0.4.3/assets/icons@2x.png +0 -0
- package/website/versions/0.4.3/assets/main.js +0 -52
- package/website/versions/0.4.3/assets/search.js +0 -1
- package/website/versions/0.4.3/assets/style.css +0 -1384
- package/website/versions/0.4.3/assets/widgets.png +0 -0
- package/website/versions/0.4.3/assets/widgets@2x.png +0 -0
- package/website/versions/0.4.3/classes/Contract.html +0 -15
- package/website/versions/0.4.3/classes/JsonRpcProvider.html +0 -8
- package/website/versions/0.4.3/classes/TinyBig.html +0 -159
- package/website/versions/0.4.3/index.html +0 -199
- package/website/versions/0.4.3/interfaces/Block.html +0 -1
- package/website/versions/0.4.3/interfaces/Transaction.html +0 -1
- package/website/versions/0.4.3/modules.html +0 -34
- package/website/versions/0.4.6/.nojekyll +0 -1
- package/website/versions/0.4.6/assets/highlight.css +0 -71
- package/website/versions/0.4.6/assets/icons.css +0 -1043
- package/website/versions/0.4.6/assets/icons.png +0 -0
- package/website/versions/0.4.6/assets/icons@2x.png +0 -0
- package/website/versions/0.4.6/assets/main.js +0 -52
- package/website/versions/0.4.6/assets/search.js +0 -1
- package/website/versions/0.4.6/assets/style.css +0 -1413
- package/website/versions/0.4.6/assets/widgets.png +0 -0
- package/website/versions/0.4.6/assets/widgets@2x.png +0 -0
- package/website/versions/0.4.6/classes/Contract.html +0 -15
- package/website/versions/0.4.6/classes/JsonRpcProvider.html +0 -8
- package/website/versions/0.4.6/classes/TinyBig.html +0 -159
- package/website/versions/0.4.6/index.html +0 -207
- package/website/versions/0.4.6/interfaces/Block.html +0 -1
- package/website/versions/0.4.6/interfaces/Transaction.html +0 -1
- package/website/versions/0.4.6/modules.html +0 -34
- package/website/versions/0.4.8/.nojekyll +0 -1
- package/website/versions/0.4.8/assets/highlight.css +0 -71
- package/website/versions/0.4.8/assets/icons.css +0 -1043
- package/website/versions/0.4.8/assets/icons.png +0 -0
- package/website/versions/0.4.8/assets/icons@2x.png +0 -0
- package/website/versions/0.4.8/assets/main.js +0 -52
- package/website/versions/0.4.8/assets/search.js +0 -1
- package/website/versions/0.4.8/assets/style.css +0 -1413
- package/website/versions/0.4.8/assets/widgets.png +0 -0
- package/website/versions/0.4.8/assets/widgets@2x.png +0 -0
- package/website/versions/0.4.8/classes/Contract.html +0 -15
- package/website/versions/0.4.8/classes/JsonRpcProvider.html +0 -8
- package/website/versions/0.4.8/classes/TinyBig.html +0 -161
- package/website/versions/0.4.8/index.html +0 -207
- package/website/versions/0.4.8/interfaces/Block.html +0 -1
- package/website/versions/0.4.8/interfaces/Transaction.html +0 -1
- package/website/versions/0.4.8/modules.html +0 -34
- package/website/versions/0.4.9-beta.0/.nojekyll +0 -1
- package/website/versions/0.4.9-beta.0/assets/highlight.css +0 -71
- package/website/versions/0.4.9-beta.0/assets/icons.css +0 -1043
- package/website/versions/0.4.9-beta.0/assets/icons.png +0 -0
- package/website/versions/0.4.9-beta.0/assets/icons@2x.png +0 -0
- package/website/versions/0.4.9-beta.0/assets/main.js +0 -52
- package/website/versions/0.4.9-beta.0/assets/search.js +0 -1
- package/website/versions/0.4.9-beta.0/assets/style.css +0 -1413
- package/website/versions/0.4.9-beta.0/assets/widgets.png +0 -0
- package/website/versions/0.4.9-beta.0/assets/widgets@2x.png +0 -0
- package/website/versions/0.4.9-beta.0/classes/Contract.html +0 -13
- package/website/versions/0.4.9-beta.0/classes/JsonRpcProvider.html +0 -8
- package/website/versions/0.4.9-beta.0/classes/TinyBig.html +0 -161
- package/website/versions/0.4.9-beta.0/index.html +0 -207
- package/website/versions/0.4.9-beta.0/interfaces/Block.html +0 -1
- package/website/versions/0.4.9-beta.0/interfaces/JSONABIArgument.html +0 -1
- package/website/versions/0.4.9-beta.0/interfaces/Network.html +0 -3
- package/website/versions/0.4.9-beta.0/interfaces/Transaction.html +0 -1
- package/website/versions/0.4.9-beta.0/modules.html +0 -32
- package/website/versions/versions/0.1.2/assets/highlight.css +0 -57
- package/website/versions/versions/0.1.2/assets/icons.css +0 -1043
- package/website/versions/versions/0.1.2/assets/icons.png +0 -0
- package/website/versions/versions/0.1.2/assets/icons@2x.png +0 -0
- package/website/versions/versions/0.1.2/assets/main.js +0 -52
- package/website/versions/versions/0.1.2/assets/search.js +0 -1
- package/website/versions/versions/0.1.2/assets/style.css +0 -1341
- package/website/versions/versions/0.1.2/assets/widgets.png +0 -0
- package/website/versions/versions/0.1.2/assets/widgets@2x.png +0 -0
- package/website/versions/versions/0.1.2/classes/TinyBig.html +0 -4
- package/website/versions/versions/0.1.2/index.html +0 -20
- package/website/versions/versions/0.1.2/modules.html +0 -23
- package/website/versions/versions/0.1.3/assets/highlight.css +0 -64
- package/website/versions/versions/0.1.3/assets/icons.css +0 -1043
- package/website/versions/versions/0.1.3/assets/icons.png +0 -0
- package/website/versions/versions/0.1.3/assets/icons@2x.png +0 -0
- package/website/versions/versions/0.1.3/assets/main.js +0 -52
- package/website/versions/versions/0.1.3/assets/search.js +0 -1
- package/website/versions/versions/0.1.3/assets/style.css +0 -1341
- package/website/versions/versions/0.1.3/assets/widgets.png +0 -0
- package/website/versions/versions/0.1.3/assets/widgets@2x.png +0 -0
- package/website/versions/versions/0.1.3/classes/TinyBig.html +0 -4
- package/website/versions/versions/0.1.3/index.html +0 -53
- package/website/versions/versions/0.1.3/modules.html +0 -23
- package/website/versions/versions/0.1.4/assets/highlight.css +0 -64
- package/website/versions/versions/0.1.4/assets/icons.css +0 -1043
- package/website/versions/versions/0.1.4/assets/icons.png +0 -0
- package/website/versions/versions/0.1.4/assets/icons@2x.png +0 -0
- package/website/versions/versions/0.1.4/assets/main.js +0 -52
- package/website/versions/versions/0.1.4/assets/search.js +0 -1
- package/website/versions/versions/0.1.4/assets/style.css +0 -1341
- package/website/versions/versions/0.1.4/assets/widgets.png +0 -0
- package/website/versions/versions/0.1.4/assets/widgets@2x.png +0 -0
- package/website/versions/versions/0.1.4/classes/TinyBig.html +0 -4
- package/website/versions/versions/0.1.4/index.html +0 -58
- package/website/versions/versions/0.1.4/modules.html +0 -23
|
Binary file
|
|
Binary file
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>EssentialEth | essential-eth - v0.2.0</title><meta name="description" content="Documentation for essential-eth - v0.2.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">essential-eth - v0.2.0</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">essential-eth - v0.2.0</a></li><li><a href="EssentialEth.html">EssentialEth</a></li></ul><h1>Class EssentialEth</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">EssentialEth</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="EssentialEth.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="EssentialEth.html#_rpcUrl" class="tsd-kind-icon">_rpc<wbr/>Url</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="EssentialEth.html#getBlock" class="tsd-kind-icon">get<wbr/>Block</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Essential<wbr/>Eth<span class="tsd-signature-symbol">(</span>rpcUrl<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="EssentialEth.html" class="tsd-signature-type" data-tsd-kind="Class">EssentialEth</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dawsbot/essential-eth/blob/55b38a5/src/rpc/index.ts#L9">src/rpc/index.ts:9</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> rpcUrl: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="EssentialEth.html" class="tsd-signature-type" data-tsd-kind="Class">EssentialEth</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a name="_rpcUrl" class="tsd-anchor"></a><h3>_rpc<wbr/>Url</h3><div class="tsd-signature tsd-kind-icon">_rpc<wbr/>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dawsbot/essential-eth/blob/55b38a5/src/rpc/index.ts#L8">src/rpc/index.ts:8</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
2
|
-
<p>The URL to your Eth node. Consider POKT or Infura</p>
|
|
3
|
-
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="getBlock" class="tsd-anchor"></a><h3>get<wbr/>Block</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Block<span class="tsd-signature-symbol">(</span>timeFrame<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"latest"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"earliest"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"pending"</span>, returnTransactionObjects<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Block</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dawsbot/essential-eth/blob/55b38a5/src/rpc/index.ts#L16">src/rpc/index.ts:16</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
4
|
-
<p>Returns the block requested</p>
|
|
5
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>timeFrame: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"latest"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"earliest"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"pending"</span></h5></li><li><h5>returnTransactionObjects: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Block</span><span class="tsd-signature-symbol">></span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="EssentialEth.html" class="tsd-kind-icon">Essential<wbr/>Eth</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="EssentialEth.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="EssentialEth.html#_rpcUrl" class="tsd-kind-icon">_rpc<wbr/>Url</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="EssentialEth.html#getBlock" class="tsd-kind-icon">get<wbr/>Block</a></li></ul></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
|
@@ -1,146 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>TinyBig | essential-eth - v0.2.0</title><meta name="description" content="Documentation for essential-eth - v0.2.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">essential-eth - v0.2.0</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">essential-eth - v0.2.0</a></li><li><a href="TinyBig.html">TinyBig</a></li></ul><h1>Class TinyBig</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
2
|
-
<p>A wrapper around big.js which expands scientific notation. This is the return type of every operation on ether, wei, etc.
|
|
3
|
-
The only important things to know are the "toString" and "toNumber" functions</p>
|
|
4
|
-
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Big</span><ul class="tsd-hierarchy"><li><span class="target">TinyBig</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="TinyBig.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-inherited tsd-is-external"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#c" class="tsd-kind-icon">c</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#e" class="tsd-kind-icon">e</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#s" class="tsd-kind-icon">s</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="TinyBig.html#DP" class="tsd-kind-icon">DP</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="TinyBig.html#NE" class="tsd-kind-icon">NE</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="TinyBig.html#PE" class="tsd-kind-icon">PE</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="TinyBig.html#RM" class="tsd-kind-icon">RM</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="TinyBig.html#roundDown" class="tsd-kind-icon">round<wbr/>Down</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="TinyBig.html#roundHalfEven" class="tsd-kind-icon">round<wbr/>Half<wbr/>Even</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="TinyBig.html#roundHalfUp" class="tsd-kind-icon">round<wbr/>Half<wbr/>Up</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="TinyBig.html#roundUp" class="tsd-kind-icon">round<wbr/>Up</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#abs" class="tsd-kind-icon">abs</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#add" class="tsd-kind-icon">add</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#cmp" class="tsd-kind-icon">cmp</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#div" class="tsd-kind-icon">div</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#eq" class="tsd-kind-icon">eq</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#gt" class="tsd-kind-icon">gt</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#gte" class="tsd-kind-icon">gte</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#lt" class="tsd-kind-icon">lt</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#lte" class="tsd-kind-icon">lte</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#minus" class="tsd-kind-icon">minus</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#mod" class="tsd-kind-icon">mod</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#mul" class="tsd-kind-icon">mul</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#plus" class="tsd-kind-icon">plus</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#pow" class="tsd-kind-icon">pow</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#prec" class="tsd-kind-icon">prec</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#round" class="tsd-kind-icon">round</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#sqrt" class="tsd-kind-icon">sqrt</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#sub" class="tsd-kind-icon">sub</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#times" class="tsd-kind-icon">times</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#toExponential" class="tsd-kind-icon">to<wbr/>Exponential</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#toFixed" class="tsd-kind-icon">to<wbr/>Fixed</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#toJSON" class="tsd-kind-icon">toJSON</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="TinyBig.html#toNumber" class="tsd-kind-icon">to<wbr/>Number</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#toPrecision" class="tsd-kind-icon">to<wbr/>Precision</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="TinyBig.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#valueOf" class="tsd-kind-icon">value<wbr/>Of</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a name="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Tiny<wbr/>Big<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TinyBig.html" class="tsd-signature-type" data-tsd-kind="Class">TinyBig</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides Big.constructor</p><ul><li>Defined in <a href="https://github.com/dawsbot/essential-eth/blob/55b38a5/src/shared/tiny-big/tiny-big.ts#L9">src/shared/tiny-big/tiny-big.ts:9</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>value: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="TinyBig.html" class="tsd-signature-type" data-tsd-kind="Class">TinyBig</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-external"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="c" class="tsd-anchor"></a><h3>c</h3><div class="tsd-signature tsd-kind-icon">c<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from Big.c</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:342</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
5
|
-
<p>Returns an array of single digits</p>
|
|
6
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="e" class="tsd-anchor"></a><h3>e</h3><div class="tsd-signature tsd-kind-icon">e<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from Big.e</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:346</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
7
|
-
<p>Returns the exponent, Integer, -1e+6 to 1e+6 inclusive</p>
|
|
8
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="s" class="tsd-anchor"></a><h3>s</h3><div class="tsd-signature tsd-kind-icon">s<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from Big.s</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:350</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
9
|
-
<p>Returns the sign, -1 or 1</p>
|
|
10
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a name="DP" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> DP</h3><div class="tsd-signature tsd-kind-icon">DP<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from Big.DP</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:80</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
11
|
-
<p>The maximum number of decimal places of the results of operations involving division.
|
|
12
|
-
It is relevant only to the div and sqrt methods, and the pow method when the exponent is negative.</p>
|
|
13
|
-
</div><div><p>0 to 1e+6 inclusive
|
|
14
|
-
Default value: 20</p>
|
|
15
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a name="NE" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> NE</h3><div class="tsd-signature tsd-kind-icon">NE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from Big.NE</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:92</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
16
|
-
<p>The negative exponent value at and below which toString returns exponential notation.</p>
|
|
17
|
-
</div><div><p>-1e+6 to 0 inclusive
|
|
18
|
-
Default value: -7</p>
|
|
19
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a name="PE" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> PE</h3><div class="tsd-signature tsd-kind-icon">PE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from Big.PE</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:99</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
20
|
-
<p>The positive exponent value at and above which toString returns exponential notation.</p>
|
|
21
|
-
</div><div><p>0 to 1e+6 inclusive
|
|
22
|
-
Default value: 21</p>
|
|
23
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a name="RM" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> RM</h3><div class="tsd-signature tsd-kind-icon">RM<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from Big.RM</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:85</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
24
|
-
<p>The rounding mode used in the above operations and by round, toExponential, toFixed and toPrecision.
|
|
25
|
-
Default value: 1</p>
|
|
26
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a name="roundDown" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> round<wbr/>Down</h3><div class="tsd-signature tsd-kind-icon">round<wbr/>Down<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RoundDown</span></div><aside class="tsd-sources"><p>Inherited from Big.roundDown</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:107</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
27
|
-
<p>Rounds towards zero.
|
|
28
|
-
I.e. truncate, no rounding.</p>
|
|
29
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a name="roundHalfEven" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> round<wbr/>Half<wbr/>Even</h3><div class="tsd-signature tsd-kind-icon">round<wbr/>Half<wbr/>Even<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RoundHalfEven</span></div><aside class="tsd-sources"><p>Inherited from Big.roundHalfEven</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:117</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
30
|
-
<p>Rounds towards nearest neighbour.
|
|
31
|
-
If equidistant, rounds towards even neighbour.</p>
|
|
32
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a name="roundHalfUp" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> round<wbr/>Half<wbr/>Up</h3><div class="tsd-signature tsd-kind-icon">round<wbr/>Half<wbr/>Up<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RoundHalfUp</span></div><aside class="tsd-sources"><p>Inherited from Big.roundHalfUp</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:112</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
33
|
-
<p>Rounds towards nearest neighbour.
|
|
34
|
-
If equidistant, rounds away from zero.</p>
|
|
35
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a name="roundUp" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> round<wbr/>Up</h3><div class="tsd-signature tsd-kind-icon">round<wbr/>Up<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RoundUp</span></div><aside class="tsd-sources"><p>Inherited from Big.roundUp</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:121</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
36
|
-
<p>Rounds away from zero.</p>
|
|
37
|
-
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="abs" class="tsd-anchor"></a><h3>abs</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">abs<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Big</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Big.abs</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:126</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
38
|
-
<p>Returns a Big number whose value is the absolute value, i.e. the magnitude, of this Big number.</p>
|
|
39
|
-
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Big</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="add" class="tsd-anchor"></a><h3>add</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">add<span class="tsd-signature-symbol">(</span>n<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigSource</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Big</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Big.add</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:132</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
40
|
-
<p>Returns a Big number whose value is the value of this Big number plus n - alias for .plus().</p>
|
|
41
|
-
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><code>NaN</code> if n is invalid.</p>
|
|
42
|
-
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>n: <span class="tsd-signature-type">BigSource</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Big</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="cmp" class="tsd-anchor"></a><h3>cmp</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">cmp<span class="tsd-signature-symbol">(</span>n<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigSource</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Comparison</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Big.cmp</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:138</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
43
|
-
<p>Compare the values.</p>
|
|
44
|
-
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><code>NaN</code> if n is invalid.</p>
|
|
45
|
-
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>n: <span class="tsd-signature-type">BigSource</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Comparison</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="div" class="tsd-anchor"></a><h3>div</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">div<span class="tsd-signature-symbol">(</span>n<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigSource</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Big</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Big.div</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:148</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
46
|
-
<p>Returns a Big number whose value is the value of this Big number divided by n.</p>
|
|
47
|
-
</div><div><p>If the result has more fraction digits than is specified by Big.DP, it will be rounded to Big.DP decimal places using rounding mode Big.RM.</p>
|
|
48
|
-
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><code>NaN</code> if n is invalid.</p>
|
|
49
|
-
</dd><dt>throws</dt><dd><p><code>±Infinity</code> on division by zero.</p>
|
|
50
|
-
</dd><dt>throws</dt><dd><p><code>NaN</code> on division of zero by zero.</p>
|
|
51
|
-
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>n: <span class="tsd-signature-type">BigSource</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Big</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="eq" class="tsd-anchor"></a><h3>eq</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">eq<span class="tsd-signature-symbol">(</span>n<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigSource</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Big.eq</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:154</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
52
|
-
<p>Returns true if the value of this Big equals the value of n, otherwise returns false.</p>
|
|
53
|
-
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><code>NaN</code> if n is invalid.</p>
|
|
54
|
-
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>n: <span class="tsd-signature-type">BigSource</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="gt" class="tsd-anchor"></a><h3>gt</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">gt<span class="tsd-signature-symbol">(</span>n<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigSource</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Big.gt</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:160</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
55
|
-
<p>Returns true if the value of this Big is greater than the value of n, otherwise returns false.</p>
|
|
56
|
-
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><code>NaN</code> if n is invalid.</p>
|
|
57
|
-
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>n: <span class="tsd-signature-type">BigSource</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="gte" class="tsd-anchor"></a><h3>gte</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">gte<span class="tsd-signature-symbol">(</span>n<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigSource</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Big.gte</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:166</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
58
|
-
<p>Returns true if the value of this Big is greater than or equal to the value of n, otherwise returns false.</p>
|
|
59
|
-
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><code>NaN</code> if n is invalid.</p>
|
|
60
|
-
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>n: <span class="tsd-signature-type">BigSource</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="lt" class="tsd-anchor"></a><h3>lt</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">lt<span class="tsd-signature-symbol">(</span>n<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigSource</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Big.lt</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:172</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
61
|
-
<p>Returns true if the value of this Big is less than the value of n, otherwise returns false.</p>
|
|
62
|
-
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><code>NaN</code> if n is invalid.</p>
|
|
63
|
-
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>n: <span class="tsd-signature-type">BigSource</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="lte" class="tsd-anchor"></a><h3>lte</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">lte<span class="tsd-signature-symbol">(</span>n<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigSource</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Big.lte</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:178</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
64
|
-
<p>Returns true if the value of this Big is less than or equal to the value of n, otherwise returns false.</p>
|
|
65
|
-
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><code>NaN</code> if n is invalid.</p>
|
|
66
|
-
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>n: <span class="tsd-signature-type">BigSource</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="minus" class="tsd-anchor"></a><h3>minus</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">minus<span class="tsd-signature-symbol">(</span>n<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigSource</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Big</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Big.minus</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:184</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
67
|
-
<p>Returns a Big number whose value is the value of this Big number minus n.</p>
|
|
68
|
-
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><code>NaN</code> if n is invalid.</p>
|
|
69
|
-
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>n: <span class="tsd-signature-type">BigSource</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Big</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="mod" class="tsd-anchor"></a><h3>mod</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">mod<span class="tsd-signature-symbol">(</span>n<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigSource</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Big</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Big.mod</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:192</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
70
|
-
<p>Returns a Big number whose value is the value of this Big number modulo n, i.e. the integer remainder of dividing this Big number by n.</p>
|
|
71
|
-
</div><div><p>The result will have the same sign as this Big number, and it will match that of Javascript's % operator (within the limits of its precision) and BigDecimal's remainder method.</p>
|
|
72
|
-
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><code>NaN</code> if n is negative or otherwise invalid.</p>
|
|
73
|
-
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>n: <span class="tsd-signature-type">BigSource</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Big</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="mul" class="tsd-anchor"></a><h3>mul</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">mul<span class="tsd-signature-symbol">(</span>n<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigSource</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Big</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Big.mul</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:198</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
74
|
-
<p>Returns a Big number whose value is the value of this Big number times n - alias for .times().</p>
|
|
75
|
-
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><code>NaN</code> if n is invalid.</p>
|
|
76
|
-
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>n: <span class="tsd-signature-type">BigSource</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Big</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="plus" class="tsd-anchor"></a><h3>plus</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">plus<span class="tsd-signature-symbol">(</span>n<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigSource</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Big</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Big.plus</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:204</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
77
|
-
<p>Returns a Big number whose value is the value of this Big number plus n.</p>
|
|
78
|
-
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><code>NaN</code> if n is invalid.</p>
|
|
79
|
-
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>n: <span class="tsd-signature-type">BigSource</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Big</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="pow" class="tsd-anchor"></a><h3>pow</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">pow<span class="tsd-signature-symbol">(</span>exp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Big</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Big.pow</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:215</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
80
|
-
<p>Returns a Big number whose value is the value of this Big number raised to the power exp.</p>
|
|
81
|
-
</div><div><p>If exp is negative and the result has more fraction digits than is specified by Big.DP, it will be rounded to Big.DP decimal places using rounding mode Big.RM.</p>
|
|
82
|
-
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><code>!pow!</code> if exp is invalid.</p>
|
|
83
|
-
<p>Note: High value exponents may cause this method to be slow to return.</p>
|
|
84
|
-
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>exp: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div><p>The power to raise the number to, -1e+6 to 1e+6 inclusive</p>
|
|
85
|
-
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Big</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="prec" class="tsd-anchor"></a><h3>prec</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">prec<span class="tsd-signature-symbol">(</span>sd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, rm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RoundingMode</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Big</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Big.prec</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:225</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
86
|
-
<p>Return a new Big whose value is the value of this Big rounded to a maximum precision of sd
|
|
87
|
-
significant digits using rounding mode rm, or Big.RM if rm is not specified.</p>
|
|
88
|
-
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><code>!prec!</code> if sd is invalid.</p>
|
|
89
|
-
</dd><dt>throws</dt><dd><p><code>!Big.RM!</code> if rm is invalid.</p>
|
|
90
|
-
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>sd: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div><p>Significant digits: integer, 1 to MAX_DP inclusive.</p>
|
|
91
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> rm: <span class="tsd-signature-type">RoundingMode</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Big</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="round" class="tsd-anchor"></a><h3>round</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">round<span class="tsd-signature-symbol">(</span>dp<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, rm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RoundingMode</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Big</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Big.round</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:234</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
92
|
-
<p>Returns a Big number whose value is the value of this Big number rounded using rounding mode rm to a maximum of dp decimal places.</p>
|
|
93
|
-
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><code>!round!</code> if dp is invalid.</p>
|
|
94
|
-
</dd><dt>throws</dt><dd><p><code>!Big.RM!</code> if rm is invalid.</p>
|
|
95
|
-
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> dp: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div><p>Decimal places, 0 to 1e+6 inclusive</p>
|
|
96
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> rm: <span class="tsd-signature-type">RoundingMode</span></h5><div class="tsd-comment tsd-typography"><div><p>The rounding mode, one of the RoundingMode enumeration values</p>
|
|
97
|
-
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Big</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="sqrt" class="tsd-anchor"></a><h3>sqrt</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">sqrt<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Big</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Big.sqrt</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:242</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
98
|
-
<p>Returns a Big number whose value is the square root of this Big number.</p>
|
|
99
|
-
</div><div><p>If the result has more fraction digits than is specified by Big.DP, it will be rounded to Big.DP decimal places using rounding mode Big.RM.</p>
|
|
100
|
-
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><code>NaN</code> if this Big number is negative.</p>
|
|
101
|
-
</dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Big</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="sub" class="tsd-anchor"></a><h3>sub</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">sub<span class="tsd-signature-symbol">(</span>n<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigSource</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Big</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Big.sub</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:248</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
102
|
-
<p>Returns a Big number whose value is the value of this Big number minus n - alias for .minus().</p>
|
|
103
|
-
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><code>NaN</code> if n is invalid.</p>
|
|
104
|
-
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>n: <span class="tsd-signature-type">BigSource</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Big</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="times" class="tsd-anchor"></a><h3>times</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">times<span class="tsd-signature-symbol">(</span>n<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BigSource</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Big</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Big.times</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:254</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
105
|
-
<p>Returns a Big number whose value is the value of this Big number times n.</p>
|
|
106
|
-
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><code>NaN</code> if n is invalid.</p>
|
|
107
|
-
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>n: <span class="tsd-signature-type">BigSource</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Big</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="toExponential" class="tsd-anchor"></a><h3>to<wbr/>Exponential</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">to<wbr/>Exponential<span class="tsd-signature-symbol">(</span>dp<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, rm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RoundingMode</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Big.toExponential</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:269</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
108
|
-
<p>Returns a string representing the value of this Big number in exponential notation to a fixed number of decimal places dp.</p>
|
|
109
|
-
</div><div><p>If the value of this Big number in exponential notation has more digits to the right of the decimal point than is specified by dp,
|
|
110
|
-
the return value will be rounded to dp decimal places using rounding mode Big.RM.</p>
|
|
111
|
-
<p>If the value of this Big number in exponential notation has fewer digits to the right of the decimal point than is specified by dp, the return value will be appended with zeros accordingly.</p>
|
|
112
|
-
<p>If dp is omitted, or is null or undefined, the number of digits after the decimal point defaults to the minimum number of digits necessary to represent the value exactly.</p>
|
|
113
|
-
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><code>!toFix!</code> if dp is invalid.</p>
|
|
114
|
-
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> dp: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div><p>Decimal places, 0 to 1e+6 inclusive</p>
|
|
115
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> rm: <span class="tsd-signature-type">RoundingMode</span></h5><div class="tsd-comment tsd-typography"><div><p>Rounding mode: 0 (down), 1 (half-up), 2 (half-even) or 3 (up).</p>
|
|
116
|
-
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="toFixed" class="tsd-anchor"></a><h3>to<wbr/>Fixed</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">to<wbr/>Fixed<span class="tsd-signature-symbol">(</span>dp<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, rm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RoundingMode</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Big.toFixed</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:287</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
117
|
-
<p>Returns a string representing the value of this Big number in normal notation to a fixed number of decimal places dp.</p>
|
|
118
|
-
</div><div><p>If the value of this Big number in normal notation has more digits to the right of the decimal point than is specified by dp,
|
|
119
|
-
the return value will be rounded to dp decimal places using rounding mode Big.RM.</p>
|
|
120
|
-
<p>If the value of this Big number in normal notation has fewer fraction digits then is specified by dp, the return value will be appended with zeros accordingly.</p>
|
|
121
|
-
<p>Unlike Number.prototype.toFixed, which returns exponential notation if a number is greater or equal to 1021, this method will always return normal notation.</p>
|
|
122
|
-
<p>If dp is omitted, or is null or undefined, then the return value is simply the value in normal notation.
|
|
123
|
-
This is also unlike Number.prototype.toFixed, which returns the value to zero decimal places.</p>
|
|
124
|
-
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><code>!toFix!</code> if dp is invalid.</p>
|
|
125
|
-
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> dp: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div><p>Decimal places, 0 to 1e+6 inclusive</p>
|
|
126
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> rm: <span class="tsd-signature-type">RoundingMode</span></h5><div class="tsd-comment tsd-typography"><div><p>Rounding mode: 0 (down), 1 (half-up), 2 (half-even) or 3 (up).</p>
|
|
127
|
-
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="toJSON" class="tsd-anchor"></a><h3>toJSON</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">toJSON<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Big.toJSON</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:338</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
128
|
-
<p>Returns a string representing the value of this Big number.</p>
|
|
129
|
-
</div><div><p>If this Big number has a positive exponent that is equal to or greater than 21, or a negative exponent equal to or less than -7, then exponential notation is returned.</p>
|
|
130
|
-
<p>The point at which toString returns exponential rather than normal notation can be adjusted by changing
|
|
131
|
-
the value of Big.E_POS and Big.E_NEG. By default, Big numbers correspond to Javascript's number type in this regard.</p>
|
|
132
|
-
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="toNumber" class="tsd-anchor"></a><h3>to<wbr/>Number</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">to<wbr/>Number<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides Big.toNumber</p><ul><li>Defined in <a href="https://github.com/dawsbot/essential-eth/blob/55b38a5/src/shared/tiny-big/tiny-big.ts#L12">src/shared/tiny-big/tiny-big.ts:12</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="toPrecision" class="tsd-anchor"></a><h3>to<wbr/>Precision</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">to<wbr/>Precision<span class="tsd-signature-symbol">(</span>sd<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, rm<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RoundingMode</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Big.toPrecision</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:303</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
133
|
-
<p>Returns a string representing the value of this Big number to the specified number of significant digits sd.</p>
|
|
134
|
-
</div><div><p>If the value of this Big number has more digits than is specified by sd, the return value will be rounded to sd significant digits using rounding mode Big.RM.</p>
|
|
135
|
-
<p>If the value of this Big number has fewer digits than is specified by sd, the return value will be appended with zeros accordingly.</p>
|
|
136
|
-
<p>If sd is less than the number of digits necessary to represent the integer part of the value in normal notation, then exponential notation is used.</p>
|
|
137
|
-
<p>If sd is omitted, or is null or undefined, then the return value is the same as .toString().</p>
|
|
138
|
-
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><code>!toPre!</code> if sd is invalid.</p>
|
|
139
|
-
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> sd: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div><p>Significant digits, 1 to 1e+6 inclusive</p>
|
|
140
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> rm: <span class="tsd-signature-type">RoundingMode</span></h5><div class="tsd-comment tsd-typography"><div><p>Rounding mode: 0 (down), 1 (half-up), 2 (half-even) or 3 (up).</p>
|
|
141
|
-
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a name="toString" class="tsd-anchor"></a><h3>to<wbr/>String</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides Big.toString</p><ul><li>Defined in <a href="https://github.com/dawsbot/essential-eth/blob/55b38a5/src/shared/tiny-big/tiny-big.ts#L16">src/shared/tiny-big/tiny-big.ts:16</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a name="valueOf" class="tsd-anchor"></a><h3>value<wbr/>Of</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">value<wbr/>Of<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from Big.valueOf</p><ul><li>Defined in node_modules/@types/big.js/index.d.ts:329</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
142
|
-
<p>Returns a string representing the value of this Big number.</p>
|
|
143
|
-
</div><div><p>If this Big number has a positive exponent that is equal to or greater than 21, or a negative exponent equal to or less than -7, then exponential notation is returned.</p>
|
|
144
|
-
<p>The point at which toString returns exponential rather than normal notation can be adjusted by changing
|
|
145
|
-
the value of Big.E_POS and Big.E_NEG. By default, Big numbers correspond to Javascript's number type in this regard.</p>
|
|
146
|
-
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="TinyBig.html" class="tsd-kind-icon">Tiny<wbr/>Big</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="TinyBig.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#c" class="tsd-kind-icon">c</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#e" class="tsd-kind-icon">e</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#s" class="tsd-kind-icon">s</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="TinyBig.html#DP" class="tsd-kind-icon">DP</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="TinyBig.html#NE" class="tsd-kind-icon">NE</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="TinyBig.html#PE" class="tsd-kind-icon">PE</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="TinyBig.html#RM" class="tsd-kind-icon">RM</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="TinyBig.html#roundDown" class="tsd-kind-icon">round<wbr/>Down</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="TinyBig.html#roundHalfEven" class="tsd-kind-icon">round<wbr/>Half<wbr/>Even</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="TinyBig.html#roundHalfUp" class="tsd-kind-icon">round<wbr/>Half<wbr/>Up</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="TinyBig.html#roundUp" class="tsd-kind-icon">round<wbr/>Up</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#abs" class="tsd-kind-icon">abs</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#add" class="tsd-kind-icon">add</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#cmp" class="tsd-kind-icon">cmp</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#div" class="tsd-kind-icon">div</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#eq" class="tsd-kind-icon">eq</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#gt" class="tsd-kind-icon">gt</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#gte" class="tsd-kind-icon">gte</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#lt" class="tsd-kind-icon">lt</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#lte" class="tsd-kind-icon">lte</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#minus" class="tsd-kind-icon">minus</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#mod" class="tsd-kind-icon">mod</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#mul" class="tsd-kind-icon">mul</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#plus" class="tsd-kind-icon">plus</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#pow" class="tsd-kind-icon">pow</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#prec" class="tsd-kind-icon">prec</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#round" class="tsd-kind-icon">round</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#sqrt" class="tsd-kind-icon">sqrt</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#sub" class="tsd-kind-icon">sub</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#times" class="tsd-kind-icon">times</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#toExponential" class="tsd-kind-icon">to<wbr/>Exponential</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#toFixed" class="tsd-kind-icon">to<wbr/>Fixed</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#toJSON" class="tsd-kind-icon">toJSON</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="TinyBig.html#toNumber" class="tsd-kind-icon">to<wbr/>Number</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#toPrecision" class="tsd-kind-icon">to<wbr/>Precision</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="TinyBig.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="TinyBig.html#valueOf" class="tsd-kind-icon">value<wbr/>Of</a></li></ul></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
|
@@ -1,89 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>essential-eth - v0.2.0</title><meta name="description" content="Documentation for essential-eth - v0.2.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">essential-eth - v0.2.0</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>essential-eth - v0.2.0</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography"><p align="center">
|
|
2
|
-
<a><img src="https://blog.ethereum.org/img/2018/08/grants_eth_logo.png" title="Ethereum triangle" height="300"/></a>
|
|
3
|
-
</p>
|
|
4
|
-
<p align="center">
|
|
5
|
-
<b>
|
|
6
|
-
Essential Eth
|
|
7
|
-
</b>
|
|
8
|
-
<br>
|
|
9
|
-
<i>Ultralight Ethereum utilities for JS and TS</i>
|
|
10
|
-
<br>
|
|
11
|
-
</p>
|
|
12
|
-
|
|
13
|
-
<hr>
|
|
14
|
-
<p align="center">
|
|
15
|
-
<img src="https://user-images.githubusercontent.com/3408480/133322814-f3d18424-4ba8-4a37-8cbc-c5e6828354a3.png" title="Ethereum triangle" width="900"/>
|
|
16
|
-
</p>
|
|
17
|
-
|
|
18
|
-
<hr>
|
|
19
|
-
<br>
|
|
20
|
-
|
|
21
|
-
<p><img src="https://badgen.net/bundlephobia/minzip/essential-eth" alt=""> <img src="https://badgen.net/bundlephobia/tree-shaking/essential-eth" alt=""></p>
|
|
22
|
-
<p><img src="https://img.shields.io/npm/v/essential-eth" alt="">
|
|
23
|
-
<img src="https://badgen.net/bundlephobia/min/essential-eth" alt="">
|
|
24
|
-
<img src="https://badgen.net/bundlephobia/dependency-count/essential-eth" alt=""></p>
|
|
25
|
-
<p>👨🏻💻 Breaking changes will exist between minor versions until <code>1.0.0</code> (Versions go <code>major.minor.patch</code>)</p>
|
|
26
|
-
|
|
27
|
-
<a href="#features" id="features" style="color: inherit; text-decoration: none;">
|
|
28
|
-
<h2>Features</h2>
|
|
29
|
-
</a>
|
|
30
|
-
<ul>
|
|
31
|
-
<li>⚡️ A replacement for the utils in web3.js and ethers.js</li>
|
|
32
|
-
<li>🏎 <a href="https://bundlephobia.com/package/essential-eth">The TINIEST code size possible</a></li>
|
|
33
|
-
<li>ʦ Fully typed with TypeScript (also works with JavaScript)</li>
|
|
34
|
-
<li>🌲 Tree-shaking and no side-effects</li>
|
|
35
|
-
<li>🧪 Tested heavily to match both web3 and ethers.js</li>
|
|
36
|
-
<li>👩⚖️ MIT License</li>
|
|
37
|
-
</ul>
|
|
38
|
-
|
|
39
|
-
<a href="#install" id="install" style="color: inherit; text-decoration: none;">
|
|
40
|
-
<h2>Install</h2>
|
|
41
|
-
</a>
|
|
42
|
-
<pre><code class="language-sh"><span class="hl-1">npm install --save essential-eth </span><span class="hl-3"># TypeScript types load automatically</span><br/><br/><span class="hl-3"># or if you prefer yarn</span><br/><span class="hl-1">yarn add essential-eth </span><span class="hl-3"># TypeScript types load automatically</span>
|
|
43
|
-
</code></pre>
|
|
44
|
-
|
|
45
|
-
<a href="#utils-do-not-require-connecting-to-an-eth-node" id="utils-do-not-require-connecting-to-an-eth-node" style="color: inherit; text-decoration: none;">
|
|
46
|
-
<h2>Utils (do not require connecting to an Eth node)</h2>
|
|
47
|
-
</a>
|
|
48
|
-
<pre><code class="language-typescript"><span class="hl-5">import</span><span class="hl-1"> { etherToWei } </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-2">'essential-eth'</span><span class="hl-1">;</span><br/><br/><span class="hl-3">// or in a non-import environment</span><br/><span class="hl-5">const</span><span class="hl-1"> { </span><span class="hl-4">etherToWei</span><span class="hl-1"> } </span><span class="hl-5">=</span><span class="hl-1"> </span><span class="hl-4">require</span><span class="hl-1">(</span><span class="hl-2">'essential-eth'</span><span class="hl-1">);</span>
|
|
49
|
-
</code></pre>
|
|
50
|
-
|
|
51
|
-
<a href="#ethertowei" id="ethertowei" style="color: inherit; text-decoration: none;">
|
|
52
|
-
<h4><code>etherToWei</code></h4>
|
|
53
|
-
</a>
|
|
54
|
-
<pre><code class="language-typescript"><span class="hl-3">// convert ether to wei</span><br/><span class="hl-0">etherToWei</span><span class="hl-1">(etherQuantity: string </span><span class="hl-5">|</span><span class="hl-1"> number): TinyBig</span>
|
|
55
|
-
</code></pre>
|
|
56
|
-
|
|
57
|
-
<a href="#weitoether" id="weitoether" style="color: inherit; text-decoration: none;">
|
|
58
|
-
<h4><code>weiToEther</code></h4>
|
|
59
|
-
</a>
|
|
60
|
-
<pre><code class="language-typescript"><span class="hl-3">// convert wei to ether</span><br/><span class="hl-0">weiToEther</span><span class="hl-1">(weiQuantity: string </span><span class="hl-5">|</span><span class="hl-1"> number): TinyBig</span>
|
|
61
|
-
</code></pre>
|
|
62
|
-
|
|
63
|
-
<a href="#tochecksumaddress" id="tochecksumaddress" style="color: inherit; text-decoration: none;">
|
|
64
|
-
<h4><code>toChecksumAddress</code></h4>
|
|
65
|
-
</a>
|
|
66
|
-
<pre><code class="language-typescript"><span class="hl-3">// return proper mixed-case address</span><br/><span class="hl-0">toChecksumAddress</span><span class="hl-1">(address: string): string</span>
|
|
67
|
-
</code></pre>
|
|
68
|
-
|
|
69
|
-
<a href="#rpc" id="rpc" style="color: inherit; text-decoration: none;">
|
|
70
|
-
<h2>RPC</h2>
|
|
71
|
-
</a>
|
|
72
|
-
<pre><code class="language-typescript"><span class="hl-5">import</span><span class="hl-1"> { EssentialEth } </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-2">'essential-eth'</span><span class="hl-1">;</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-4">essentialEth</span><span class="hl-1"> </span><span class="hl-5">=</span><span class="hl-1"> </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">EssentialEth</span><span class="hl-1">(</span><span class="hl-2">'RPC URL HERE'</span><span class="hl-1"> </span><span class="hl-3">/* Try POKT or Infura */</span><span class="hl-1">);</span><br/><span class="hl-3">// OR for very quick testing (limited to 500 requests)</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-4">essentialEth</span><span class="hl-1"> </span><span class="hl-5">=</span><span class="hl-1"> </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">EssentialEth</span><span class="hl-1">();</span>
|
|
73
|
-
</code></pre>
|
|
74
|
-
|
|
75
|
-
<a href="#getblock" id="getblock" style="color: inherit; text-decoration: none;">
|
|
76
|
-
<h4><code>getBlock</code></h4>
|
|
77
|
-
</a>
|
|
78
|
-
<p>Returns a <a href="src/types/block.types.ts">Block</a></p>
|
|
79
|
-
<pre><code class="language-typescript"><span class="hl-3">// Same API as web3.eth.getBlock</span><br/><span class="hl-0">getBlock</span><span class="hl-1">(timeFrame: number </span><span class="hl-5">|</span><span class="hl-1"> </span><span class="hl-2">"latest"</span><span class="hl-1"> </span><span class="hl-5">|</span><span class="hl-1"> </span><span class="hl-2">"earliest"</span><span class="hl-1"> </span><span class="hl-5">|</span><span class="hl-1"> </span><span class="hl-2">"pending"</span><span class="hl-1">, returnTransactionObjects</span><span class="hl-5">?:</span><span class="hl-1"> boolean): </span><span class="hl-4">Promise</span><span class="hl-5"><</span><span class="hl-1">Block</span><span class="hl-5">></span>
|
|
80
|
-
</code></pre>
|
|
81
|
-
<br/>
|
|
82
|
-
<br/>
|
|
83
|
-
|
|
84
|
-
<ul>
|
|
85
|
-
<li><a href="https://essential-eth.vercel.app">📓 View full docs</a></li>
|
|
86
|
-
<li><a href="https://github.com/dawsbot/essential-eth/releases">📓 View changelog (by looking at releases diff)</a></li>
|
|
87
|
-
<li><a href="https://essential-eth.vercel.app/versions">📓 View docs for an older version</a></li>
|
|
88
|
-
</ul>
|
|
89
|
-
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class"><a href="classes/EssentialEth.html" class="tsd-kind-icon">Essential<wbr/>Eth</a></li><li class="tsd-kind-class"><a href="classes/TinyBig.html" class="tsd-kind-icon">Tiny<wbr/>Big</a></li><li class="tsd-kind-function"><a href="modules.html#etherToWei" class="tsd-kind-icon">ether<wbr/>To<wbr/>Wei</a></li><li class="tsd-kind-function"><a href="modules.html#tinyBig" class="tsd-kind-icon">tiny<wbr/>Big</a></li><li class="tsd-kind-function"><a href="modules.html#toChecksumAddress" class="tsd-kind-icon">to<wbr/>Checksum<wbr/>Address</a></li><li class="tsd-kind-function"><a href="modules.html#weiToEther" class="tsd-kind-icon">wei<wbr/>To<wbr/>Ether</a></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="assets/main.js"></script></body></html>
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>essential-eth - v0.2.0</title><meta name="description" content="Documentation for essential-eth - v0.2.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">essential-eth - v0.2.0</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>essential-eth - v0.2.0</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class"><a href="classes/EssentialEth.html" class="tsd-kind-icon">Essential<wbr/>Eth</a></li><li class="tsd-kind-class"><a href="classes/TinyBig.html" class="tsd-kind-icon">Tiny<wbr/>Big</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function"><a href="modules.html#etherToWei" class="tsd-kind-icon">ether<wbr/>To<wbr/>Wei</a></li><li class="tsd-kind-function"><a href="modules.html#tinyBig" class="tsd-kind-icon">tiny<wbr/>Big</a></li><li class="tsd-kind-function"><a href="modules.html#toChecksumAddress" class="tsd-kind-icon">to<wbr/>Checksum<wbr/>Address</a></li><li class="tsd-kind-function"><a href="modules.html#weiToEther" class="tsd-kind-icon">wei<wbr/>To<wbr/>Ether</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function"><a name="etherToWei" class="tsd-anchor"></a><h3>ether<wbr/>To<wbr/>Wei</h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">ether<wbr/>To<wbr/>Wei<span class="tsd-signature-symbol">(</span>etherQuantity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="classes/TinyBig.html" class="tsd-signature-type" data-tsd-kind="Class">TinyBig</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dawsbot/essential-eth/blob/55b38a5/src/ether-to-wei.ts#L26">src/ether-to-wei.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
2
|
-
<p>Similar to <a href="https://docs.ethers.io/v4/api-utils.html#ether-strings-and-wei">"parseEther" in ethers.js</a></p>
|
|
3
|
-
</div><div><p>Similar to <a href="https://web3js.readthedocs.io/en/v1.2.11/web3-utils.html?highlight=towei#towei">"toWei" in web3</a></p>
|
|
4
|
-
</div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code class="language-javascript"><span class="hl-0">etherToWei</span><span class="hl-1">(</span><span class="hl-2">'1000'</span><span class="hl-1">).</span><span class="hl-0">toString</span><span class="hl-1">()</span><br/><span class="hl-3">// '1000000000000000000000'</span><br/><span class="hl-0">etherToWei</span><span class="hl-1">(</span><span class="hl-4">1000</span><span class="hl-1">).</span><span class="hl-0">toString</span><span class="hl-1">()</span><br/><span class="hl-3">// '1000000000000000000000'</span>
|
|
5
|
-
</code></pre>
|
|
6
|
-
</dd><dt>example</dt><dd><pre><code class="language-javascript"><span class="hl-0">etherToWei</span><span class="hl-1">(</span><span class="hl-2">'1000'</span><span class="hl-1">).</span><span class="hl-0">toNumber</span><span class="hl-1">()</span><br/><span class="hl-3">// 1000000000000000000000</span><br/><span class="hl-0">etherToWei</span><span class="hl-1">(</span><span class="hl-4">1000</span><span class="hl-1">).</span><span class="hl-0">toNumber</span><span class="hl-1">()</span><br/><span class="hl-3">// 1000000000000000000000</span>
|
|
7
|
-
</code></pre>
|
|
8
|
-
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>etherQuantity: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="classes/TinyBig.html" class="tsd-signature-type" data-tsd-kind="Class">TinyBig</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a name="tinyBig" class="tsd-anchor"></a><h3>tiny<wbr/>Big</h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">tiny<wbr/>Big<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="classes/TinyBig.html" class="tsd-signature-type" data-tsd-kind="Class">TinyBig</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dawsbot/essential-eth/blob/55b38a5/src/shared/tiny-big/tiny-big.ts#L27">src/shared/tiny-big/tiny-big.ts:27</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
9
|
-
<p>Helper factory function so that you don't have to type "new" when instantiating a new TinyBig</p>
|
|
10
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>value: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="classes/TinyBig.html" class="tsd-signature-type" data-tsd-kind="Class">TinyBig</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a name="toChecksumAddress" class="tsd-anchor"></a><h3>to<wbr/>Checksum<wbr/>Address</h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">to<wbr/>Checksum<wbr/>Address<span class="tsd-signature-symbol">(</span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dawsbot/essential-eth/blob/55b38a5/src/to-checksum-address.ts#L19">src/to-checksum-address.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
11
|
-
<p>Returns an Ethereum address in proper mixed-case checksum.</p>
|
|
12
|
-
</div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code class="language-javascript"><span class="hl-0">toChecksumAddress</span><span class="hl-1">(</span><span class="hl-2">'0xfB6916095ca1df60bB79Ce92cE3Ea74c37c5d359'</span><span class="hl-1">);</span><br/><span class="hl-3">// '0xfB6916095ca1df60bB79Ce92cE3Ea74c37c5d359'</span>
|
|
13
|
-
</code></pre>
|
|
14
|
-
<p>Similar to <a href="https://docs.ethers.io/v4/api-utils.html#utils-getaddress">"getAddress" in ethers.js</a></p>
|
|
15
|
-
<p>Similar to <a href="https://web3js.readthedocs.io/en/v1.2.11/web3-utils.html#tochecksumaddress">"toChecksumAddress" in web3</a></p>
|
|
16
|
-
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>address: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div><p>An Ethereum address. Mixed, lower, and uppercase are all valid</p>
|
|
17
|
-
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a name="weiToEther" class="tsd-anchor"></a><h3>wei<wbr/>To<wbr/>Ether</h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">wei<wbr/>To<wbr/>Ether<span class="tsd-signature-symbol">(</span>weiQuantity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="classes/TinyBig.html" class="tsd-signature-type" data-tsd-kind="Class">TinyBig</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dawsbot/essential-eth/blob/55b38a5/src/wei-to-ether.ts#L28">src/wei-to-ether.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
18
|
-
<p>Convert from Ether to Wei</p>
|
|
19
|
-
</div><div><p>Similar to <a href="https://docs.ethers.io/v4/api-utils.html#ether-strings-and-wei">"formatEther" in ethers.js</a></p>
|
|
20
|
-
<p>Similar to <a href="https://web3js.readthedocs.io/en/v1.2.11/web3-utils.html#fromwei">"fromWei" in web3</a></p>
|
|
21
|
-
</div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code class="language-javascript"><span class="hl-0">etherToWei</span><span class="hl-1">(</span><span class="hl-2">'1000'</span><span class="hl-1">).</span><span class="hl-0">toString</span><span class="hl-1">()</span><br/><span class="hl-3">// '1000000000000000000000'</span><br/><span class="hl-0">etherToWei</span><span class="hl-1">(</span><span class="hl-4">1000</span><span class="hl-1">).</span><span class="hl-0">toString</span><span class="hl-1">()</span><br/><span class="hl-2">'1000000000000000000000'</span>
|
|
22
|
-
</code></pre>
|
|
23
|
-
</dd><dt>example</dt><dd><pre><code class="language-javascript"><span class="hl-0">etherToWei</span><span class="hl-1">(</span><span class="hl-2">'1000'</span><span class="hl-1">).</span><span class="hl-0">toNumber</span><span class="hl-1">()</span><br/><span class="hl-3">// 1000000000000000000000</span><br/><span class="hl-0">etherToWei</span><span class="hl-1">(</span><span class="hl-4">1000</span><span class="hl-1">).</span><span class="hl-0">toNumber</span><span class="hl-1">()</span><br/><span class="hl-3">// 1000000000000000000000</span>
|
|
24
|
-
</code></pre>
|
|
25
|
-
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>weiQuantity: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="classes/TinyBig.html" class="tsd-signature-type" data-tsd-kind="Class">TinyBig</a></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class"><a href="classes/EssentialEth.html" class="tsd-kind-icon">Essential<wbr/>Eth</a></li><li class="tsd-kind-class"><a href="classes/TinyBig.html" class="tsd-kind-icon">Tiny<wbr/>Big</a></li><li class="tsd-kind-function"><a href="modules.html#etherToWei" class="tsd-kind-icon">ether<wbr/>To<wbr/>Wei</a></li><li class="tsd-kind-function"><a href="modules.html#tinyBig" class="tsd-kind-icon">tiny<wbr/>Big</a></li><li class="tsd-kind-function"><a href="modules.html#toChecksumAddress" class="tsd-kind-icon">to<wbr/>Checksum<wbr/>Address</a></li><li class="tsd-kind-function"><a href="modules.html#weiToEther" class="tsd-kind-icon">wei<wbr/>To<wbr/>Ether</a></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="assets/main.js"></script></body></html>
|