Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/perawallet/connect
JavaScript SDK for integrating Pera Wallet to web applications.
https://github.com/perawallet/connect
Last synced: 3 months ago
JSON representation
JavaScript SDK for integrating Pera Wallet to web applications.
- Host: GitHub
- URL: https://github.com/perawallet/connect
- Owner: perawallet
- License: other
- Created: 2022-04-06T17:40:46.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T08:37:53.000Z (3 months ago)
- Last Synced: 2024-04-08T10:00:50.038Z (3 months ago)
- Language: TypeScript
- Homepage: https://perawallet.app
- Size: 2.12 MB
- Stars: 61
- Watchers: 2
- Forks: 16
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Lists
- awesome-algorand - perawallet-connect - JavaScript SDK for integrating Pera Wallet to web applications. (Development Tools / Languages)
README
## @perawallet/connect
JavaScript SDK for integrating [Pera Wallet](https://perawallet.app) to web applications. For more detailed information, please check our [Pera Connect Docs](https://docs.perawallet.app/references/pera-connect/).
[](https://www.npmjs.com/package/@perawallet/connect) [](https://www.npmjs.com/package/@perawallet/connect)
## Getting Started
[Learn how to integrate with your JavaScript application](#guide)
[Learn how to Sign Transactions](#sign-transaction)
[Try it out using CodeSandbox](#example-applications)
## Example Applications
Expand details
- [Using React Hooks](https://codesandbox.io/s/perawallet-connect-react-demo-zlvokc)
- [Using React Hooks with React@18](https://codesandbox.io/s/perawallet-connect-react-18-demo-tig2md)
- [Using Vue3](https://codesandbox.io/s/perawallet-connect-vue3-demo-yiyw4b)
- [Using Svelte](https://codesandbox.io/s/perawallet-connect-svelte-demo-ys1m4x)
- [Using Next.js](https://codesandbox.io/s/perawallet-connect-next-js-demo-ryhbdb)
- [Using Nuxt.js](https://codesandbox.io/s/perawallet-connect-nuxt-js-demo-s65z58)
- [Vanilla JS](https://codesandbox.io/s/perawallet-connect-vanillajs-demo-s5pjeo)
## Quick Start
Let's start with installing `@perawallet/connect`
```
npm install --save @perawallet/connect
```
```jsx
// Connect handler
peraWallet
.connect()
.then((newAccounts) => {
// Setup the disconnect event listener
peraWallet.connector?.on("disconnect", handleDisconnectWalletClick);
setAccountAddress(newAccounts[0]);
})
.reject((error) => {
// You MUST handle the reject because once the user closes the modal, peraWallet.connect() promise will be rejected.
// For the async/await syntax you MUST use try/catch
if (error?.data?.type !== "CONNECT_MODAL_CLOSED") {
// log the necessary errors
}
});
```
If you don't want the user's account information to be lost by the dApp when the user closes the browser with user’s wallet connected to the dApp, you need to handle the reconnect session status. You can do this in the following way.
```jsx
// On the every page refresh
peraWallet.reconnectSession().then((accounts) => {
// Setup the disconnect event listener
peraWallet.connector?.on("disconnect", handleDisconnectWalletClick);
if (accounts.length) {
setAccountAddress(accounts[0]);
}
});
```
After that you can sign transaction with this way
```jsx
// Single Transaction
try {
const signedTxn = await peraWallet.signTransaction([singleTxnGroups]);
} catch (error) {
console.log("Couldn't sign Opt-in txns", error);
}
```
## Options
| option | default | value | |
| ------------------------ | ------- | ------------------------------------- | -------- |
| `chainId` | `4160` | `416001`, `416002`, `416003` , `4160` | optional |
| `shouldShowSignTxnToast` | `true` | `boolean` | optional |
| `compactMode` | `false` | `boolean` | optional |
#### **`chainId`**
Determines which Algorand network your dApp uses.
**MainNet**: 416001
**TestNet**: 416002
**BetaNet**: 416003
**All Networks**: 4160
#### **`shouldShowSignTxnToast`**
It's enabled by default but in some cases, you may not need the toast message (e.g. you already have signing guidance for users). To disable it, use the `shouldShowSignTxnToast` option.
#### **`compactMode`**
It offers a compact UI optimized for smaller screens, with a minimum resolution of 400x400 pixels.
## Methods
#### `PeraWalletConnect.connect(): Promise`
Starts the initial connection flow and returns the array of account addresses.
#### `PeraWalletConnect.reconnectSession(): Promise`
Reconnects to the wallet if there is any active connection and returns the array of account addresses.
#### `PeraWalletConnect.disconnect(): Promise`
Disconnects from the wallet and resets the related storage items.
#### `PeraWalletConnect.platform: PeraWalletPlatformType`
Returns the platform of the active session. Possible responses: _`mobile | web | null`_
#### `PeraWalletConnect.isConnected: boolean`
Checks if there's any active session regardless of platform. Possible responses: _`true | false`_
#### `PeraWalletConnect.signTransaction(txGroups: SignerTransaction[][], signerAddress?: string): Promise`
Starts the sign process and returns the signed transaction in `Uint8Array`
#### `PeraWalletConnect.signData(data: PeraWalletArbitraryData[], signer: string): Promise`
Starts the signing process for arbitrary data signing and returns the signed data in `Uint8Array`. Uses `signBytes` method of `algosdk` behind the scenes. `signer` should be a valid Algorand address that exists in the user's wallet.
See example
```typescript
const signedData: Uint8Array[] = await peraWallet.signData([
{
data: new Uint8Array(Buffer.from(`timestamp//${Date.now()}`)),
message: "Timestamp confirmation"
},
{
data: new Uint8Array(Buffer.from(`agent//${navigator.userAgent}`)),
message: "User agent confirmation"
}
], "SAHBJDRHHRR72JHTWSXZR5VHQQUVC7S757TJZI656FWSDO3TZZWV3IGJV4");
```
## Customizing Style
You can override the z-index using the `.pera-wallet-modal` class so that the modal does not conflict with another component on your application.
```scss
.pera-wallet-modal {
// The default value of z-index is 10. You can lower and raise it as much as you want.
z-index: 11;
}
```
## Your app name on Pera Wallet
By default, the connect wallet drawer on Pera Wallet gets the app name from `document.title`.
In some cases, you may want to customize it. You can achieve this by adding a meta tag to your HTML between the `head` tag.
```html
```
## Contributing
All contributions are welcomed! To get more information about the details, please read the [contribution](./CONTRIBUTING.md) guide first.