Skip to content

intro.md

Latest commit

 

History

History
75 lines (49 loc) · 2.9 KB

intro.md

File metadata and controls

75 lines (49 loc) · 2.9 KB
description Introducing the Wander Injected API

Intro

The Wander API is a JavaScript object, injected into each browser tab. To interact with it, you simply need to call one of the functions in the window.arweaveWallet object.

Basic usage

To use Wander in your application, you don't need to integrate or learn how the Wander Injected API works. Using arweave-js, you can easily sign a transaction through Wander in the background:

// 1. Connect your app to the wallet:
await arweaveWallet.connect([...]);

// 2. Create Arweave transaction:
const tx = await arweave.createTransaction({ ... });

// 3. Sign transaction:
await arweave.transactions.sign(tx);

// 4. TODO: Handle (e.g. post) signed transaction...

When signing a transaction through arweave-js, you'll need to omit the second argument of the sign() function, or set it to "use_wallet". This will let the package know to use the extension in the background to sign the transaction.

Once the transaction is signed, you can safely post it to the network.

Advanced usage

The Wander Injected API provides extra functionalities in case you wish to utilize the user's wallet to its full extent securely. These features are not integrated in the arweave-js package, but can be useful to further customize your app. The above mentioned window.arweaveWallet object holds the api functions necessary for this.

Each function is described in detail in the following pages.

{% hint style="danger" %} Please remember: to interact with the API, make sure that the arweaveWalletLoaded event has already been fired. Read more about that here. {% endhint %}

TypeScript types

To support Wander types for window.arweaveWallet, you can install the npm package arconnect, like this:

{% hint style="info" %} Wander was formerly know as ArConnect. There are some API references that still use ArConnect {% endhint %}

npm i -D arconnect

or

yarn add -D arconnect

To add the types to your project, you should either include the package in your tsconfig.json, or add the following to your env.d.ts file:

/// <reference types="arconnect" />

Additional Injected API fields

The Wander Injected API provides some additional information about the extension. You can retrieve the wallet version (window.arweaveWallet.walletVersion) and you can even verify that the currently used wallet API indeed belongs to Wander using the wallet name (window.arweaveWallet.walletName).

addEventListener("arweaveWalletLoaded", () => {
  console.log(`You are using the ${window.arweaveWallet.walletName} wallet.`);
  console.log(`Wallet version is ${window.arweaveWallet.walletVersion}`);
});