README.md

LOTUS

This document was generated automatically. Please see README Generator for more info.

Known Issues

MAX_PAYLOAD_SIZE_LIMIT configuration

The MAX_PAYLOAD_SIZE_LIMIT environment variable is used for controlling the maximum size of the incoming request body that the EA can handle. If you decide to customize this value it's essential to ensure that any reverse proxy or web server in front of the EA, such as Nginx, is also configured with a corresponding limit. This alignment prevents scenarios where Nginx rejects a request for exceeding its payload size limit before it reaches the EA.

Environment Variables

Required?	Name	Description	Type	Options	Default
✅	API_KEY	Your Lotus node API key/token	string
✅	FILECOIN_RPC_URL	RPC URL of Filecoin node	string
	BACKGROUND_EXECUTE_MS	The amount of time the background execute should sleep before performing the next request	number		10000

---

Data Provider Rate Limits

There are no rate limits for this adapter.

---

Input Parameters

Required?	Name	Description	Type	Options	Default
	endpoint	The endpoint to use	string	balance, filecoin.walletbalance	balance

Balance Endpoint

Supported names for this endpoint are: balance, filecoin.walletbalance.

Input Params

Required?	Name	Aliases	Description	Type	Options	Default	Depends On	Not Valid With
✅	addresses	result	An array of addresses to get the balances of (as an object with string address as an attribute)	object[]
✅	addresses.address		an address to get the balance of	string

Example

Request:

{
  "data": {
    "endpoint": "balance",
    "addresses": [
      {
        "address": "f2eaaj6w4evrdscw4s4o5c3df7ph725tbs3yvg6gi"
      },
      {
        "address": "f225ey7bq53ur6sgrkxgf74hl2ftxkajupatwnmay"
      }
    ]
  }
}

---

MIT License