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

Guide for wallet account #1156

Merged
merged 2 commits into from
Jun 17, 2024
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
2 changes: 1 addition & 1 deletion www/docs/guides/L1message.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 13
sidebar_position: 14
---

# Messages with L1 network
Expand Down
2 changes: 1 addition & 1 deletion www/docs/guides/cairo_enum.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 16
sidebar_position: 17
---

# Cairo Enums
Expand Down
7 changes: 0 additions & 7 deletions www/docs/guides/cra.md

This file was deleted.

2 changes: 1 addition & 1 deletion www/docs/guides/define_call_message.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 9
sidebar_position: 10
---

# Data transformation
Expand Down
6 changes: 4 additions & 2 deletions www/docs/guides/estimate_fees.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 10
sidebar_position: 11
---

# Estimate fees
Expand Down Expand Up @@ -132,5 +132,7 @@ After the processing of the transaction, you can read the fee that has really be

```typescript
const txR = await provider.waitForTransaction(txH);
console.log('Fee paid =', txR.actual_fee);
if (txR.isSuccess()) {
console.log('Fee paid =', txR.actual_fee);
}
```
6 changes: 4 additions & 2 deletions www/docs/guides/events.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 12
sidebar_position: 13
---

# Events
Expand Down Expand Up @@ -59,7 +59,9 @@ const txReceipt = await provider.waitForTransaction(transactionHash);
You can recover all the events related to this transaction hash:

```typescript
const listEvents = txReceipt.events;
if (txReceipt.isSuccess()) {
const listEvents = txReceipt.events;
}
```

