Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/attestate/eth-fun
A functional and state-less library for the Ethereum JSON-RPC.
https://github.com/attestate/eth-fun
ethereum functional solidity stateless web3
Last synced: 5 days ago
JSON representation
A functional and state-less library for the Ethereum JSON-RPC.
- Host: GitHub
- URL: https://github.com/attestate/eth-fun
- Owner: attestate
- License: gpl-3.0
- Created: 2021-05-18T12:45:46.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-05-27T14:11:25.000Z (6 months ago)
- Last Synced: 2024-11-08T21:38:21.175Z (8 days ago)
- Topics: ethereum, functional, solidity, stateless, web3
- Language: JavaScript
- Homepage:
- Size: 16.3 MB
- Stars: 25
- Watchers: 5
- Forks: 4
- Open Issues: 12
-
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# eth-fun
[](https://github.com/attestate/eth-fun/actions/workflows/node.js.yml)
### A collection of independent utility functions for Ethereum. Build with functional approach in mind.
#### [API Documentation](/API.md) | [Changelog](/CHANGELOG.md) | [Contributing](readme.md/#Contributing)
## Why Use eth-fun?
You should use eth-fun when you want to have _fun_. We try to build our
code according to the properties below.
- **Functional** in nature
- **Modular** and as **loosely** coupled as possible.
- **Stateless**; such that we come as close as possible towards atomic,
safely-failable (and catchable) actions.
- Built with a modern front end's needs in mind. Ideally, the whole lib is
**tree-shakeable** and produces the **smallest footprint** possible when being sent
to a client's browser.
eth-fun is an attempt at developing Ethereum in a one-way-dataflow fashion
(similar to react.js). Today, eth-fun can't sign payloads. It works best in on-chain
data extractors like https://rugpullindex.com and https://neume.network. eth-fun is a
**work-in-progress**.
## Installation
```bash
$ npm i eth-fun
```
## Example
#### Get the latest block number and fetch information about it
```js
import { blockNumber, getBlockByNumber } from "eth-fun";
// URL of an Ethereum node
const options = {
url: "https://cloudflare-eth.com",
};
(async () => {
const currentNumber = await blockNumber(options); // latest block
const includeTxBodies = false;
const block = await getBlockByNumber(options, currentNumber, includeTxBodies);
console.log(block); // information about the block
})();
```
Similar to the above used functions i.e. `blockNumber` and `getBlockByNumber`
eth-fun implements more utility functions to talk with an Ethereum node using
[JSON RPC](https://ethereum.org/en/developers/docs/apis/json-rpc/).
## API
Visit [API documentation](/API.md) for a complete list of functions and their examples.
- [`options object`](/API.md#options-object)
- [`await getBlockByNumber(options, blockNumber, includeTxBodiesw)`](/API.md#await-getblockbynumberoptions-blocknumber-includetxbodies)
- [`await getTransactionReceipt(options, txId)`](/API.md#await-gettransactionreceiptoptions-txid)
- [`toHex(number)`](/API.md#tohexnumber)
- [`fromHex(number)`](/API.md#fromhexnumber)
- [`encodeFunctionSignature(selector)`](/API.md#web3-eth-abi-functions)
- [`encodeEventSignature(selector)`](/API.md#web3-eth-abi-functions)
- [`encodeParameters(typesArray, parameters)`](/API.md#web3-eth-abi-functions)
- [`encodeFunctionCall(jsonInterface, parameters)`](/API.md#web3-eth-abi-functions)
- [`decodeLog(inputs, data, topics)`](/API.md#web3-eth-abi-functions)
- [`decodeParameters(typesArray, parameters)`](/API.md#decodeparameters)
- [`async call(options, from, to, data, blockNumber)`](/API.md#async-calloptions-from-to-data-blocknumber)
- [`errors object`](/API.md#errors-object)
- [`nodes object`](/API.md#nodes-object)
- [`async blockNumber(options)`](/API.md#async-blocknumberoptions)
- [`async getStorageAt(options, addr, index, blockNumber)`](/API.md#async-getstorageatoptions-addr-index-blocknumber)
- [`getStorageLocation(contract, label)`](/API.md#getstoragelocationcontract-label)
- [`allFunctions(compiledCode)`](/API.md#allfunctionscompiledcode)
- [`async getLogs(options, {fromBlock, toBlock, address, topics, limit })`](/API.md#async-getlogsoptions-fromblock-toblock-address-topics-limit-)
## Examples
- [limit-requests](/examples/limit-requests) - An example to demonstrate concurrency so that the RPC endpoint doesn't get choked
## Changelog
Visit [CHANGELOG.md](/CHANGELOG.md)
## Tests
You can run the library's tests with `npm run test`, however, do make sure that
you're on node v14 as this is what the esmock setup sadly still depends on.
Otherwise, for anything but testing, we're using this library in production
with node v18.
## Contributing
We love contributions from the community. Find a [good first issue](https://github.com/attestate/eth-fun/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
Want to suggest a feature or even better raise a PR for it? Head over to the [issues](https://github.com/attestate/eth-fun/issues).
## References
- [Ethereum JSON-RPC Specification](https://ethereum.github.io/execution-apis/api-documentation/)
## License
See LICENSE file.