Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/toknapp/arweave4s
Light, modular, functional http-client for the Arweave blockchain
https://github.com/toknapp/arweave4s
arweave-blockchain blockchain
Last synced: 3 months ago
JSON representation
Light, modular, functional http-client for the Arweave blockchain
- Host: GitHub
- URL: https://github.com/toknapp/arweave4s
- Owner: toknapp
- License: other
- Archived: true
- Created: 2018-03-11T23:34:00.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-11-12T02:17:48.000Z (about 5 years ago)
- Last Synced: 2024-04-06T11:35:21.513Z (7 months ago)
- Topics: arweave-blockchain, blockchain
- Language: Scala
- Homepage: https://upvest.co
- Size: 498 KB
- Stars: 13
- Watchers: 3
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
- awesome-arweave - arweave4s - Light, modular, functional http-client for the Arweave blockchain. (Tools ⚙️)
README
## Arweave4s
[](https://circleci.com/gh/toknapp/arweave4s)
[](https://raw.githubusercontent.com/toknapp/arweave4s/develop/COPYING)
[](https://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22co.upvest%22%20AND%20a%3A%22arweave4s-core_2.12%22)
### Overview
Arweave4s is a lightweight modular http client for the [Arweave blockchain](https://github.com/ArweaveTeam/arweave/)
The core of Arweave4s is based on the [sttp http client](https://github.com/softwaremill/sttp), this allow to use it with
different [http backends of your choice](http://sttp.readthedocs.io/en/latest/), such as akka-http, Moniz, OkHttp, Scalaz Streams, plain Futures, synchronously and many more.
The response handling is designed to be as flexible as the backend. By providing implicit response handlers for the monad of your choice `Try`, `Future`
`EitherT`, or plain old throw exceptions like it's 1999.
The current version implements the [following endpoints](https://raw.githubusercontent.com/ArweaveTeam/arweave/master/http_iface_docs.md)
* GET network information
* GET full transaction via ID
* GET specific transaction fields via ID
* GET transaction body as HTML via ID
* GET estimated transaction price
* GET block via ID
* GET block via height
* GET current block
* GET wallet balance via address
* GET last transaction via address
* GET nodes peer list
* POST transaction to network
Additionally the client supports **wallet generation** and **transaction signing**
### Quickstart
Add the following dependency
```
"co.upvest" %% "arweave4s-core" % "0.6.0"
```
then create a configuration context and weave-it-up.
```
implicit val c = api.Config(host = TestHost, HttpURLConnectionBackend())
import api.id._
api.block.current()
res1: Block = ...
```
### Examples
Lets put some data on the Arweave blockchain!
```
// Create configuration. Set the sttp's async backend for returning Futures
implicit val _ = api.Config(host = TestHost, AsyncHttpClientFutureBackend())
// Import response handler for Future
import api.future._
import scala.concurrent.ExecutionContext.global
// Data to persist on the blockchain.
val testData = Data("Hi Mom!".getBytes("UTF-8"))
// Let's get a new wallet
val wallet = Wallet.generate()
for {
// using the API method to estimate the price for the transaction in `Winstons`
price <- api.price.estimate(testData)
// Get the last transaction of the sender wallet
lastTx <- api.address.lastTx(wallet)
// Construct and send the transaction.
() <- api.tx.submit(Transaction.Data(
id = Transaction.Id.generate(),
lastTx = lastTx,
owner = wallet,
data = testData,
reward = price)
// Here we actually sign our transaction
.sign(wallet)
)
} yield ()
```
Voilà, we persisted the data on the blockchain!
### Contact
By questions, comments or suggestions feel free to get in touch by creating an PR or an issue.
For more information to Arweave protocol, check the [Arweave whitepaper](https://www.arweave.org/files/arweave-whitepaper.pdf)
and visit them on [Github](https://github.com/ArweaveTeam/arweave).
### Cavecats [sic](https://www.youtube.com/watch?v=a0SuhNn8S60)
Copyright 2018 Ivan Morozov, Gustav Behm, Tokn GmbH (https://upvest.co)
Arrweave4s is provided to you as free software under the MIT license.
The MIT software license is attached in the [COPYING](COPYING) file.