@ethernauta/utils - npm Package Compare versions

Comparing version 0.0.37 to 0.0.40

package.json

@@ -5,3 +5,3 @@ {
   "type": "module",
-  "version": "0.0.37",
+  "version": "0.0.40",
   "publishConfig": {
@@ -22,4 +22,4 @@ "access": "public"
   "dependencies": {
-    "@ethernauta/chain": "0.0.37",
-    "@ethernauta/transport": "0.0.37"
+    "@ethernauta/chain": "0.0.40",
+    "@ethernauta/transport": "0.0.40"
   },
@@ -26,0 +26,0 @@ "peerDependencies": {

README.md

@@ -5,217 +5,38 @@ [![bundlejs](https://deno.bundlejs.com/badge?q=@ethernauta/eth@0.0.10&treeshake=[*])](https://deno.bundlejs.com/badge?q=@ethernauta/eth@0.0.10&treeshake=[*])
 
-This module aims to be an un-opinionated representation of the defined:
+This module aims to be an set of useful utilities to be used within a crypto context:
 
-- [Ethereum schemas](https://github.com/ethereum/execution-apis/tree/main/src/schemas)
-- [Ethereum base methods](https://github.com/ethereum/execution-apis/tree/main/src/eth)
-- [abi-spec](https://docs.soliditylang.org/en/latest/abi-spec.html)
-
 ## Modules
 
-- [eth](https://github.com/niconiahi/ethernauta/blob/main/packages/eth)
-- [wallet](https://github.com/niconiahi/ethernauta/blob/main/packages/wallet)
-- [connector](https://github.com/niconiahi/ethernauta/blob/main/packages/connector)
-- [transport](https://github.com/niconiahi/ethernauta/blob/main/packages/transport)
-- [transaction](https://github.com/niconiahi/ethernauta/blob/main/packages/transaction)
+- [abi](https://github.com/niconiahi/ethernauta/blob/main/packages/abi) [NPM](https://www.npmjs.com/package/@ethernauta/abi)
+- [chain](https://github.com/niconiahi/ethernauta/blob/main/packages/chain) [NPM](https://www.npmjs.com/package/@ethernauta/chain)
+- [cli](https://github.com/niconiahi/ethernauta/blob/main/packages/cli) [NPM](https://www.npmjs.com/package/@ethernauta/cli)
+- [erc](https://github.com/niconiahi/ethernauta/blob/main/packages/erc) [NPM](https://www.npmjs.com/package/@ethernauta/erc)
+- [eth](https://github.com/niconiahi/ethernauta/blob/main/packages/eth) [NPM](https://www.npmjs.com/package/@ethernauta/eth)
+- [transaction](https://github.com/niconiahi/ethernauta/blob/main/packages/transaction) [NPM](https://www.npmjs.com/package/@ethernauta/transaction)
+- [utils](https://github.com/niconiahi/ethernauta/blob/main/packages/utils) [NPM](https://www.npmjs.com/package/@ethernauta/utils)
+- [wallet](https://github.com/niconiahi/ethernauta/blob/main/packages/wallet) [NPM](https://www.npmjs.com/package/@ethernauta/wallet)
 
 ## Table of contents
 
-1. [API](#api)
-2. [core](#core)
-4. [abi](#abi)
-5. [method](#method)
+- [API](#api)
 
 ## API
 
-### Reading from the blockchain
+### came-to-kebab
 
 ```ts
-import { eth_getBlockByHash } from "@ethernauta/eth";
-import { reader, SEPOLIA_CHAIN_ID } from "./reader";
+import { camel_to_kebab } from "@ethernauta/utils";
 
-const readable = eth_getBlockByHash([
-  "0x31386e6cfba70bb4d8a95404bdb740572b758a15c62e51ee912071a7b5be9e26",
-  false,
-]);
-const block = await readable(reader(SEPOLIA_CHAIN_ID));
+const input = "helloWorld"
+const kebab = camel_to_kebab(input) // hello-world
 ```
 
-### Signing a transaction
+### invariant
 
 ```ts
-import { eth_sendRawTransaction } from "@ethernauta/eth"
-import { number_to_hex } from "@ethernauta/wallet"
+import { invariant } from "@ethernauta/utils";
 
-const method = "transfer"
-const ADDRESS = "0x515e9e0565fdddd4f8a9759744734154da453585"
-const params = [ADDRESS, number_to_hex(1)]
-const signed_transaction = await window.wallet.sign(
-  method,
-  params,
-)
+const input: string | null = "helloWorld"
+invariant(typeof input === 'string', "input must be a string")
+// input: string
 ```
-
-### Writting to the blockchain
-
-```ts
-import { transfer } from "@ethernauta/eth"
-import { number_to_hex } from "@ethernauta/wallet"
-import { writer, SEPOLIA_CHAIN_ID } from "./writer"
-
-const writable = transfer([
-  "0x636c0fcd6da2207abfa80427b556695a4ad0af94",
-  number_to_hex(1),
-])
-const hash = await writable(writer(SEPOLIA_CHAIN_ID))
-await writable(writer(SEPOLIA_CHAIN_ID))
-```
-
-### Reacting to transaction states
-
-```ts
-import { transfer } from "@ethernauta/eth"
-import { number_to_hex } from "@ethernauta/wallet"
-import { writer, SEPOLIA_CHAIN_ID } from "./writer"
-import {
-  watch_transaction,
-  register_transaction
-} from "@ethernauta/transaction"
-
-const writable = transfer([
-  "0x636c0fcd6da2207abfa80427b556695a4ad0af94",
-  number_to_hex(1),
-])
-const hash = await writable(writer(SEPOLIA_CHAIN_ID))
-// initial transaction state 
-// with "type" key equal "pending"
-const transaction = register_transaction(hash)
-watch_transaction(hash, (transaction) => {
-  // subsequent states that the transaction goes trough
-})
-```
-
-## Files to pay attention
-
-### core
-
-- [block.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/block.ts)
-- [client.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/client.ts)
-- [filter.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/filter.ts)
-- [receipt.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/receipt.ts)
-- [state.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/state.ts)
-- [withdrawal.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/withdrawal.ts)
-
-#### base
-
-- [address.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/base/address.ts)
-- [addressses.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/base/addresses.ts)
-- [base/byte.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/base/byte.ts)
-- [base/bytes/ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/base/bytes.ts)
-- [base/bytes-8.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/base/bytes-8.ts)
-- [base/bytes-32.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/base/bytes-32.ts)
-- [base/bytes-48.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/base/bytes-48.ts)
-- [base/bytes-65.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/base/bytes-65.ts)
-- [base/bytes-256.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/base/bytes-256.ts)
-- [base/bytes-max-32.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/base/bytes-max-32.ts)
-- [base/hash-32.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/base/hash-32.ts)
-- [base/not-found.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/base/not-found.ts)
-- [base/ratio.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/base/ratio.ts)
-- [base/uint.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/base/uint.ts)
-- [base/uint-64.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/base/uint-64.ts)
-- [base/uint-256.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/base/uint-256.ts)
-
-#### transaction
-
-- [transaction/1559.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/transaction/1559.ts)
-- [transaction/2930.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/transaction/2930.ts)
-- [transaction/4844.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/transaction/4844.ts)
-- [transaction/access-list.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/transaction/access-list.ts)
-- [transaction/generic.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/transaction/generic.ts)
-- [transaction/info.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/transaction/info.ts)
-- [transaction/legacy.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/transaction/legacy.ts)
-- [transaction/signed.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/transaction/signed.ts)
-- [transaction/unsigned.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/core/transaction/unsigned.ts)
-
-### abi
-
-- [abi/error.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/abi/error.ts)
-- [abi/client.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/abi/event.ts)
-- [abi/shared.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/abi/shared.ts)
-
-#### function
-
-- [function/shared.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/abi/function/shared.ts)
-- [function/function.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/abi/function/function.ts)
-- [function/constructor.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/abi/function/constructor.ts)
-- [function/fallback.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/abi/function/fallback.ts)
-- [function/receive.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/abi/function/receive.ts)
-
-### method
-
-#### eip
-
-- [eip/1102/request-accounts/request-accounts.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/eip/1102/request-accounts.ts)
-
-#### block
-
-- [block/get-block-by-hash.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/block/get-block-by-hash.ts)
-- [block/get-block-by-number.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/block/get-block-by-number.ts)
-- [block/get-block-receipts.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/block/get-block-receipts.ts)
-- [block/get-block-transaction-count-by-hash.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/block/get-block-transaction-count-by-hash.ts)
-- [block/get-block-transaction-count-by-number.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/block/get-block-transaction-count-by-number.ts)
-- [block/get-uncle-count-by-block-hash.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/block/get-uncle-count-by-block-hash.ts)
-- [block/get-uncle-count-by-block-number.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/block/get-uncle-count-by-block-number.ts)
-
-#### client
-
-- [client/accounts.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/client/accounts.ts)
-- [client/block-number.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/client/block-number.ts)
-- [client/chain-id.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/client/chain-id.ts)
-- [client/coinbase.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/client/coinbase.ts)
-- [client/syncing.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/client/syncing.ts)
-
-#### execute
-
-- [execute/call.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/execute/call.ts)
-- [execute/create-access-list.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/execute/create-access-list.ts)
-- [execute/estimate-gas.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/execute/estimate-gas.ts)
-
-#### fee-market
-
-- [fee-market/fee-history.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/fee-market/fee-history.ts)
-- [fee-market/gas-price.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/fee-market/gas-price.ts)
-- [fee-market/max-priority-fee-per-gas.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/fee-market/max-priority-fee-per-gas.ts)
-
-#### filter
-
-- [filter/get-filter-changes.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/filter/get-filter-changes.ts)
-- [filter/get-filter-logs.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/filter/get-filter-logs.ts)
-- [filter/get-logs.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/filter/get-logs.ts)
-- [filter/new-block-filter.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/filter/new-block-filter.ts)
-- [filter/new-filter.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/filter/new-filter.ts)
-- [filter/new-pending-transaction-filter.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/filter/new-pending-transaction-filter.ts)
-- [filter/uninstall-filter.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/filter/uninstall-filter.ts)
-
-#### sign
-
-- [sign/sign.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/sign/sign.ts)
-- [sign/sign-transaction.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/sign/sign-transaction.ts)
-
-#### state
-
-- [state/get-balance.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/state/get-balance.ts)
-- [state/get-code.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/state/get-code.ts)
-- [state/get-proof.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/state/get-proof.ts)
-- [state/get-storage-at.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/state/get-storage-at.ts)
-- [state/get-transaction-count.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/state/get-transaction-count.ts)
-
-#### submit
-
-- [submit/send-raw-transaction.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/submit/send-raw-transaction.ts)
-- [submit/send-transaction.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/submit/send-transaction.ts)
-
-#### transaction
-
-- [transaction/get-transaction-by-block-hash-and-index.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/transaction/get-transaction-by-block-hash-and-index.ts)
-- [transaction/get-transaction-by-block-number-and-index.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/transaction/get-transaction-by-block-number-and-index.ts)
-- [transaction/get-transaction-by-hash.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/transaction/get-transaction-by-hash.ts)
-- [transaction/get-transaction-receipt.ts](https://github.com/niconiahi/ethernauta/blob/main/packages/eth/src/method/transaction/get-transaction-receipt.ts)

No alert changes

Worsened metrics

Total package byte prevSize

5246

-67.55%

Number of lines in readme file

42

-81%

Dependency changes

• + Added

  @ethernauta/chain@0.0.40
  (transitive)

• + Added

  @ethernauta/transport@0.0.40
  (transitive)

• - Removed

  @ethernauta/chain@0.0.37
  (transitive)

• - Removed

  @ethernauta/transport@0.0.37
  (transitive)

• Updated

  @ethernauta/chain@0.0.40

• Updated

  @ethernauta/transport@0.0.40