> For the complete documentation index, see [llms.txt](https://andrei0x309.gitbook.io/farcaster-snapchain-utils/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://andrei0x309.gitbook.io/farcaster-snapchain-utils/readme.md).

# farcaster-snapchain-utils

This is a library that simplifies the interaction with a Farcaster snapchain node.

It can be used in read-only mode or in read/write mode.

If you use it in read/write mode, you will need to provide a private key and a FID.

If a node is not provided, the library will use the public MVR  node, but it is not guaranteed that this public node is functional. Many public nodes come and go, if you have an address, you can use that.\
\
If you alo run a public node and want that to be used by this library you can contact me.

You can also use it with Neynar, provided you pass the `NEYNAR_API_KEY` to the constructor or to `changeNode` method.

The library allows you to change the node or signer, so you don't need to create a new instance every time you want to change the node or signer.

### Jump right in

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>QuickStart</strong></td><td>View the basics</td><td></td><td></td><td><a href="/pages/CyH2xJQs9yWJ1S8BYNav">/pages/CyH2xJQs9yWJ1S8BYNav</a></td></tr><tr><td><strong>Write Methods</strong></td><td>View the write Methods</td><td></td><td></td><td><a href="/pages/KzRo9tdQhC2s3xDu7wPr">/pages/KzRo9tdQhC2s3xDu7wPr</a></td></tr><tr><td><strong>Read Methods</strong></td><td>View The read methods</td><td></td><td></td><td><a href="/pages/KzRo9tdQhC2s3xDu7wPr">/pages/KzRo9tdQhC2s3xDu7wPr</a></td></tr></tbody></table>


---

# 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://andrei0x309.gitbook.io/farcaster-snapchain-utils/readme.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.