Go to file

Pigges b060572ec5 fix no arguments for both cli and direct		2023-10-09 21:08:48 +02:00
src	fix no arguments for both cli and direct	2023-10-09 21:08:48 +02:00
.gitignore	init	2023-10-09 20:54:19 +02:00
bun.lockb	init	2023-10-09 20:54:19 +02:00
jsconfig.json	init	2023-10-09 20:54:19 +02:00
LICENSE	init	2023-10-09 20:54:19 +02:00
package.json	init	2023-10-09 20:54:19 +02:00
README.md	updated README.md	2023-10-09 20:56:53 +02:00

README.md

Simple SPV Client

A simple SPV client that aims for easy integration primarily with LBRY Hub servers.

The client isn't perfect. It can and will break if your input isn't correct.

To see what methods that the SPV will answer on, check this website. This client doesn't try to decode the data recieved, rather it gives you the raw JSONRPC that the SPV replied with.

The claimtrie methods specific to LBRY will return a Base64 encoded protobuf as the result. You'll need to decode the result according to the LBRY types.

Good Resources

Usage

Get started:

You need to have Bun installed

git clone https://github.com/pigges/simple-spv-client.git
cd simple-spv-client
bun install
bun start

The startup looks like this:

|-------------------|
| Simple SPV Client |
|-------------------|

Which SPV server should be used?
1. Default (a-hub1.odysee.com:50001)
2. Custom
Answer:

You can also choose to use arguments to directly get a response:

bun start --server "server" command {your command}

Build

You can build the project to get an executable:

This will give you a file named a.out

bun run build

License

This project is MIT licensed. For the full license, see LICENSE.