Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add option to get amino offline signer #88

Merged
merged 4 commits into from
Oct 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/stupid-lizards-applaud.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@sei-js/core': patch
'@sei-js/react': patch
---

Add `getOfflineSignerAmino` to wallet interfaces
7 changes: 6 additions & 1 deletion packages/core/src/lib/wallet/config.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { ChainConfig, ChainInfo, Currency } from './types';
import { AccountData, OfflineSigner } from '@cosmjs/proto-signing';
import { StdSignature } from '@cosmjs/amino';
import { OfflineAminoSigner, StdSignature } from '@cosmjs/amino';

export interface SeiWallet {
walletInfo: {
Expand All @@ -10,6 +10,7 @@ export interface SeiWallet {
website: string;
};
getOfflineSigner: (chainId: string) => Promise<OfflineSigner | undefined>;
getOfflineSignerAmino: (chainId: string) => Promise<OfflineAminoSigner | undefined>;
getAccounts: (chainId: string) => Promise<readonly AccountData[]>;
connect: (chainId: string) => Promise<void>;
disconnect: (chainId: string) => Promise<void>;
Expand All @@ -27,6 +28,7 @@ export const FIN_WALLET: SeiWallet = {
connect: async (chainId) => await window?.['fin']?.enable(chainId),
disconnect: async (chainId) => await window?.['fin']?.disable(chainId),
getOfflineSigner: async (chainId) => window?.['fin']?.getOfflineSignerAuto(chainId),
getOfflineSignerAmino: async (chainId) => window?.['fin']?.getOfflineSignerOnlyAmino(chainId),
signArbitrary: async (chainId, signer, message) => window?.['fin']?.signArbitrary(chainId, signer, message),
verifyArbitrary: async (chainId, signingAddress, data, signature) => window?.['fin']?.verifyArbitrary(chainId, signingAddress, data, signature),
walletInfo: {
Expand All @@ -46,6 +48,7 @@ export const COMPASS_WALLET: SeiWallet = {
connect: async (chainId) => await window?.['compass']?.enable(chainId),
disconnect: async (chainId) => await window?.['compass']?.disable(chainId),
getOfflineSigner: async (chainId) => window?.['compass']?.getOfflineSignerAuto(chainId),
getOfflineSignerAmino: async (chainId) => window?.['compass']?.getOfflineSignerOnlyAmino(chainId),
signArbitrary: async (chainId, signer, message) => window?.['compass']?.signArbitrary(chainId, signer, message),
verifyArbitrary: async (chainId, signingAddress, data, signature) => window?.['compass']?.verifyArbitrary(chainId, signingAddress, data, signature),
walletInfo: {
Expand All @@ -65,6 +68,7 @@ export const KEPLR_WALLET: SeiWallet = {
connect: async (chainId) => await window?.['keplr']?.enable(chainId),
disconnect: async (chainId) => await window?.['keplr']?.disable(chainId),
getOfflineSigner: async (chainId) => window?.['keplr']?.getOfflineSignerAuto(chainId),
getOfflineSignerAmino: async (chainId) => window?.['keplr']?.getOfflineSignerOnlyAmino(chainId),
signArbitrary: async (chainId, signer, message) => window?.['keplr']?.signArbitrary(chainId, signer, message),
verifyArbitrary: async (chainId, signingAddress, data, signature) => window?.['keplr']?.verifyArbitrary(chainId, signingAddress, data, signature),
suggestChain: async (config) => window?.['keplr']?.experimentalSuggestChain(config),
Expand All @@ -85,6 +89,7 @@ export const LEAP_WALLET: SeiWallet = {
connect: async (chainId) => await window?.['leap']?.enable(chainId),
disconnect: async (chainId) => await window?.['leap']?.disable(chainId),
getOfflineSigner: async (chainId) => window?.['leap']?.getOfflineSignerAuto(chainId),
getOfflineSignerAmino: async (chainId) => window?.['leap']?.getOfflineSignerOnlyAmino(chainId),
signArbitrary: async (chainId, signer, message) => window?.['leap']?.signArbitrary(chainId, signer, message),
verifyArbitrary: async (chainId, signingAddress, data, signature) => window?.['leap']?.verifyArbitrary(chainId, signingAddress, data, signature),
suggestChain: async (config) => window?.['leap']?.experimentalSuggestChain(config),
Expand Down
28 changes: 28 additions & 0 deletions packages/react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,34 @@ The first step is to wrap your entire application in a Sei wallet provider and p
</SeiWalletProvider>
```

### Unofficial wallet providers
To connect to an unofficial wallet provider such as Keplr, simply define an object of type `SeiWallet` and use it anywhere in this package.

```typescript
const CUSTOM_WALLET: SeiWallet = {
getAccounts: async (chainId) => {
const offlineSigner = await window?.['keplr']?.getOfflineSignerAuto(chainId);
return offlineSigner?.getAccounts() || [];
},
connect: async (chainId) => await window?.['keplr']?.enable(chainId),
disconnect: async (chainId) => await window?.['keplr']?.disable(chainId),
getOfflineSigner: async (chainId) => window?.['keplr']?.getOfflineSignerAuto(chainId),
getOfflineSignerAmino: async (chainId) => window?.['keplr']?.getOfflineSignerAmino(chainId),
signArbitrary: async (chainId, signer, message) => window?.['keplr']?.signArbitrary(chainId, signer, message),
verifyArbitrary: async (chainId, signingAddress, data, signature) => window?.['keplr']?.verifyArbitrary(chainId, signingAddress, data, signature),
walletInfo: {
windowKey: 'keplr',
name: 'Keplr',
website: 'https://www.keplr.app/download',
icon: 'https://assets.website-files.com/63eb7ddf41cf5b1c8fdfbc74/63edd5d1a40b9a48841ac1d2_Keplr%20Logo.svg'
},
isMobileSupported: false
};

// Then pass this into <SeiWalletProvider /> if using React, or use it's functions if using node or another js library
<SeiWalletProvider wallets={['fin', 'compass', CUSTOM_WALLET]} autoconnect={CUSTOM_WALLET} />
```

# Hooks

| Hook | Params |
Expand Down