> For the complete documentation index, see [llms.txt](https://doc.brink.money/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.brink.money/vault/technical-overview/usage-notes.md).

# Usage notes

#### Full Deposit Process (Ethers.js)

```javascript
import { ethers } from "ethers";
import brinkVaultAbi from "./BrinkVault.json";

const brinkVault = new ethers.Contract(brinkVaultAddress, brinkVaultAbi, signer);
const asset = new ethers.Contract(assetAddress, erc20Abi, signer);

const amount = ethers.parseUnits("100", 18);

// Step 1: Approve
await asset.approve(brinkVaultAddress, amount);

// Step 2: Deposit
const tx = await brinkVault.deposit(amount, await signer.getAddress());
await tx.wait();

// Step 3: Check balance
const shares = await brinkVault.balanceOf(await signer.getAddress());
console.log("Vault shares:", shares.toString());
```

#### Withdraw Tokens

```javascript
const withdrawTx = await brinkVault.withdraw(amount, await signer.getAddress(), await signer.getAddress());
await withdrawTx.wait();
```

#### View Vault State

```javascript
const data = await brinkVault.getBrinkVaultData();
console.log("Strategies:", data);
```

#### Summary

The BrinkVault contract provides a user-friendly ERC-4626 vault interface for depositing, earning, and withdrawing ERC20 tokens.\
As an investor:

* Approve → Deposit → Earn → Withdraw
* Monitor your balance and vault performance using read-only functions.\
  Administrative operations (e.g., rebalancing, whitelist management) are handled by vault managers and strategists.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://doc.brink.money/vault/technical-overview/usage-notes.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.