The result is an array of events (here only one event):
Expand Down
4 changes: 3 additions & 1 deletion www/docs/guides/interact.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,9 @@ const { transaction_hash: txH } = await account0.execute(myCall, {
},
});
const txR = await provider.waitForTransaction(txH);
console.log('Paid fee =', txR.actual_fee);
if (txR.isSuccess()) {
console.log('Paid fee =', txR.actual_fee);
}
```

Yes, it's much more complicated. Let's see in detail.
Expand Down
2 changes: 1 addition & 1 deletion www/docs/guides/multiCall.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 15
sidebar_position: 16
---

# Interact with more than one contract within one transaction
Expand Down
Binary file added www/docs/guides/pictures/SelectWallet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added www/docs/guides/pictures/addToken.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added www/docs/guides/pictures/executeTx.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added www/docs/guides/pictures/switchNetwork.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion www/docs/guides/signature.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 14
sidebar_position: 15
---

# Signature
Expand Down
2 changes: 1 addition & 1 deletion www/docs/guides/use_ERC20.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 11
sidebar_position: 12
---

# Work with ERC20 tokens
Expand Down
185 changes: 185 additions & 0 deletions www/docs/guides/walletAccount.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,185 @@
---
sidebar_position: 9
---

# WalletAccount

**Use wallets (like Braavos & ArgentX) to sign your transactions in your DAPP.**

The `WalletAccount` class is similar to the regular `Account` class, but is also able to ask a browser wallet to sign and send a transaction. Some other cool functionalities will be detailed hereunder.

The private key of a WalletAccount is held in a browser wallet (as ArgentX or Braavos), and any signature is managed by the wallet. You don't have to manage in your DAPP the security of any private key.

:::caution
This class is working only in the scope of a DAPP. You can't use it in a node.js script.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The intention is to be used in the browser environment, but technically you could build a node wallet service using SWO *wallet-api <-> some-service (whatever app) that could act as a bridge to a mobile wallet or some signing service and connect the node app to it.

:::

## Architecture

![](./pictures/WalletAccountArchitecture.png)

If you want to read Starknet, the WalletAccount will read directly the blockchain. That's why at the initialization of a WalletAccount, you need to put in the parameters a Provider instance. It will be used for all reading activities.
ivpavici marked this conversation as resolved.
Show resolved Hide resolved

If you want to write to Starknet, the WalletAccount will ask the browser Wallet to sign and send the transaction, using the Starknet Wallet API to communicate.
As several Wallets can be installed in your browser, the WalletAccount needs the ID of one of the available wallets. You can ask `get-starknet` to display a list of available wallets and to provide as a response the identifier of the selected wallet, called a `Starknet Windows Object` (named SWO from now).

## Select a Wallet

You can ask the `get-starknet` v4 library to display a list of wallets, then it will ask you to make a choice. It will return the SWO of the wallet the user selected.
Using the `get-starknet-core` v4 library, you can create your own UI and logic to select the wallet. An example of DAPP using a custom UI : [**here**](https://github.com/PhilippeR26/Starknet-WalletAccount/blob/main/src/app/components/client/WalletHandle/SelectWallet.tsx), where you can select only the wallets compatible with the Starknet wallet API.
![](./pictures/SelectWallet.png)

So, you instantiate a new WalletAccount with :

```typescript
import { connect } from 'get-starknet'; // v4.0.0 min
import { WalletAccount } from 'starknet'; // v6.10.0 min
const myFrontendProviderUrl = 'https://free-rpc.nethermind.io/sepolia-juno/v0_7';
// standard UI to select a wallet :
const selectedWalletSWO = await connect({ modalMode: 'alwaysAsk', modalTheme: 'light' });
const myWalletAccount = new WalletAccount({ nodeUrl: myFrontendProviderUrl }, selectedWalletSWO);
```

## Use as an account

Once the new WalletAccount is created, you can use all the power of Starknet.js, exactly as a with a normal Account instance.
You can use for example `myWalletAccount.execute(call)` or `myWalletAccount.signMessage(typedMessage)` :

```typescript
const claimCall = airdropContract.populate('claim_airdrop', {
amount: amount,
proof: proof,
});
const resp = await myWalletAccount.execute(claimCall);
```

![](./pictures/executeTx.png)

## Use in a Contract instance

You can connect a WalletAccount with a Contract instance. All reading actions are performed by the provider of the WalletAccount, and all writing actions (that needs a signature) are performed by the browser wallet.

```typescript
const lendContract = new Contract(contract.abi, contractAddress, myWalletAccount);
const qty = await lendContract.get_available_asset(addr); // use of the WalletAccount provider.
const resp = await lendContract.process_lend_asset(addr); // use of the browser wallet
```

## Use as a provider

Your WalletAccount instance can be used as a provider :

```typescript
const bl = await myWalletAccount.getBlockNumber();
// bl = 2374543
```

You can use all the methods of the RpcProvider class. Under the hood, the WalletAccount will use the rpc node that you indicated at its instantiation.

## Subscription to events

You can subscribe to 2 events :

- `accountsChanged` : Triggered each time you change the current account in the wallet.
- `networkChanged` : Triggered each time you change the current network in the wallet.

At each change of the network, both account and network events are occurring.
At each change of the account, only the account event is occurring.

### Subscribe

#### accountsChanged

```typescript
const handleAccount: AccountChangeEventHandler = (accounts: string[] | undefined) => {
if (accounts?.length) {
const textAddr = accounts[0]; // hex string
setChangedAccount(textAddr); // from a React useState
}
};
selectedWalletSWO.on('accountsChanged', handleAccount);
```

#### networkChanged

```typescript
const handleNetwork: NetworkChangeEventHandler = (chainId?: string, accounts?: string[]) => {
if (!!chainId) {
setChangedNetwork(chainId);
} // from a React useState
};
selectedWalletSWO.on('networkChanged', handleNetwork);
```

### Un-subscribe :

Similar to subscription, using `.off` method.

```typescript
selectedWalletSWO.off('accountsChanged', handleAccount);
selectedWalletSWO.off('networkChanged', handleNetwork);
```

:::info
You can subscribe both with the SWO or with a WalletAccount instance.
The above examples are using the SWO, because it's the simpler way to process.
:::

## Direct access to the wallet API entry points

The WalletAccount class is able to interact with all the entrypoints of the Starknet wallet API, including some functionalities that do not exists in an Account class.
You have a full description of this API [**here**](https://github.com/PhilippeR26/Starknet-WalletAccount/blob/main/doc/walletAPIspec.md).

Some examples:

### Request a change of wallet network

Using your WalletAccount, you can ask the wallet to change its current network:

```typescript
useEffect(
() => {
if (!isValidNetwork()) {
const tryChangeNetwork = async () => {
await myWalletAccount.switchStarknetChain(constants.StarknetChainId.SN_SEPOLIA);
};
tryChangeNetwork().catch(console.error);
}
},
[chainId] // from a networkChanged event
);
```

![](./pictures/switchNetwork.png)

### Request to display a token in the wallet

Using your WalletAccount, you can ask the wallet to display a new token:

```typescript
useEffect(
() => {
const fetchAddToken = async () => {
const resp = await myWalletAccount.watchAsset({
type: 'ERC20',
options: {
address: erc20Address,
},
});
};
if (isAirdropSuccess) {
fetchAddToken().catch(console.error);
}
},
[isAirdropSuccess] // from a React useState
);
```

![](./pictures/addToken.png)

## Change of network or account

When you change the network or the account address, the WalletAccount is automatically updated, but it can lead to tricky behavior (read and write in different networks, problems of Cairo versions of the accounts, ....).
:::warning RECOMMENDATION
It's strongly recommended to create a new WalletAccount instance each time the network or the account address is changed.
:::