Skip to content

Commit

Permalink
read me doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@jdevcs
jdevcs committed Jan 11, 2024
1 parent 38c350c commit 1084152
Showing 1 changed file with 305 additions and 18 deletions.
323 changes: 305 additions & 18 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,35 +1,322 @@
# Web3.js EIP4337 Plugin

This plugin is developed and maintained by [Blocto](https://blocto.io/) .
( This plugin is developed and maintained by [Blocto](https://blocto.io/) ).

Web3.js EIP4337 is a [web3.js](https://github.com/web3/web3.js) `4.x` plugin for Account Abstraction functionality.


```ts
import { Web3 } from 'web3';
import { EIP4337Plugin } from 'web3-plugin-eip4337';

const web3 = new Web3('http://127.0.0.1:8545');
web3.registerPlugin(new EIP4337Plugin());

web3.EIP4337.sendUserOperation('...');
```

## Functionality

### sendUserOperation
Sends a UserOperation to the bundler. If accepted, the bundler will add it to the UserOperation mempool and return a userOpHash.

#### Parameters
- `UserOperation` - represents the structure of a transaction initiated by the user. It contains the sender, receiver, call data, maximum fee per unit of Gas, maximum priority fee, signature, nonce, and other specific elements.

- `entryPoint` - a singleton contract to execute bundles of UserOperations. Bundlers/Clients whitelist the supported entrypoint.

#### Returns
- userOperation hash or throws error instead of balance.

#### Example
```ts
web3.EIP4337.sendUserOperation({
sender: "0x9fd042a18e90ce326073fa70f111dc9d798d9a52",
nonce: "123",
initCode: "0x68656c6c6f",
callData: "0x776F726C64",
callGasLimit: "1000",
verificationGasLimit: "2300",
preVerificationGas: "3100",
maxFeePerGas: "8500",
maxPriorityFeePerGas: "1",
paymasterAndData: "0x626c6f63746f",
signature: "0x636c656d656e74"
},"0x636c656d656e74").then(console.log);
> 0xe554d0701f7fdc734f84927d109537f1ac4ee4ebfa3670c71d224a4fa15dbcd1
```

### estimateUserOperationGas
Estimate the gas values for a UserOperation. Given UserOperation optionally without gas limits and gas prices, return the needed gas limits. The signature field is ignored by the wallet, so that the operation will not require user's approval. Still, it might require putting a "semi-valid" signature (e.g. a signature in the right length)

#### Parameters
- `UserOperation` - represents the structure of a transaction initiated by the user. It contains the sender, receiver, call data, maximum fee per unit of Gas, maximum priority fee, signature, nonce, and other specific elements.

- `entryPoint` - a singleton contract to execute bundles of UserOperations. Bundlers/Clients whitelist the supported entrypoint.

#### Returns
- Object having:
- `preVerificationGas` gas overhead of this UserOperation
- `verificationGasLimit` actual gas used by the validation of this UserOperation
- `callGasLimit` value used by inner account execution

#### Example
```ts
web3.EIP4337.estimateUserOperationGas({
sender: "0x9fd042a18e90ce326073fa70f111dc9d798d9a52",
nonce: "123",
initCode: "0x68656c6c6f",
callData: "0x776F726C64",
callGasLimit: "1000",
verificationGasLimit: "2300",
preVerificationGas: "3100",
maxFeePerGas: "0",
maxPriorityFeePerGas: "0",
paymasterAndData: "0x626c6f63746f",
signature: "0x636c656d656e74"
},"0x636c656d656e74").then(console.log);
> {
callGasLimit : "0x18b33",
preVerificationGas: "0xdf17",
verificationGasLimit:"0x128c4"
}
```

### getUserOperationByHash
Return a UserOperation based on a hash (userOpHash) returned by eth_sendUserOperation

#### Parameters
- `hash` - a userOpHash value returned by `eth_sendUserOperation`

#### Returns
- Null in case the UserOperation is not yet included in a block, or a full UserOperation, with the addition of entryPoint, blockNumber, blockHash and transactionHash

#### Example
```ts
web3.EIP4337.getUserOperationByHash("0xxxxx").then(console.log);
> {
userOperation: {
sender: "xxxx",
nonce: "xxxx",
initCode: "0xxxxxxxxxxxxxxx",
callData: "0xxxxxxxxxxxxxxx",
callGasLimit: "xxxx",
verificationGasLimit: "xxxx",
preVerificationGas: "xxxx",
maxFeePerGas: "0",
maxPriorityFeePerGas: "0",
paymasterAndData: "0xxxxxxxxxxxxxxx",
signature: "0xxxxxxxxxxxxxxx"
},
entryPoint: '0x5ff137d4b0fdcd49dca30c7cf57e578a026d2789',
blockNumber: 39642225,
blockHash: '0x638a175940cacb33f35e265961b164b14aa77477438340e635b227752f31981f',
transactionHash: '0xc3e64ac247ae2343335596e106d1b97e35637656e1b99b37977a4165b34aeeb4',
}
```

### getUserOperationReceipt
Return null in case the UserOperation is not yet included in a block, or
- userOpHash the request hash
- entryPoint
- sender
- nonce
- paymaster the paymaster used for this userOp (or empty)
- actualGasCost - actual amount paid (by account or paymaster) for this UserOperation
- actualGasUsed - total gas used by this UserOperation (including preVerification, creation, validation and execution)
- success boolean - did this execution completed without revert
- reason in case of revert, this is the revert reason
- logs the logs generated by this UserOperation (not including logs of other UserOperations in the same bundle)
- receipt the TransactionReceipt object. Note that the returned TransactionReceipt is for the entire bundle, not only for this UserOperation.

#### Parameters
- `hash` - hash a userOpHash value returned by `eth_sendUserOperation`

#### Returns
- Null in case the UserOperation is not yet included in a block, or UserOperation receipt

#### Example
```ts
web3.EIPI4337.getUserOperationReceipt("0xa890d7c0dccfd6cebc025919f4857ab97953ae218e82f5e24c297f02ceea5b21").then(console.log);
>"userOpHash": "0xa890d7c0dccfd6cebc025919f4857ab97953ae218e82f5e24c297f02ceea5b21",
"entryPoint": "0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789",
"sender": "0x026B37A09aF3ceB346c39999c5738F86A1a48f4d",
"nonce": "0x7",
"paymaster": "0xa312d8D37Be746BD09cBD9e9ba2ef16bc7Da48FF",
"actualGasCost": "0x1a036c1638be0",
"actualGasUsed": "0x2e8d8",
"success": true,
"reason": "",
"logs": [
{
"address": "0x5ff137d4b0fdcd49dca30c7cf57e578a026d2789",
"topics": [
"0xbb47ee3e183a558b1a2ff0874b079f3fc5478b7454eacf2bfc5af2ff5878f972"
],
"data": "0x",
"blockHash": "0x638a175940cacb33f35e265961b164b14aa77477438340e635b227752f31981f",
"blockNumber": "0x25ce471",
"transactionHash": "0xc3e64ac247ae2343335596e106d1b97e35637656e1b99b37977a4165b34aeeb4",
"transactionIndex": "0x44",
"logIndex": "0x12d",
"removed": false
},
{
"address": "0xfd8ec18d48ac1f46b600e231da07d1da8209ceef",
"topics": [
"0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
"0x0000000000000000000000000000000000000000000000000000000000000000",
"0x000000000000000000000000026b37a09af3ceb346c39999c5738f86a1a48f4d",
"0x000000000000000000000000000000000000000000000000000000000000007f"
],
"data": "0x",
"blockHash": "0x638a175940cacb33f35e265961b164b14aa77477438340e635b227752f31981f",
"blockNumber": "0x25ce471",
"transactionHash": "0xc3e64ac247ae2343335596e106d1b97e35637656e1b99b37977a4165b34aeeb4",
"transactionIndex": "0x44",
"logIndex": "0x12e",
"removed": false
},
{
"address": "0x00005ea00ac477b1030ce78506496e8c2de24bf5",
"topics": [
"0xe90cf9cc0a552cf52ea6ff74ece0f1c8ae8cc9ad630d3181f55ac43ca076b7d6",
"0x000000000000000000000000fd8ec18d48ac1f46b600e231da07d1da8209ceef",
"0x000000000000000000000000026b37a09af3ceb346c39999c5738f86a1a48f4d",
"0x0000000000000000000000000000a26b00c1f0df003000390027140000faa719"
],
"data": "0x000000000000000000000000026b37a09af3ceb346c39999c5738f86a1a48f4d0000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003e80000000000000000000000000000000000000000000000000000000000000000",
"blockHash": "0x638a175940cacb33f35e265961b164b14aa77477438340e635b227752f31981f",
"blockNumber": "0x25ce471",
"transactionHash": "0xc3e64ac247ae2343335596e106d1b97e35637656e1b99b37977a4165b34aeeb4",
"transactionIndex": "0x44",
"logIndex": "0x12f",
"removed": false
},
{
"address": "0x5ff137d4b0fdcd49dca30c7cf57e578a026d2789",
"topics": [
"0x49628fd1471006c1482da88028e9ce4dbb080b815c9b0344d39e5a8e6ec1419f",
"0xa890d7c0dccfd6cebc025919f4857ab97953ae218e82f5e24c297f02ceea5b21",
"0x000000000000000000000000026b37a09af3ceb346c39999c5738f86a1a48f4d",
"0x000000000000000000000000a312d8d37be746bd09cbd9e9ba2ef16bc7da48ff"
],
"data": "0x000000000000000000000000000000000000000000000000000000000000000700000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000001a036c1638be0000000000000000000000000000000000000000000000000000000000002e8d8",
"blockHash": "0x638a175940cacb33f35e265961b164b14aa77477438340e635b227752f31981f",
"blockNumber": "0x25ce471",
"transactionHash": "0xc3e64ac247ae2343335596e106d1b97e35637656e1b99b37977a4165b34aeeb4",
"transactionIndex": "0x44",
"logIndex": "0x130",
"removed": false
}
],
"receipt": {
"transactionHash": "0xc3e64ac247ae2343335596e106d1b97e35637656e1b99b37977a4165b34aeeb4",
"transactionIndex": "0x44",
"blockHash": "0x638a175940cacb33f35e265961b164b14aa77477438340e635b227752f31981f",
"blockNumber": "0x25ce471",
"from": "0x1e6754b227c6ae4b0ca61d82f79d60660737554a",
"to": "0x5ff137d4b0fdcd49dca30c7cf57e578a026d2789",
"cumulativeGasUsed": "0x1716d3b",
"gasUsed": "0x2b6c6",
"contractAddress": null,
"logs": [
{
"address": "0xfd8ec18d48ac1f46b600e231da07d1da8209ceef",
"topics": [
"0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
"0x0000000000000000000000000000000000000000000000000000000000000000",
"0x000000000000000000000000026b37a09af3ceb346c39999c5738f86a1a48f4d",
"0x000000000000000000000000000000000000000000000000000000000000007f"
],
"data": "0x",
"blockHash": "0x638a175940cacb33f35e265961b164b14aa77477438340e635b227752f31981f",
"blockNumber": "0x25ce471",
"transactionHash": "0xc3e64ac247ae2343335596e106d1b97e35637656e1b99b37977a4165b34aeeb4",
"transactionIndex": "0x44",
"logIndex": "0x12e",
"removed": false
},
],
"status": "0x1",
"logsBloom": "0x000000000000000000000000000000000008000000000000000000000000000000080000000000000002001108040020001080000000000000000200004000000000000000000000000800080000008000000000000000000001000208400040000000000a0008000000000000000800000000000000004080800010020100040000000000000000100000000000010000000000200080000000000000000000210000000000000000400080000000000000000000000000108002000004004008000002000000000001001000800000000001000000800000148040020020000000000000000000000001000000000100000000000000000000002000100000",
"type": "0x2",
"effectiveGasPrice": "0x59682f2e"
}
```

### supportedEntryPoints
Returns an array of the entryPoint addresses supported by the client. The first element of the array SHOULD be the entryPoint addressed preferred by the client.

#### Parameters
- None

#### Returns
- an array of the entryPoint addresses supported by the client. The first element of the array SHOULD be the entryPoint addressed preferred by the client.

#### Example
```ts
web3.EIP4337.supportedEntryPoints().then(console.log);
> ["0xcd01C8aa8995A59eB7B2627E69b40e0524B5ecf8", "0x7A0A0d159218E6a2f407B99173A2b12A6DDfC2a6"]
```


### generateUserOpHash
calculate UserOperationHash

#### Parameters
- `userOp` - a structure that describes a transaction to be sent on behalf of a user.

- `entryPoint` - a singleton contract to execute bundles of UserOperations. Bundlers/Clients whitelist the supported entrypoint.

#### Returns
- An array of the entryPoint addresses supported by the client. The first element of the array SHOULD be the entryPoint addressed preferred by the client.

#### Example
```ts
web3.EIP4337.generateUserOpHash({
sender: "0x9fd042a18e90ce326073fa70f111dc9d798d9a52",
nonce: "123",
initCode: "0x68656c6c6f",
callData: "0x776F726C64",
callGasLimit: "1000",
verificationGasLimit: "2300",
preVerificationGas: "3100",
maxFeePerGas: "0",
maxPriorityFeePerGas: "0",
paymasterAndData: "0x626c6f63746f",
signature: "0x636c656d656e74"
},"0x636c656d656e74", '0x1').then(console.log);
> 0xxxx
```

This is a [web3.js](https://github.com/web3/web3.js) `4.x` plugin for Account Abstraction functionality.

## Run the tests

1. Clone the repo
2. Run `yarn` to install dependencies
- If you receive the following warning, please remove the file `package-lock.json` and make sure to run `yarn` to install dependencies instead of `npm i`:
- If you receive the following warning, please remove the file `package-lock.json` and make sure to run `yarn` to install dependencies instead of `npm i`:

```console
warning package-lock.json found. Your project contains lock files generated by tools other than Yarn. It is advised not to mix package managers in order to avoid resolution inconsistencies caused by unsynchronized lock files. To clear this warning, remove package-lock.json.
```

3. Run the tests:
- `yarn test:unit`: Runs the mocked tests that do not make a network request using the [Jest](https://jestjs.io/) framework
- End-to-end tests: Runs Webpack bundled tests that make a network request to the RPC provider `https://rpc.ankr.com/eth` and returns an actual response from `MainnetPriceFeeds.LinkEth` smart contract using the [Cypress](https://www.cypress.io/) framework
- `yarn test:e2e:chrome`: Runs the tests using Chrome
- `yarn test:e2e:electron`: Runs the tests using Electron
- `yarn test:e2e:firefox`: Runs the tests using Firefox
- Black box tests: Uses a published version of the plugin from [Verdaccio](https://verdaccio.org/) to run tests that make a network request to the RPC provider `https://rpc.ankr.com/eth` and returns an actual response from `MainnetPriceFeeds.LinkEth` smart contract using the [Jest](https://jestjs.io/) framework
- NOTE The black box tests are setup to run within Github actions environment, but can be ran locally. The [black_box_test_helpers.sh](https://github.com/ChainSafe/web3.js-plugin-chainlink/blob/master/scripts/black_box_test_helpers.sh) script can be used to:
- `start`: Start Verdaccio using a Docker container
- `stop`: Kill the Docker container
- `startBackgroundAndPublish`: Starts a headless Docker container and publishes the plugin package
- `runTests`: `cd`s into the `test/black_box` directory, installs the black box package dependencies, and runs `yarn test` which will use Jest to run the tests
- In addition to the `black_box_test_helpers.sh` script, the black box tests can be ran using the following `package.json` scripts:
1. `yarn pre-black-box`: Calls `startBackgroundAndPublish` from the `black_box_test_helpers.sh` script
2. `yarn test:black-box`: Calls `yarn pre-black-box` and `runTests` from the from the `black_box_test_helpers.sh` script
3. `yarn post-black-box`: Calls `stop` from the `black_box_test_helpers.sh` script
- `yarn test:unit`: Runs the mocked tests that do not make a network request using the [Jest](https://jestjs.io/) framework
- End-to-end tests: Runs Webpack bundled tests that make a network request to the RPC provider `https://rpc.ankr.com/eth` and returns an actual response from `MainnetPriceFeeds.LinkEth` smart contract using the [Cypress](https://www.cypress.io/) framework
- `yarn test:e2e:chrome`: Runs the tests using Chrome
- `yarn test:e2e:electron`: Runs the tests using Electron
- `yarn test:e2e:firefox`: Runs the tests using Firefox
- Black box tests: Uses a published version of the plugin from [Verdaccio](https://verdaccio.org/) to run tests that make a network request to the RPC provider `https://rpc.ankr.com/eth` and returns an actual response from `MainnetPriceFeeds.LinkEth` smart contract using the [Jest](https://jestjs.io/) framework
- NOTE The black box tests are setup to run within Github actions environment, but can be ran locally. The [black_box_test_helpers.sh](https://github.com/ChainSafe/web3.js-plugin-chainlink/blob/master/scripts/black_box_test_helpers.sh) script can be used to:
- `start`: Start Verdaccio using a Docker container
- `stop`: Kill the Docker container
- `startBackgroundAndPublish`: Starts a headless Docker container and publishes the plugin package
- `runTests`: `cd`s into the `test/black_box` directory, installs the black box package dependencies, and runs `yarn test` which will use Jest to run the tests
- In addition to the `black_box_test_helpers.sh` script, the black box tests can be ran using the following `package.json` scripts:
1. `yarn pre-black-box`: Calls `startBackgroundAndPublish` from the `black_box_test_helpers.sh` script
2. `yarn test:black-box`: Calls `yarn pre-black-box` and `runTests` from the from the `black_box_test_helpers.sh` script
3. `yarn post-black-box`: Calls `stop` from the `black_box_test_helpers.sh` script

## License

Expand Down

0 comments on commit 1084152

Please sign in to comment.