Skip to content

Latest commit

 

History

History
154 lines (111 loc) · 10.1 KB

README.md

File metadata and controls

154 lines (111 loc) · 10.1 KB
Raw

POR_ADDRESS_LIST

5.4.4 v3

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

Environment Variables

Required? Name Description Type Options Default
✅ RPC_URL The RPC URL to connect to the EVM chain the address manager contract is deployed to. string
CHAIN_ID The chain id to connect to for the RPC URL number 1
GROUP_SIZE The number of concurrent batched contract calls to make at a time. Setting this lower than the default may result in lower performance from the adapter. number 100
BACKGROUND_EXECUTE_MS The amount of time the background execute should sleep before performing the next request number 10000
BEDROCK_UNIBTC_API_ENDPOINT An API endpoint for Bedrock uniBTC native BTC wallet address string https://bedrock-datacenter.rockx.com/data/tvl/reserve_with_native.json
SOLVBTC_API_ENDPOINT An API endpoint for SolvBTC native BTC wallet address string https://por.sft-api.com/solv-btc-addresses.json

Data Provider Rate Limits

Name Requests/credits per second Requests/credits per minute Requests/credits per hour Note
default 1

Input Parameters

Required? Name Description Type Options Default
endpoint The endpoint to use string address, bedrockbtcaddress, multichainaddress, solvbtcaddress address

Address Endpoint

address is the only supported name for this endpoint.

Input Params

Required? Name Aliases Description Type Options Default Depends On Not Valid With
confirmations The number of confirmations to query data from number
✅ contractAddress The contract address holding the custodial addresses string
contractAddressNetwork The network of the contract, used to match {NETWORK}_RPC_URL and {NETWORK}_RPC_CHAIN_ID in env var string
batchSize The number of addresses to fetch from the contract at a time number 10
✅ network The network name to associate with the addresses string
✅ chainId The chain ID to associate with the addresses string
searchLimboValidators Flag to pass on to the balance adapter to search for limbo validators boolean

Example

Request:

{
  "data": {
    "endpoint": "address",
    "confirmations": 0,
    "contractAddress": "abc",
    "contractAddressNetwork": "",
    "batchSize": 10,
    "network": "ethereum",
    "chainId": "1"
  }
}

Solvbtcaddress Endpoint

solvbtcaddress is the only supported name for this endpoint.

Input Params

There are no input parameters for this endpoint.

Example

Request:

{
  "data": {
    "endpoint": "solvbtcaddress"
  }
}

Bedrockbtcaddress Endpoint

bedrockbtcaddress is the only supported name for this endpoint.

Input Params

Required? Name Aliases Description Type Options Default Depends On Not Valid With
✅ type The type of addresses you are looking for. BTC is native BTC address. tokens is for token-balance EA. vault is for eth-balance EA. string BTC, tokens, vault

Example

Request:

{
  "data": {
    "endpoint": "bedrockbtcaddress",
    "type": "BTC"
  }
}

Multichainaddress Endpoint

multichainaddress is the only supported name for this endpoint.

Input Params

Required? Name Aliases Description Type Options Default Depends On Not Valid With
✅ contractAddress The contract address holding the custodial addresses string
✅ contractAddressNetwork The network of the contract, used to match {NETWORK}_RPC_URL and {NETWORK}_RPC_CHAIN_ID in env var string
✅ abiName Used to select the ABI by name string MultiEVMPoRAddressList, PoRAddressListMulti, SolvMultiAddressList
type The type of addresses you are looking for. tokens is for token-balance EA. vault is for eth-balance EA. string tokens, vault tokens
vaultPlaceHolder The tokenAddress indicating which vaultAddress needs to be returned string
confirmations The number of confirmations to query data from number
batchSize The number of addresses to fetch from the contract at a time number 10

Example

Request:

{
  "data": {
    "endpoint": "multichainaddress",
    "contractAddress": "0xb7C0817Dd23DE89E4204502dd2C2EF7F57d3A3B8",
    "contractAddressNetwork": "BINANCE",
    "abiName": "MultiEVMPoRAddressList",
    "type": "tokens",
    "vaultPlaceHolder": "0x0000000000000000000000000000000000000001",
    "confirmations": 0,
    "batchSize": 10
  }
}

MIT License