https://github.com/jonchurch/lotus-client-js

Filecoin Lotus API client
https://github.com/jonchurch/lotus-client-js

Last synced: about 1 month ago
JSON representation

Filecoin Lotus API client

• Host: GitHub
• URL: https://github.com/jonchurch/lotus-client-js
• Owner: jonchurch
• Created: 2019-11-21T00:26:27.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-06-25T09:06:15.000Z (over 2 years ago)
• Last Synced: 2024-10-06T14:41:36.241Z (4 months ago)
• Language: JavaScript
• Size: 9.77 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
This is my attempt at getting Lotus up and running to create a JS client lib for the API.

I hope it will help anyone else as a starting point.

## Dockerfile Usage

I've included a Dockerfile to start lotus and begin syncing the chain to devnet.

Build an image from the Dockerfile and tag it as `lotus-client`:

```shell

docker build -t lotus-client .

```

After it has been built, start the container by running the shell script I've included:

```shell

./dockerRun.sh

```

This will mount three volumes into the container. It will mount this directory and the JS client code at `/lotus-client-js`, as well as create a `.lotus` directory in the container at `/root/.lotus` and a `.lotusstorage` directory at `/root/.lotusstorage`. Both `.lotus` and `.lotusstorage` will be created in your current system's home folder if they don't already exist.

Lotus uses `.lotus` to store API information, as well as the blocks that it attempts to sync when the daemon is run.

You can enter the container with docker exec and run the client code to test the API. I did it like this because I had trouble exposing lotus ports to the host machine `¯\_(ツ)\_/¯`

```shell

docker exec -it lotus-client-dev /bin/bash

```

## API Client

The lotus API exposes a JSON-RPC interface which you can make calls against.

I implemented a few calls to the [Common API](https://github.com/filecoin-project/lotus/blob/master/api/api_common.go) which don't need any parameters in order to test things.

Good luck!