Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sriharikapu/dappateer
https://github.com/sriharikapu/dappateer
dappateer e2e-tests ethereum
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/sriharikapu/dappateer
- Owner: sriharikapu
- License: other
- Created: 2021-04-14T14:54:49.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-04-14T20:53:57.000Z (over 3 years ago)
- Last Synced: 2024-10-10T22:51:31.508Z (about 1 month ago)
- Topics: dappateer, e2e-tests, ethereum
- Language: CSS
- Homepage: https://www.npmjs.com/package/@sriharikapu/dappeteer
- Size: 10.9 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dAppeteer
E2E testing for dApps using Puppeteer + MetaMask
Supports Latest `Metamask Version 9.3.0`
## Installation
```
$ npm install -s dappeteer
```
## Usage
```js
import puppeteer from 'puppeteer'
import dappeteer from 'dappeteer'
async function main() {
const browser = await dappeteer.launch(puppeteer)
const metamask = await dappeteer.getMetamask(browser)
// create or import a private key
await metamask.importPK('fa21...213da2b')
// switch to imported account
await metamask.switchAccount(index);
// you can change the network if you want
await metamask.switchNetwork('ropsten')
// go to a dapp and do something that prompts MetaMask to confirm a transaction
const page = await browser.newPage()
await page.goto('http://my-dapp.com')
const payButton = await page.$('#pay-with-eth')
await payButton.click()
// 🏌
await metamask.confirmTransaction()
}
main()
```
## API
- `dappeteer.launch(puppeteer[, launchOptions])`: returns an instance of `browser`, same as `puppeteer.launch`, but it also installs the MetaMask extension. It supports all the regular `puppeteer.launch` options as a second argument with the addition of two extra ones:
- `metamaskPath`: Path to the MetaMask extension (by default it uses the one bundled)
- `extensionUrl`: URL of the MetaMask extension, by default it is `chrome-extension://nkbihfbeogaeaoehlefnkodbefgpgknn/popup.html` but if you use a different version you might need to change it use the right extension id.
- `dappeteer.getMetaMask(browser)`: returns a promise that resolves to an object that allows you to interact with MetaMask by using the following methods:
- `metamask.switchAccount(accountIndex)`: it commands MetaMask to switch to a different account, by passing the index/position of the account in the accounts list.
- `metamask.importPK(privateKey)`: it commands MetaMask to import an private key. It can only be used while you haven't signed in yet, otherwise it throws.
- `metamask.lock()`: signs out from MetaMask. It can only be used if you arelady signed it, otherwise it throws.
- `metamask.unlock([password])`: it unlocks the MetaMask extension. It can only be used in you locked/signed out before, otherwise it throws. The password is optional, it defaults to `password1234`.
- `metamask.switchNetwork(networkName)`: it changes the current selected network. `networkName` can take the following values: `"main"`, `"ropsten"`, `"rinkeby"`, `"kovan"`, `"localhost"`.
- `metamask.addNetwork(url)`: it adds a custom network to MetaMask.
- `metamask.confirmTransaction([{ gas, gasLimit }])`: commands MetaMask to submit a transaction. For this to work MetaMask has to be in a transaction confirmation state (basically promting the user to submit/reject a transaction). You can (optionally) pass an object with `gas` and/or `gasLimit`, by default they are `20` and `50000` respectively.
- `metamask.sign()`: commands MetaMask to sign a message. For this to work MetaMask must be in a sign confirmation state.
- `metamask.approve({ allAccounts })`: confirm Dapp permissions to use Metamask account. If you plan to use the Dapp with multiple accounts you can use `allAccounts` to add permission to all imported accounts. By default is false