essential-eth 0.9.0 โ†’ 0.9.1-next.1

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.
Files changed (134) hide show
  1. package/dist/cjs/classes/Contract.js +66 -307
  2. package/dist/cjs/classes/test/Contract/crv-abi.js +256 -252
  3. package/dist/cjs/classes/test/Contract/ens-abi.d.ts +1 -1
  4. package/dist/cjs/classes/test/Contract/ens-abi.js +212 -497
  5. package/dist/cjs/classes/test/Contract/fei-abi.js +284 -605
  6. package/dist/cjs/classes/test/Contract/foo-abi.d.ts +1 -1
  7. package/dist/cjs/classes/test/Contract/foo-abi.js +21 -44
  8. package/dist/cjs/classes/test/Contract/uniswap-abi.js +68 -64
  9. package/dist/cjs/classes/utils/clean-block.js +30 -52
  10. package/dist/cjs/classes/utils/clean-log.js +20 -42
  11. package/dist/cjs/classes/utils/clean-transaction-receipt.js +30 -51
  12. package/dist/cjs/classes/utils/clean-transaction.js +30 -52
  13. package/dist/cjs/classes/utils/encode-decode-transaction.js +107 -148
  14. package/dist/cjs/classes/utils/fetchers.d.ts +8 -2
  15. package/dist/cjs/classes/utils/fetchers.js +52 -166
  16. package/dist/cjs/classes/utils/hex-to-decimal.js +6 -1
  17. package/dist/cjs/classes/utils/prepare-transaction.js +36 -59
  18. package/dist/cjs/index.d.ts +21 -22
  19. package/dist/cjs/index.js +56 -26
  20. package/dist/cjs/index.umd.js +1 -1
  21. package/dist/cjs/index.umd.js.map +1 -1
  22. package/dist/cjs/logger/logger.js +23 -79
  23. package/dist/cjs/logger/package-version.d.ts +1 -1
  24. package/dist/cjs/logger/package-version.js +4 -1
  25. package/dist/cjs/providers/AlchemyProvider.js +9 -82
  26. package/dist/cjs/providers/BaseProvider.js +511 -882
  27. package/dist/cjs/providers/FallthroughProvider.js +46 -123
  28. package/dist/cjs/providers/JsonRpcProvider.js +28 -93
  29. package/dist/cjs/providers/test/json-rpc-provider/get-logs/mocks.d.ts +14 -0
  30. package/dist/cjs/providers/test/json-rpc-provider/get-logs/mocks.js +152 -0
  31. package/dist/cjs/providers/test/mock-of.js +6 -8
  32. package/dist/cjs/providers/test/rpc-urls.d.ts +1 -0
  33. package/dist/cjs/providers/test/rpc-urls.js +23 -14
  34. package/dist/cjs/providers/utils/chains-info.d.ts +5 -448
  35. package/dist/cjs/providers/utils/chains-info.js +16 -1345
  36. package/dist/cjs/shared/tiny-big/helpers.js +42 -93
  37. package/dist/cjs/shared/tiny-big/tiny-big.js +72 -161
  38. package/dist/cjs/shared/validate-type.d.ts +1 -1
  39. package/dist/cjs/shared/validate-type.js +7 -7
  40. package/dist/cjs/types/Block.types.d.ts +3 -3
  41. package/dist/cjs/types/Block.types.js +2 -1
  42. package/dist/cjs/types/Contract.types.d.ts +4 -4
  43. package/dist/cjs/types/Contract.types.js +2 -1
  44. package/dist/cjs/types/FeeData.types.js +2 -1
  45. package/dist/cjs/types/Filter.types.js +2 -1
  46. package/dist/cjs/types/Network.types.js +2 -3
  47. package/dist/cjs/types/Transaction.types.d.ts +5 -5
  48. package/dist/cjs/types/Transaction.types.js +2 -1
  49. package/dist/cjs/utils/bytes.d.ts +4 -4
  50. package/dist/cjs/utils/bytes.js +318 -286
  51. package/dist/cjs/utils/compute-address.js +15 -8
  52. package/dist/cjs/utils/compute-public-key.js +10 -5
  53. package/dist/cjs/utils/ether-to-gwei.js +11 -10
  54. package/dist/cjs/utils/ether-to-wei.js +11 -10
  55. package/dist/cjs/utils/gwei-to-ether.js +11 -10
  56. package/dist/cjs/utils/hash-message.js +16 -11
  57. package/dist/cjs/utils/is-address.js +12 -8
  58. package/dist/cjs/utils/keccak256.js +14 -8
  59. package/dist/cjs/utils/solidity-keccak256.js +60 -49
  60. package/dist/cjs/utils/split-signature.js +73 -55
  61. package/dist/cjs/utils/to-checksum-address.js +20 -15
  62. package/dist/cjs/utils/to-utf8-bytes.js +6 -1
  63. package/dist/cjs/utils/wei-to-ether.js +15 -13
  64. package/dist/esm/classes/test/Contract/ens-abi.d.ts +1 -1
  65. package/dist/esm/classes/test/Contract/foo-abi.d.ts +1 -1
  66. package/dist/esm/classes/utils/fetchers.d.ts +8 -2
  67. package/dist/esm/classes/utils/fetchers.js +6 -3
  68. package/dist/esm/index.d.ts +21 -22
  69. package/dist/esm/index.js +16 -17
  70. package/dist/esm/logger/package-version.d.ts +1 -1
  71. package/dist/esm/logger/package-version.js +1 -1
  72. package/dist/esm/providers/FallthroughProvider.js +3 -3
  73. package/dist/esm/providers/test/json-rpc-provider/get-logs/mocks.d.ts +14 -0
  74. package/dist/esm/providers/test/json-rpc-provider/get-logs/mocks.js +142 -0
  75. package/dist/esm/providers/test/rpc-urls.d.ts +1 -0
  76. package/dist/esm/providers/test/rpc-urls.js +7 -4
  77. package/dist/esm/providers/utils/chains-info.d.ts +5 -448
  78. package/dist/esm/providers/utils/chains-info.js +13 -1344
  79. package/dist/esm/shared/validate-type.d.ts +1 -1
  80. package/dist/esm/types/Block.types.d.ts +3 -3
  81. package/dist/esm/types/Contract.types.d.ts +4 -4
  82. package/dist/esm/types/Transaction.types.d.ts +5 -5
  83. package/dist/esm/utils/bytes.d.ts +4 -4
  84. package/package.json +23 -51
  85. package/readme.md +15 -38
  86. package/dist/cjs/classes/test/Contract/crv.test.js +0 -690
  87. package/dist/cjs/classes/test/Contract/ens.test.js +0 -217
  88. package/dist/cjs/classes/test/Contract/fei.test.js +0 -224
  89. package/dist/cjs/classes/test/Contract/foo.test.js +0 -33
  90. package/dist/cjs/classes/test/Contract/uni.test.js +0 -387
  91. package/dist/cjs/providers/test/fallthrough-provider/get-gas-price.test.js +0 -228
  92. package/dist/cjs/providers/test/get-transaction-count.test.js +0 -276
  93. package/dist/cjs/providers/test/json-rpc-provider/call.test.js +0 -436
  94. package/dist/cjs/providers/test/json-rpc-provider/estimate-gas.test.js +0 -288
  95. package/dist/cjs/providers/test/json-rpc-provider/get-balance.test.js +0 -261
  96. package/dist/cjs/providers/test/json-rpc-provider/get-block-number.test.js +0 -159
  97. package/dist/cjs/providers/test/json-rpc-provider/get-block.test.js +0 -477
  98. package/dist/cjs/providers/test/json-rpc-provider/get-code.test.js +0 -311
  99. package/dist/cjs/providers/test/json-rpc-provider/get-fee-data.test.js +0 -212
  100. package/dist/cjs/providers/test/json-rpc-provider/get-gas-price.test.js +0 -164
  101. package/dist/cjs/providers/test/json-rpc-provider/get-logs.test.js +0 -361
  102. package/dist/cjs/providers/test/json-rpc-provider/get-network.test.js +0 -274
  103. package/dist/cjs/providers/test/json-rpc-provider/get-transaction-receipt.test.js +0 -301
  104. package/dist/cjs/providers/test/json-rpc-provider/get-transaction.test.js +0 -307
  105. package/dist/cjs/providers/test/test-alchemy-provider.test.js +0 -151
  106. package/dist/cjs/shared/tiny-big/helpers.test.js +0 -29
  107. package/dist/cjs/shared/tiny-big/tiny-big.test.js +0 -34
  108. package/dist/cjs/utils/tests/bytes/arrayify.test.js +0 -40
  109. package/dist/cjs/utils/tests/bytes/concat.test.js +0 -15
  110. package/dist/cjs/utils/tests/bytes/hex-concat.test.js +0 -63
  111. package/dist/cjs/utils/tests/bytes/hex-data-length.test.js +0 -49
  112. package/dist/cjs/utils/tests/bytes/hex-data-slice.test.js +0 -52
  113. package/dist/cjs/utils/tests/bytes/hex-strip-zeros.test.js +0 -58
  114. package/dist/cjs/utils/tests/bytes/hex-value.test.js +0 -85
  115. package/dist/cjs/utils/tests/bytes/hex-zero-pad.test.js +0 -62
  116. package/dist/cjs/utils/tests/bytes/hexlify.test.js +0 -62
  117. package/dist/cjs/utils/tests/bytes/is-bytes-like.test.js +0 -69
  118. package/dist/cjs/utils/tests/bytes/is-bytes.test.js +0 -33
  119. package/dist/cjs/utils/tests/bytes/is-hex-string.test.js +0 -88
  120. package/dist/cjs/utils/tests/bytes/strip-zeros.test.js +0 -57
  121. package/dist/cjs/utils/tests/bytes/zero-pad.test.js +0 -80
  122. package/dist/cjs/utils/tests/compute-address.test.js +0 -27
  123. package/dist/cjs/utils/tests/compute-public-key.test.js +0 -15
  124. package/dist/cjs/utils/tests/ether-to-gwei.test.js +0 -26
  125. package/dist/cjs/utils/tests/ether-to-wei.test.js +0 -44
  126. package/dist/cjs/utils/tests/gwei-to-ether.test.js +0 -28
  127. package/dist/cjs/utils/tests/hash-message.test.js +0 -21
  128. package/dist/cjs/utils/tests/is-address.test.js +0 -55
  129. package/dist/cjs/utils/tests/keccak256.test.js +0 -97
  130. package/dist/cjs/utils/tests/solidity-keccak256.test.js +0 -310
  131. package/dist/cjs/utils/tests/split-signature.test.js +0 -25
  132. package/dist/cjs/utils/tests/to-checksum-address.test.js +0 -42
  133. package/dist/cjs/utils/tests/to-utf8-bytes.test.js +0 -14
  134. package/dist/cjs/utils/tests/wei-to-ether.test.js +0 -51
