Skip to content

Latest commit

 

History

History
190 lines (159 loc) · 4.83 KB

README.md

File metadata and controls

190 lines (159 loc) · 4.83 KB
Raw

Chainlink External Adapter for Eth-balance

1.2.7

External adapter for fetching balances for ETH addresses

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

Environment Variables

Required? Name Description Type Options Default
✅ ETHEREUM_RPC_URL RPC URL of an Ethereum Mainnet node string

Input Parameters

Every EA supports base input parameters from this list

Required? Name Description Type Options Default
endpoint The endpoint to use string balance balance

Balance Endpoint

The balance endpoint will fetch the balance of each address in the query.

balance is the only supported name for this endpoint.

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) array
minConfirmations confirmations Number (integer, min 0, max 64) of blocks that must have been confirmed after the point against which the balance is checked (i.e. balance will be sourced from {latestBlockNumber - minConfirmations} number

Example

Request:

{
  "id": "1",
  "data": {
    "endpoint": "balance",
    "addresses": [
      {
        "address": "0xEF9FFcFbeCB6213E5903529c8457b6F61141140d"
      }
    ],
    "minConfirmations": 0
  },
  "debug": {
    "cacheKey": "BZf6sDQqNncsolxn6HYNEOjtIBI="
  }
}

Response:

{
  "jobRunID": "1",
  "data": {
    "result": [
      {
        "address": "0xEF9FFcFbeCB6213E5903529c8457b6F61141140d",
        "balance": "842796652117371"
      }
    ]
  },
  "result": [
    {
      "address": "0xEF9FFcFbeCB6213E5903529c8457b6F61141140d",
      "balance": "842796652117371"
    }
  ],
  "statusCode": 200,
  "providerStatusCode": 200
}
Additional Examples

Request:

{
  "id": "1",
  "data": {
    "endpoint": "balance",
    "addresses": [
      {
        "address": "0xEF9FFcFbeCB6213E5903529c8457b6F61141140d"
      },
      {
        "address": "0x6a1544F72A2A275715e8d5924e6D8A017F0e41ed"
      }
    ],
    "minConfirmations": 0
  },
  "debug": {
    "cacheKey": "4/IH2wCsKWE3t/W0N/+01/qy/uw="
  }
}

Response:

{
  "jobRunID": "1",
  "data": {
    "result": [
      {
        "address": "0xEF9FFcFbeCB6213E5903529c8457b6F61141140d",
        "balance": "842796652117371"
      },
      {
        "address": "0x6a1544F72A2A275715e8d5924e6D8A017F0e41ed",
        "balance": "1604497408893139674"
      }
    ]
  },
  "result": [
    {
      "address": "0xEF9FFcFbeCB6213E5903529c8457b6F61141140d",
      "balance": "842796652117371"
    },
    {
      "address": "0x6a1544F72A2A275715e8d5924e6D8A017F0e41ed",
      "balance": "1604497408893139674"
    }
  ],
  "statusCode": 200,
  "providerStatusCode": 200
}

Request:

{
  "id": "1",
  "data": {
    "endpoint": "balance",
    "addresses": [
      {
        "address": "0x6a1544F72A2A275715e8d5924e6D8A017F0e41ed"
      }
    ],
    "minConfirmations": 20
  },
  "debug": {
    "cacheKey": "j4E0Rj65/LUMA0SuUweFMQj+iMI="
  }
}

Response:

{
  "jobRunID": "1",
  "data": {
    "result": [
      {
        "address": "0x6a1544F72A2A275715e8d5924e6D8A017F0e41ed",
        "balance": "15671674977708000"
      }
    ]
  },
  "result": [
    {
      "address": "0x6a1544F72A2A275715e8d5924e6D8A017F0e41ed",
      "balance": "15671674977708000"
    }
  ],
  "statusCode": 200,
  "providerStatusCode": 200
}

MIT License