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

Ethereum wallets selector. #1106

Merged
merged 47 commits into from
Jul 25, 2024
Merged
Show file tree
Hide file tree
Changes from 42 commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
2c61d49
feat: Ethereum wallets mvp.
paouvrard Apr 24, 2024
8461c0b
feat: Relayer onboarding.
paouvrard May 3, 2024
0c468be
fix: Use near_getPublicKey api.
paouvrard May 8, 2024
8391e5b
feat: Get receipt and txStatus.
paouvrard May 14, 2024
16b5927
fix: Remove RLP_EXECUTE check.
paouvrard May 15, 2024
cee568b
fix: Handling of network switch from wallet.
paouvrard May 15, 2024
28b2468
style: Update logo.
paouvrard May 15, 2024
9a0a901
fix: Re-apply rlp_execute limitation to relayer key.
paouvrard May 15, 2024
fc18d7c
build: Upgrade web3Modal, add WC example.
paouvrard May 16, 2024
6c137e1
feat: Query estimateGas (also fixes MetaMask mobile).
paouvrard May 20, 2024
07705d4
fix: Improve modal text.
paouvrard May 21, 2024
27540ee
style: Modal lint.
paouvrard May 21, 2024
7a6c373
fix: Improve onboarding text.
paouvrard May 22, 2024
d26fbb0
feat: Parse error from NEAR transaction.
paouvrard May 23, 2024
d2a0f3e
build: Update assets ethereum-wallets-icon.png.
paouvrard May 27, 2024
73aff7a
feat: Network not supported error message.
paouvrard May 27, 2024
a52e7e2
feat: Optional wagmiCore param and dynamic import.
paouvrard May 27, 2024
396fab0
fix: Dynamic import on page reload.
paouvrard May 28, 2024
ec044bb
Add modal styling (#5)
santerisarle May 29, 2024
4deef6f
refactor: Remove rpcUrl param, get explorer url from wagmiConfig.
paouvrard May 29, 2024
ccb803d
chore: Improve docs.
paouvrard May 29, 2024
34608cd
build: Fix lint.
paouvrard May 29, 2024
ab88d31
More design (#6)
santerisarle May 31, 2024
f141026
style: Tweak text.
paouvrard May 31, 2024
72abcca
fix: Custom chainId.
paouvrard Jun 5, 2024
ab2bed4
style: Hide yocto deposit.
paouvrard Jun 5, 2024
5e8a9af
fix: Improve NEAR tx error parsing.
paouvrard Jun 13, 2024
e2e738b
feat: Add alwaysOnboardDuringSignIn option.
paouvrard Jun 20, 2024
104bec4
fix: Improve error handling during signIn.
paouvrard Jun 21, 2024
35841f8
feat: Log in with Ethereum flow.
paouvrard Jun 24, 2024
1fea570
fix: Check isConnecting state.
paouvrard Jun 24, 2024
447254b
docs: Log in with Ethereum flow.
paouvrard Jun 24, 2024
fb701d0
feat: Web3Modal is optional, default to injected wallet.
paouvrard Jun 25, 2024
9a984a1
fix: Wait for missing txStatus and receipt.
paouvrard Jun 26, 2024
bc9203a
fix: Handle alternative error message.
paouvrard Jun 26, 2024
34d0f82
fix: Tweak log in with Ethereum flow.
paouvrard Jun 26, 2024
a727916
fix: Disconnect wallet when switch to account without LAK.
paouvrard Jun 26, 2024
8c93268
fix: Use wagmi.simulateContract.
paouvrard Jun 28, 2024
35e85a1
feat: Confirm action and allow retry. (#11)
paouvrard Jul 1, 2024
a40b498
fix: Hide Web3Modal after signIn.
paouvrard Jul 1, 2024
d8e4619
chore: Rename.
paouvrard Jul 1, 2024
3348741
feat: 1wei free onboarding.
paouvrard Jul 10, 2024
d1967c1
Merge branch 'dev' into ethereum-wallets
paouvrard Jul 16, 2024
71533ff
build: Upgrade Ethereum dependencies.
paouvrard Jul 16, 2024
4574982
Merge branch 'dev' into ethereum-wallets
paouvrard Jul 25, 2024
2221a62
build: Fix Angular.
paouvrard Jul 25, 2024
6a4757d
feat: Chain switch modal. (#13)
paouvrard Jul 25, 2024
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
3 changes: 1 addition & 2 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
"eslint.format.enable": true,
"prettier.enable": false,
"editor.codeActionsOnSave": {
"source.fixAll.eslint":
true
"source.fixAll.eslint": "explicit"
},
"typescript.tsdk": "node_modules/typescript/lib"
}
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ NEAR Wallet Selector makes it easy for users to interact with your dApp by provi
- [NearFi Wallet](https://www.npmjs.com/package/@near-wallet-selector/nearfi) - Mobile wallet.
- [Near Mobile Wallet](https://www.npmjs.com/package/@near-wallet-selector/near-mobile-wallet) - Mobile Wallet.
- [WalletConnect](https://www.npmjs.com/package/@near-wallet-selector/wallet-connect) - Bridge wallet.
- [Ethereum wallets](https://www.npmjs.com/package/@near-wallet-selector/ethereum-wallets) - Injected wallet.

## Preview

Expand Down Expand Up @@ -72,6 +73,7 @@ yarn add \
@near-wallet-selector/ramper-wallet \
@near-wallet-selector/near-mobile-wallet \
@near-wallet-selector/mintbase-wallet
@near-wallet-selector/ethereum-wallets

# Using NPM.
npm install \
Expand All @@ -94,6 +96,7 @@ npm install \
@near-wallet-selector/ramper-wallet \
@near-wallet-selector/near-mobile-wallet \
@near-wallet-selector/mintbase-wallet
@near-wallet-selector/ethereum-wallets
```

Optionally, you can install our [`modal-ui`](https://www.npmjs.com/package/@near-wallet-selector/modal-ui) or [`modal-ui-js`](https://www.npmjs.com/package/@near-wallet-selector/modal-ui-js) package for a pre-built interface that wraps the `core` API and presents the supported wallets:
Expand Down Expand Up @@ -131,6 +134,7 @@ import { setupXDEFI } from "@near-wallet-selector/xdefi";
import { setupRamperWallet } from "@near-wallet-selector/ramper-wallet";
import { setupNearMobileWallet } from "@near-wallet-selector/near-mobile-wallet";
import { setupMintbaseWallet } from "@near-wallet-selector/mintbase-wallet";
import { setupEthereumWallets } from "@near-wallet-selector/ethereum-wallets";

const selector = await setupWalletSelector({
network: "testnet",
Expand Down Expand Up @@ -166,6 +170,7 @@ const selector = await setupWalletSelector({
callbackUrl: "https://www.mywebsite.com",
deprecated: false,
}),
setupEthereumWallets({ wagmiConfig, web3Modal }),
],
});

Expand Down
5 changes: 5 additions & 0 deletions examples/angular/project.json
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,11 @@
"glob": "**/*",
"input": "packages/near-mobile-wallet/assets/",
"output": "assets/"
},
{
"glob": "**/*",
"input": "packages/ethereum-wallets/assets/",
"output": "assets/"
}
],
"styles": ["examples/angular/src/styles.scss"],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,11 @@ import { setupRamperWallet } from "@near-wallet-selector/ramper-wallet";
import { setupLedger } from "@near-wallet-selector/ledger";
import { setupNearMobileWallet } from "@near-wallet-selector/near-mobile-wallet";
import { setupMintbaseWallet } from "@near-wallet-selector/mintbase-wallet";
import { setupEthereumWallets } from "@near-wallet-selector/ethereum-wallets";
import { createWeb3Modal } from "@web3modal/wagmi";
import { reconnect, http, createConfig, type Config } from "@wagmi/core";
import { type Chain } from "@wagmi/core/chains";
import { injected, walletConnect } from "@wagmi/connectors";
import { CONTRACT_ID } from "../../../constants";

declare global {
Expand All @@ -32,6 +37,61 @@ declare global {
}
}

// Get a project ID at https://cloud.walletconnect.com
const projectId = "30147604c5f01d0bc4482ab0665b5697";

// NOTE: This is the NEAR wallet playground used in dev mode.
// TODO: Replace with the NEAR chain after the protocol upgrade.
const near: Chain = {
id: 398,
name: "NEAR wallet playground",
nativeCurrency: {
decimals: 18,
name: "NEAR",
symbol: "NEAR",
},
rpcUrls: {
default: { http: ["https://near-wallet-relayer.testnet.aurora.dev"] },
public: { http: ["https://near-wallet-relayer.testnet.aurora.dev"] },
},
blockExplorers: {
default: {
name: "NEAR Explorer",
url: "https://testnet.nearblocks.io",
},
},
testnet: true,
};

const wagmiConfig: Config = createConfig({
chains: [near],
transports: {
[near.id]: http(),
},
connectors: [
walletConnect({
projectId,
metadata: {
name: "NEAR Guest Book",
description: "A guest book with comments stored on the NEAR blockchain",
url: "https://near.github.io/wallet-selector",
icons: ["https://near.github.io/wallet-selector/favicon.ico"],
},
showQrModal: false,
}),
injected({ shimDisconnect: true }),
],
});
reconnect(wagmiConfig);

const web3Modal = createWeb3Modal({
wagmiConfig: wagmiConfig,
projectId,
featuredWalletIds: [
"ecc4036f814562b41a5268adc86270fba1365471402006302e70169465b7ac18", // Zerion
],
});
Patrick1904 marked this conversation as resolved.
Show resolved Hide resolved

@Component({
selector: "near-wallet-selector-wallet-selector",
templateUrl: "./wallet-selector.component.html",
Expand Down Expand Up @@ -93,6 +153,7 @@ export class WalletSelectorComponent implements OnInit {
setupRamperWallet(),
setupNearMobileWallet(),
setupMintbaseWallet({ contractId: "guest-book.testnet" }),
setupEthereumWallets({ wagmiConfig, web3Modal, devMode: true }),
],
});

Expand Down
12 changes: 11 additions & 1 deletion examples/react/components/Content.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ const Content: React.FC = () => {
],
})
.catch((err) => {
alert("Failed to add message");
alert("Failed to add message " + err);
console.log("Failed to add message");

throw err;
Expand Down Expand Up @@ -379,6 +379,10 @@ const Content: React.FC = () => {
<div>
<button onClick={handleSignIn}>Log in</button>
</div>
<div style={{ marginTop: 30 }}>
{/* @ts-ignore */}
<w3m-button label="Log in with Ethereum" />
</div>
<SignIn />
</Fragment>
);
Expand All @@ -395,6 +399,12 @@ const Content: React.FC = () => {
<button onClick={handleSwitchAccount}>Switch Account</button>
)}
</div>
{selector.store.getState().selectedWalletId === "ethereum-wallets" && (
<div style={{ marginTop: 30 }}>
{/* @ts-ignore */}
<w3m-button label="Log in with Ethereum" />
</div>
)}
<Form
account={account}
onSubmit={(e) => handleSubmit(e as unknown as Submitted)}
Expand Down
93 changes: 92 additions & 1 deletion examples/react/contexts/WalletSelectorContext.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { setupCoin98Wallet } from "@near-wallet-selector/coin98-wallet";
import type { AccountState, WalletSelector } from "@near-wallet-selector/core";
import type {
AccountState,
InjectedWalletBehaviour,
WalletSelector,
} from "@near-wallet-selector/core";
import { setupWalletSelector } from "@near-wallet-selector/core";
import { setupHereWallet } from "@near-wallet-selector/here-wallet";
import { setupMathWallet } from "@near-wallet-selector/math-wallet";
Expand All @@ -21,6 +25,7 @@ import { setupXDEFI } from "@near-wallet-selector/xdefi";
import { setupRamperWallet } from "@near-wallet-selector/ramper-wallet";
import { setupNearMobileWallet } from "@near-wallet-selector/near-mobile-wallet";
import { setupMintbaseWallet } from "@near-wallet-selector/mintbase-wallet";
import { setupEthereumWallets } from "@near-wallet-selector/ethereum-wallets";

import type { ReactNode } from "react";
import React, {
Expand All @@ -31,6 +36,17 @@ import React, {
useMemo,
} from "react";
import { distinctUntilChanged, map } from "rxjs";
import { createWeb3Modal } from "@web3modal/wagmi";
import type { GetAccountReturnType } from "@wagmi/core";
import {
reconnect,
http,
createConfig,
type Config,
watchAccount,
} from "@wagmi/core";
import { type Chain } from "@wagmi/core/chains";
import { injected, walletConnect } from "@wagmi/connectors";

import { Loading } from "../components/Loading";
import { CONTRACT_ID } from "../constants";
Expand All @@ -52,6 +68,61 @@ interface WalletSelectorContextValue {
const WalletSelectorContext =
React.createContext<WalletSelectorContextValue | null>(null);

// Get a project ID at https://cloud.walletconnect.com
const projectId = "30147604c5f01d0bc4482ab0665b5697";

// NOTE: This is the NEAR wallet playground used in dev mode.
// TODO: Replace with the NEAR chain after the protocol upgrade.
const near: Chain = {
id: 398,
name: "NEAR wallet playground",
nativeCurrency: {
decimals: 18,
name: "NEAR",
symbol: "NEAR",
},
rpcUrls: {
default: { http: ["https://near-wallet-relayer.testnet.aurora.dev"] },
public: { http: ["https://near-wallet-relayer.testnet.aurora.dev"] },
},
blockExplorers: {
default: {
name: "NEAR Explorer",
url: "https://testnet.nearblocks.io",
},
},
testnet: true,
};

const wagmiConfig: Config = createConfig({
chains: [near],
transports: {
[near.id]: http(),
},
connectors: [
walletConnect({
projectId,
metadata: {
name: "NEAR Guest Book",
description: "A guest book with comments stored on the NEAR blockchain",
url: "https://near.github.io/wallet-selector",
icons: ["https://near.github.io/wallet-selector/favicon.ico"],
},
showQrModal: false,
}),
injected({ shimDisconnect: true }),
],
});
reconnect(wagmiConfig);

const web3Modal = createWeb3Modal({
wagmiConfig: wagmiConfig,
projectId,
featuredWalletIds: [
"ecc4036f814562b41a5268adc86270fba1365471402006302e70169465b7ac18", // Zerion
],
});

export const WalletSelectorContextProvider: React.FC<{
children: ReactNode;
}> = ({ children }) => {
Expand All @@ -60,6 +131,25 @@ export const WalletSelectorContextProvider: React.FC<{
const [accounts, setAccounts] = useState<Array<AccountState>>([]);
const [loading, setLoading] = useState<boolean>(true);

// Log in with Ethereum flow: auto connect to ethereum-wallets without showing the NEAR modal.
useEffect(() => {
if (!selector) {
return;
}
watchAccount(wagmiConfig, {
onChange: (data: GetAccountReturnType) => {
if (!data.address || selector.store.getState().selectedWalletId) {
return;
}
selector.wallet("ethereum-wallets").then((wallet) =>
(wallet as InjectedWalletBehaviour).signIn({
contractId: CONTRACT_ID,
})
);
},
});
}, [selector]);

const init = useCallback(async () => {
const _selector = await setupWalletSelector({
network: "testnet",
Expand Down Expand Up @@ -95,6 +185,7 @@ export const WalletSelectorContextProvider: React.FC<{
}),
setupNearMobileWallet(),
setupMintbaseWallet({ contractId: "guest-book.testnet" }),
setupEthereumWallets({ wagmiConfig, web3Modal, devMode: true }),
],
});
const _modal = setupModal(_selector, {
Expand Down
5 changes: 5 additions & 0 deletions examples/react/project.json
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,11 @@
"glob": "**/*",
"input": "packages/near-mobile-wallet/assets/",
"output": "assets/"
},
{
"glob": "**/*",
"input": "packages/ethereum-wallets/assets/",
"output": "assets/"
}
]
},
Expand Down
Loading
Loading