@@ -1,3 +1,3 @@
1
- declare type JSPrimitiveTypes = 'string' | 'number' | 'bigint' | 'boolean' | 'symbol' | 'undefined' | 'object' | 'function';
1
+ type JSPrimitiveTypes = 'string' | 'number' | 'bigint' | 'boolean' | 'symbol' | 'undefined' | 'object' | 'function';
2
2
  export declare const validateType: (value: unknown, allowedTypes: JSPrimitiveTypes[]) => void;
3
3
  export {};
@@ -1,7 +1,7 @@
1
1
  import type { TinyBig } from './../shared/tiny-big/tiny-big';
2
2
  import type { BlockTransactionResponse, RPCTransaction } from './Transaction.types';
3
- declare type Modify<T, R> = Omit<T, keyof R> & R;
4
- export declare type BlockResponse = Modify<RPCBlock, {
3
+ type Modify<T, R> = Omit<T, keyof R> & R;
4
+ export type BlockResponse = Modify<RPCBlock, {
5
5
  baseFeePerGas: TinyBig;
6
6
  difficulty: TinyBig;
7
7
  gasLimit: TinyBig;
@@ -36,5 +36,5 @@ export interface RPCBlock {
36
36
  transactionsRoot: string;
37
37
  uncles: Array<string>;
38
38
  }
39
- export declare type BlockTag = 'latest' | 'earliest' | 'pending' | number | string;
39
+ export type BlockTag = 'latest' | 'earliest' | 'pending' | number | string;
40
40
  export {};
@@ -1,6 +1,6 @@
1
- export declare type ContractTypes = 'bool' | 'bytes1' | 'bytes2' | 'bytes3' | 'bytes4' | 'bytes5' | 'bytes6' | 'bytes7' | 'bytes8' | 'bytes9' | 'bytes10' | 'bytes11' | 'bytes12' | 'bytes13' | 'bytes14' | 'bytes15' | 'bytes16' | 'bytes17' | 'bytes18' | 'bytes19' | 'bytes20' | 'bytes21' | 'bytes22' | 'bytes23' | 'bytes24' | 'bytes25' | 'bytes26' | 'bytes27' | 'bytes28' | 'bytes29' | 'bytes30' | 'bytes31' | 'bytes32' | 'bytes32[]' | 'address' | 'address payable' | 'address[4]' | 'address[100]' | 'uint256' | 'uint256[100]' | 'uint8' | 'uint32' | string;
2
- export declare type ContractInterface = JSONABI;
3
- export declare type ContractFunction<T = any> = (...args: Array<any>) => Promise<T>;
1
+ export type ContractTypes = 'bool' | 'bytes1' | 'bytes2' | 'bytes3' | 'bytes4' | 'bytes5' | 'bytes6' | 'bytes7' | 'bytes8' | 'bytes9' | 'bytes10' | 'bytes11' | 'bytes12' | 'bytes13' | 'bytes14' | 'bytes15' | 'bytes16' | 'bytes17' | 'bytes18' | 'bytes19' | 'bytes20' | 'bytes21' | 'bytes22' | 'bytes23' | 'bytes24' | 'bytes25' | 'bytes26' | 'bytes27' | 'bytes28' | 'bytes29' | 'bytes30' | 'bytes31' | 'bytes32' | 'bytes32[]' | 'address' | 'address payable' | 'address[4]' | 'address[100]' | 'uint256' | 'uint256[100]' | 'uint8' | 'uint32' | string;
2
+ export type ContractInterface = JSONABI;
3
+ export type ContractFunction<T = any> = (...args: Array<any>) => Promise<T>;
4
4
  export interface JSONABIArgument {
5
5
  anonymous?: false;
6
6
  inputs: {
@@ -21,4 +21,4 @@ export interface JSONABIArgument {
21
21
  constant?: boolean;
22
22
  payable?: boolean;
23
23
  }
24
- export declare type JSONABI = JSONABIArgument[];
24
+ export type JSONABI = JSONABIArgument[];
@@ -1,12 +1,12 @@
1
1
  import type Big from 'big.js';
2
2
  import type { TinyBig } from '../shared/tiny-big/tiny-big';
3
3
  import type { BytesLike } from './../utils/bytes';
4
- declare type Modify<T, R> = Omit<T, keyof R> & R;
4
+ type Modify<T, R> = Omit<T, keyof R> & R;
5
5
  export interface RPCTransaction extends RPCBlockTransaction {
6
6
  maxFeePerGas: string;
7
7
  maxPriorityFeePerGas: string;
8
8
  }
9
- export declare type TransactionResponse = Modify<RPCTransaction, {
9
+ export type TransactionResponse = Modify<RPCTransaction, {
10
10
  blockNumber: number;
11
11
  chainId: number;
12
12
  gas: TinyBig;
@@ -22,7 +22,7 @@ export declare type TransactionResponse = Modify<RPCTransaction, {
22
22
  maxPriorityFeePerGas: TinyBig;
23
23
  confirmations: number;
24
24
  }>;
25
- export declare type TransactionReceipt = Modify<RPCTransactionReceipt, {
25
+ export type TransactionReceipt = Modify<RPCTransactionReceipt, {
26
26
  blockNumber: number;
27
27
  cumulativeGasUsed: TinyBig;
28
28
  effectiveGasPrice: TinyBig;
@@ -59,12 +59,12 @@ export interface TransactionRequest {
59
59
  maxPriorityFeePerGas?: TinyBig | string | Big | number;
60
60
  maxFeePerGas?: TinyBig | string | Big | number;
61
61
  }
62
- export declare type Log = Modify<RPCLog, {
62
+ export type Log = Modify<RPCLog, {
63
63
  blockNumber: number;
64
64
  logIndex: number;
65
65
  transactionIndex: number;
66
66
  }>;
67
- export declare type BlockTransactionResponse = Omit<TransactionResponse, 'maxFeePerGas' | 'maxPriorityFeePerGas'>;
67
+ export type BlockTransactionResponse = Omit<TransactionResponse, 'maxFeePerGas' | 'maxPriorityFeePerGas'>;
68
68
  export interface RPCBlockTransaction {
69
69
  blockHash: string;
70
70
  blockNumber: string;
@@ -1,6 +1,6 @@
1
- export declare type Bytes = ArrayLike<number>;
2
- export declare type BytesLike = Bytes | string;
3
- export declare type BytesLikeWithNumber = BytesLike | number;
1
+ export type Bytes = ArrayLike<number>;
2
+ export type BytesLike = Bytes | string;
3
+ export type BytesLikeWithNumber = BytesLike | number;
4
4
  export interface DataOptions {
5
5
  allowMissingPrefix?: boolean;
6
6
  hexPad?: 'left' | 'right' | null;
@@ -8,7 +8,7 @@ export interface DataOptions {
8
8
  export interface Hexable {
9
9
  toHexString(): string;
10
10
  }
11
- export declare type SignatureLike = {
11
+ export type SignatureLike = {
12
12
  r: string;
13
13
  s?: string;
14
14
  _vs?: string;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "essential-eth",
3
3
  "description": "Ultralight JS for Ethereum",
4
- "version": "0.9.0",
4
+ "version": "0.9.1-next.1",
5
5
  "license": "MIT",
6
6
  "sideEffects": false,
7
7
  "private": false,
@@ -19,39 +19,18 @@
19
19
  },
20
20
  "repository": "https://github.com/dawsbot/essential-eth.git",
21
21
  "author": "@dawsbot",
22
- "size-limit": [
23
- {
24
- "name": "etherToWei",
25
- "path": "src/index.ts",
26
- "import": "{ etherToWei }",
27
- "limit": "3.58kb"
28
- },
29
- {
30
- "name": "JsonRpcProvider",
31
- "path": "src/index.ts",
32
- "import": "{ JsonRpcProvider }",
33
- "limit": "20.32kb"
34
- },
35
- {
36
- "name": "Contract",
37
- "path": "src/index.ts",
38
- "import": "{ Contract }",
39
- "limit": "15.38kb"
40
- }
41
- ],
42
22
  "scripts": {
43
- "size": "npx size-limit",
44
23
  "test": "npm-run-all --parallel jest compile lint",
45
24
  "test:all-node-versions": "npx trevor",
46
25
  "lint": "eslint --cache --fix .",
47
26
  "compile": "npm-run-all --parallel build:esm build:cjs build:umd",
48
27
  "build": "rm -rf dist && npm run compile",
49
28
  "build:esm": "tsc -p tsconfig.json",
50
- "build:cjs": "swc src -d dist/cjs",
29
+ "build:cjs": "tsc -p tsconfig-cjs.json",
51
30
  "build:umd": "microbundle --external none --format umd",
52
31
  "build:readme": "bash ./scripts/markdown-magic/build-readme.sh",
53
32
  "jest": "jest",
54
- "build:chains-info": "npx ts-node scripts/fetch-chains-info.ts # used in getNetwork()",
33
+ "build:chains-info": "npx tsx scripts/update-chains-info/index.ts # used in getNetwork()",
55
34
  "update-deps": "sh ./scripts/pre-commit.sh",
56
35
  "pre-commit": "npm run update-deps",
57
36
  "prepare": "husky install",
@@ -61,40 +40,33 @@
61
40
  "doc": "typedoc"
62
41
  },
63
42
  "devDependencies": {
64
- "@size-limit/preset-small-lib": "^7.0.8",
65
- "@swc/cli": "^0.1.57",
66
- "@swc/core": "^1.3.21",
67
- "@types/body-parser": "^1.19.1",
68
- "@types/eslint": "^8.4.2",
69
- "@types/express": "^4.17.13",
43
+ "@size-limit/preset-small-lib": "^8.2.4",
44
+ "@swc/cli": "^0.1.62",
45
+ "@swc/core": "^1.3.53",
46
+ "@types/bn.js": "^5.1.1",
47
+ "@types/eslint": "^8.37.0",
70
48
  "@types/jest": "^27.4.1",
71
- "@types/jest-dev-server": "^5.0.0",
72
- "@types/node": "^16.10.1",
73
- "@types/prettier": "^2.4.4",
74
- "@typescript-eslint/eslint-plugin": "^5.26.0",
75
- "@typescript-eslint/parser": "^5.26.0",
76
- "body-parser": "^1.19.0",
49
+ "@types/node": "^18.16.0",
50
+ "@types/prettier": "^2.7.2",
51
+ "@typescript-eslint/eslint-plugin": "^5.59.0",
52
+ "@typescript-eslint/parser": "^5.59.0",
53
+ "bn.js": "^5.2.1",
77
54
  "dotenv": "^16.0.0",
78
55
  "eslint": "^8.16.0",
79
56
  "eslint-plugin-jest": "^26.2.2",
80
- "eslint-plugin-jsdoc": "38.0.2",
81
- "ethers": "^5.7.2",
82
- "express": "^4.17.1",
57
+ "eslint-plugin-jsdoc": "^38.0.2",
83
58
  "husky": "^7.0.4",
84
59
  "jest": "^27.5.1",
85
- "jest-dev-server": "^6.0.3",
86
- "just-omit": "^2.0.1",
87
- "lint-staged": "^12.4.1",
88
- "microbundle": "^0.15.0",
60
+ "lint-staged": "^13.2.1",
61
+ "microbundle": "^0.15.1",
89
62
  "npm-run-all": "^4.1.5",
90
63
  "perf_hooks": "^0.0.1",
91
- "prettier": "^2.8.4",
92
- "prettier-plugin-organize-imports": "^2.3.4",
64
+ "prettier": "^3.2.5",
65
+ "prettier-plugin-organize-imports": "^3.2.4",
93
66
  "ts-jest": "^27.1.4",
94
67
  "ts-node": "^10.2.1",
95
- "typedoc": "^0.22.15",
96
- "typescript": "^4.6.4",
97
- "web3": "^1.8.1",
68
+ "typedoc": "^0.24.5",
69
+ "typescript": "^4.9.4",
98
70
  "zod": "^3.21.4"
99
71
  },
100
72
  "dependencies": {
@@ -105,10 +77,10 @@
105
77
  "sha3": "^2.1.4"
106
78
  },
107
79
  "lint-staged": {
108
- "*.{js,jsx,ts,tsx,css,scss,md,json,html,yml,yaml}": [
109
- "prettier --write"
80
+ "*": [
81
+ "prettier --ignore-unknown --write"
110
82
  ],
111
- "*.{ts,tsx}": "eslint --cache --fix"
83
+ "*.{ts,tsx,js,jsx}": "eslint --cache --fix"
112
84
  },
113
85
  "prettier": {
114
86
  "trailingComma": "all",
package/readme.md CHANGED
@@ -36,7 +36,7 @@
36
36
  - ๐ŸŸฃ Polygon
37
37
  - ๐Ÿ”ด Optimism
38
38
  - ๐Ÿ”ต Arbitrum
39
- - [Many more](src/providers/utils/chains-info.ts)
39
+ - [Many more](https://github.com/dawsbot/essential-eth/tree/master/src/providers/utils/chains-info.ts)
40
40
  - ๐Ÿงช Strongly tested
41
41
  - ๐ŸŒฒ Tree-shaking and no side-effects
42
42
  - ๐Ÿ™Œ All common JS versions (CommonJS, ESM, & UMD)
@@ -103,10 +103,7 @@
103
103
  - [More Info](#more-info)
104
104
  - [Identical vs Similar vs Dissimilar {&#035;isd}](#identical-vs-similar-vs-dissimilar-isd)
105
105
  - [Miscellaneous](#miscellaneous)
106
- - [GitPOAP](#gitpoap)
107
- - [What is a GitPOAP?](#what-is-a-gitpoap)
108
- - [How can I claim?](#how-can-i-claim)
109
- - [What issues should I start on first?](#what-issues-should-i-start-on-first)
106
+ - [Contributing and GitPOAP](#contributing-and-gitpoap)
110
107
 
111
108
  </details>
112
109
 
@@ -129,7 +126,7 @@ Browsers:
129
126
 
130
127
  ```html
131
128
  <!-- index.html -->
132
- <script src="https://unpkg.com/essential-eth@0.9.0"></script>
129
+ <script src="https://unpkg.com/essential-eth@0.9.1-next.1"></script>
133
130
  ```
134
131
 
135
132
  <!-- โ›”๏ธ AUTO-GENERATED-CONTENT:END (UNPKG_SCRIPT_TAG) -->
@@ -808,15 +805,15 @@ import { splitSignature } from 'essential-eth';
808
805
  ```javascript
809
806
  const signature = '0x60bc4ed91f2021aefe7045f3f77bd12f87eb733aee24bd1965343b3c27b3971647252185b7d2abb411b01b5d1ac4ab41ea486df1e9b396758c1aec6c1b6eee331b';
810
807
  splitSignature(signature);
811
- {
812
- r: "0x60bc4ed91f2021aefe7045f3f77bd12f87eb733aee24bd1965343b3c27b39716",
813
- s: "0x47252185b7d2abb411b01b5d1ac4ab41ea486df1e9b396758c1aec6c1b6eee33",
814
- _vs: "0x47252185b7d2abb411b01b5d1ac4ab41ea486df1e9b396758c1aec6c1b6eee33",
815
- recoveryParam: 0,
816
- v: 27,
817
- yParityAndS: "0x47252185b7d2abb411b01b5d1ac4ab41ea486df1e9b396758c1aec6c1b6eee33",
818
- compact: "0x60bc4ed91f2021aefe7045f3f77bd12f87eb733aee24bd1965343b3c27b3971647252185b7d2abb411b01b5d1ac4ab41ea486df1e9b396758c1aec6c1b6eee33"
819
- }
808
+ {
809
+ r: "0x60bc4ed91f2021aefe7045f3f77bd12f87eb733aee24bd1965343b3c27b39716",
810
+ s: "0x47252185b7d2abb411b01b5d1ac4ab41ea486df1e9b396758c1aec6c1b6eee33",
811
+ _vs: "0x47252185b7d2abb411b01b5d1ac4ab41ea486df1e9b396758c1aec6c1b6eee33",
812
+ recoveryParam: 0,
813
+ v: 27,
814
+ yParityAndS: "0x47252185b7d2abb411b01b5d1ac4ab41ea486df1e9b396758c1aec6c1b6eee33",
815
+ compact: "0x60bc4ed91f2021aefe7045f3f77bd12f87eb733aee24bd1965343b3c27b3971647252185b7d2abb411b01b5d1ac4ab41ea486df1e9b396758c1aec6c1b6eee33"
816
+ }
820
817
  ```
821
818
 
822
819
  </details>
@@ -1585,28 +1582,8 @@ Note: In `web3.js`, almost every method or function can be passed a callback. `e
1585
1582
  - [๐Ÿ““ View changelog (by looking at releases diff)](https://github.com/dawsbot/essential-eth/releases)
1586
1583
  - [๐Ÿ“‹ View our project board](https://github.com/dawsbot/essential-eth/projects/1)
1587
1584
 
1588
- ### GitPOAP
1585
+ ## Contributing and GitPOAP
1589
1586
 
1590
- In partnership with GitPOAP, Essential ETH wants to recognize **all** contributors for their contributions toward the growth of this library. Developers can validate their contributions on Github and showcase their GitPOAP as proof-of-work toward their Web3 identity.
1587
+ We welcome and appreciate all contributions to Essential Eth! If you're interested in helping us improve this library, please read our [Contributing Guidelines](https://github.com/dawsbot/essential-eth/blob/master/CONTRIBUTING.md) to understand the types of contributions we're looking for and the process of making them.
1591
1588
 
1592
- <br/>
1593
-
1594
- ![Alt](https://www.gitpoap.io/_next/image?url=https%3A%2F%2Fassets.poap.xyz%2Fgitpoap3a-2023-essential-eth-contributor-2022-logo-1670961141021.png&w=750&q=75)
1595
-
1596
- <br/>
1597
-
1598
- #### What is a GitPOAP?
1599
-
1600
- GitPOAP is a contributor recognition platform built on top of the POAP Protocol (Proof of Attendance Protocol). Similar to a POAP, each GitPOAP represents a digital collectible. It serves as a badge of validation for the action taken by the individual. By serving as a bridge between Github and Web3, it allows repo maintainers to recognize contributors for their meaningful contributions. Learn more about GitPOAP, [here](https://www.gitpoap.io/).
1601
-
1602
- #### How can I claim?
1603
-
1604
- Here are two steps that you can take to qualify for a GitPOAP:
1605
-
1606
- 1. Contribute to [any open issue](https://github.com/dawsbot/essential-eth/issues) and submit a PR. Upon approval of PR merge, the GitPOAP will automatically be issued to the Github account.
1607
-
1608
- 2. Head to gitpoap.io and connect your GitHub account to mint!
1609
-
1610
- #### What issues should I start on first?
1611
-
1612
- We have set up a GitHub project [here](https://github.com/dawsbot/essential-eth/projects/1) for you to see all the issues by priority.
1589
+ In partnership with GitPOAP, Essential ETH wants to recognize **all** contributors for their contributions toward the growth of this library. More information about GitPOAP can be found on the [Contributing Guidelines](https://github.com/dawsbot/essential-eth/blob/master/CONTRIBUTING.md#GitPOAP).