Skip to content

Update meshwallet.mdx #42

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update meshwallet.mdx #42

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 12 additions & 12 deletions apps/docs/content/docs/apis/wallets/meshwallet.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ You can initialize Mesh Wallet with:
- Cardano CLI Generated Keys
- Address (Read Only Wallet)

First, we initialize a Provider, which we will assign provider to the `fetcher` and `submitter`.
First, we initialize a new Provider.

<Tabs items={["Maestro", "Blockfrost", "Koios", "UTxORPC"]}>
<Tab value="Maestro">
Expand Down Expand Up @@ -64,9 +64,9 @@ First, we initialize a Provider, which we will assign provider to the `fetcher`
</Tabs>


### Menmonice Phrases
### Mnemonic Phrases

We can load wallet with menmonice phrases:
We can load a wallet with mnemonic phrases, and assign our provider to the `fetcher` and `submitter`:

```tsx
import { MeshWallet } from '@meshsdk/core';
Expand All @@ -91,7 +91,7 @@ const address = wallet.getChangeAddress();

### Private Keys

We can load wallet with private keys:
We can load a wallet with private keys:

```tsx
import { MeshWallet } from '@meshsdk/core';
Expand All @@ -110,7 +110,7 @@ const wallet = new MeshWallet({

### Cardano CLI generated skeys

We can load wallet with CLI generated keys by providing the `skey` generated by Cardano CLI. There are two files generated by Cardano CLI, by default it is named `signing.skey` and `stake.skey`. Opening the `signing.skey` file it should contains:
We can load a wallet with CLI-generated keys by providing the `skey` generated by Cardano CLI. There are two files generated by Cardano CLI, by default, it is named `signing.skey` and `stake.skey`. Opening the `signing.skey` file should show:

```tsx
{
Expand Down Expand Up @@ -140,7 +140,7 @@ const wallet = new MeshWallet({

### Address

We can load wallet with address, this is useful for read-only wallets. A read-only wallet can only query the blockchain, it cannot sign transactions. This is useful for monitoring wallets. We can load wallet with the `address` type:
We can load a wallet with address, this is useful for read-only wallets. A read-only wallet can only query the blockchain, it cannot sign transactions. This is useful for monitoring wallets. We can load wallet with the `address` type:

```tsx
import { MeshWallet } from '@meshsdk/core';
Expand All @@ -164,7 +164,7 @@ After creating the wallet, we need to initialize it. This will initialize the cr
await wallet.init()
```

With the `wallet` loaded, you can sign transactions, we will see how to do this in the next section, for now lets get the wallet's address:
With the `wallet` loaded, you can sign transactions, we will see how to do this in the [Sign Transaction](https://meshjs.dev/apis/wallets/meshwallet#sign-transaction) section, for now lets get the wallet's address:

```tsx
const address = wallet.getChangeAddress();
Expand Down Expand Up @@ -226,7 +226,7 @@ Example response:

## Get Change Address

This API returns an address owned by the wallet that should be used as a change address. A change address is essential during transaction creation to ensure leftover assets are securely returned to the connected wallet.
This API returns an address owned by the wallet which is essential during transaction creation to ensure leftover assets are securely returned to the connected wallet.

The change address helps maintain the integrity of transactions by preventing asset loss and ensuring proper allocation of funds.

Expand Down Expand Up @@ -440,7 +440,7 @@ This functionality is essential for applications that require secure and verifia
```
</Card>

Continue reading this guide to learn how to verify the signature.
Check out [this guide](https://meshjs.dev/guides/prove-wallet-ownership#server-verify-signature) to learn how to verify the signature.

Example response:
```tsx
Expand All @@ -463,7 +463,7 @@ This functionality is vital for applications that need to interact with the bloc

Create a transaction and sign it

Check out **Transaction** to learn more on how to use this API.
Check out [MeshWallet](https://docs.meshjs.dev/wallets/classes/MeshWallet#signTx) documentation to learn more on how to use this API.

```tsx
const signedTx = await wallet.signTx(tx, partialSign?);
Expand All @@ -484,7 +484,7 @@ This functionality is essential for applications that rely on wallet integration

Submit a signed transaction with wallet

Check out **Transaction** to learn more on how to use this API.
Check out [MeshWallet](https://docs.meshjs.dev/wallets/classes/MeshWallet#submitTx) documentation to learn more on how to use this API.

```tsx
const txHash = await wallet.submitTx(signedTx);
Expand Down Expand Up @@ -631,4 +631,4 @@ Example response:
"publicKeyHash": "9f7f4b78...df83bd227e943e9808450",
"dRepIDCip105": "drep1vz0h7jmc...0axqgg5q4dls5u"
}
```
```