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

Add resetAccount docs #707

Merged
merged 4 commits into from
Oct 2, 2024
Merged
Show file tree
Hide file tree
Changes from 2 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
26 changes: 26 additions & 0 deletions content/documentation/rpc/wallet/reset_account.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: wallet/resetAccount
description: RPC Wallet | Iron Fish Documentation
---

Resets an account's head to its createdAt block (or to the genesis block, if `resetCreatedAt` is true). If `resetScanningEnabled` is true, `scanningEnabled` will be set to true, otherwise `scanningEnabled` will be left at its current value.

Useful if your account is missing transactions or balances are incorrect. Setting `resetCreatedAt` to true will start from the genesis block rather than the account head, which will take longer, but will fix accounts with an incorrect `createdAt` block.

#### Request

```ts
{
account: string
resetCreatedAt?: boolean
resetScanningEnabled?: boolean
}
```

#### Response

```ts
undefined
```

###### [View on Github](https://github.com/iron-fish/ironfish/blob/master/ironfish/src/rpc/routes/wallet/resetAccount.ts)
2 changes: 1 addition & 1 deletion search/indexes/documentation-index.json

Large diffs are not rendered by default.