Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jowparks authored Apr 5, 2024
1 parent aaff41b commit f87f397
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# `ironfish-wallet-server`
![wallet-server](https://github.com/iron-fish/wallet-server/assets/26990067/a00752a4-35e3-4d74-b9a5-5596abf321a1)

The wallet server makes it possible to build/run a fully private light wallet (on nearly any device) without having to run a ironfish node locally. The implementation is a HTTP REST caching server that interacts with an [ironfish](https://github.com/iron-fish/ironfish) node to provide a cached interface for light wallet clients. The REST server exposes OpenAPI defined endpoints for simple client generation (see [example](example). The "light blocks" are minimal representations of Iron Fish blocks that assume trust in the host of the blocks, as the client device will not prove the blocks are valid. The light blocks are encoded via [protobuf](protos) to allow simple serialization/deserialized for network transfer. We have included an [example light wallet client](example/README.md) implementation in this repo.
The wallet server makes it possible to build/run a fully private light wallet (on nearly any device) without having to run a ironfish node locally. The implementation is a HTTP REST caching server that interacts with an [ironfish](https://github.com/iron-fish/ironfish) node to provide a cached interface for light wallet clients. The REST server exposes OpenAPI defined endpoints for simple client generation (see [example](example)). The "light blocks" are minimal representations of Iron Fish blocks that assume trust in the host of the blocks, as the client device will not prove the blocks are valid. The light blocks are encoded via [protobuf](protos) to allow simple serialization/deserialized for network transfer. We have included an [example light wallet client](example/README.md) implementation in this repo.

## Quick start local setup

Expand Down

0 comments on commit f87f397

Please sign in to comment.