Skip to content

Commit

Permalink
add argentx connector docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dhruvkelawala committed Mar 8, 2022
1 parent 48cb5c3 commit 29548f0
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions docs/connectors/argentx.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# `web3-react` Documentation - ArgentX

- [Install](#install)
- [Arguments](#arguments)
- [Example](#example)
- [Errors](#errors)
- [NoStarknetProviderError](#nostarknetprovidererror)
- [Example](#example-1)
- [UserRejectedRequestError](#userrejectedrequesterror)
- [Example](#example-2)

## Install

`yarn add @web3-starknet-react/argentx-connector`

## Arguments

```typescript
supportedChainIds?: number[]
```

**NOTE**: Currently only Goerli (chainId: 5) is supported. As soon as ArgentX supports mainnet (chainId: 1), I will add support for that.

## Example

```javascript
import { ArgentXConnector } from '@web3-starknet-react/argentx-connector'

const argentx = new ArgentXConnector({ supportedChainIds: [5] })
```

## Errors

### NoEthereumProviderError

#### Example

```javascript
import { NoStarknetProviderError } from '@web3-starknet-react/argentx-connector'

function Component() {
const { error } = useStarknetReact()
const isNoStarknetProviderError = error instanceof NoStarknetProviderError
// ...
}
```

0 comments on commit 29548f0

Please sign in to comment.