-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
48cb5c3
commit 29548f0
Showing
1 changed file
with
46 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
// ... | ||
} | ||
``` |