server

package
v0.0.0-...-146b0ff Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 5, 2025 License: MIT Imports: 24 Imported by: 0

README

API Documentation

Indexed Data API

1. Network Status

[GET] /api/network_status

Response
  • status: The status of the network.
    • Normal: The network is running normally.
    • Degraded: The network is congested but still operational.
    • Down: The network is experiencing critical issues and is no longer operational.
  • consensus_block_height: The latest block height of the consensus layer.
  • execution_block_height: The latest block height of the execution layer.
{
  "code": 200,
  "msg": {
    "status": "Normal",
    "consensus_block_height": 89,
    "execution_block_height": 88
  },
  "error": ""
}
2. Estimated APR

[GET] /api/estimated_apr

Response
  • apr: The estimated APR of the network.
{
  "code": 200,
  "msg": {
    "apr": "1997%"
  },
  "error": ""
}
3. Operation History

[GET] /api/operations/{evm_address}

Path Params
Name Type Example Required
evm_address string 0x64a2fdc6f7cd8aa42e0bb59bf80bc47bffbe4a73 Yes
Query Params
Name Type Example Required
page string 1 No
per_page string 100 No
Response
  • operations: The list of operations.
    • status_ok: Whether the operation is successful.
    • error_code: The error code of the operation, non-empty for failed operations.
    • amount: The amount of the operation in gwei .
    • tx_hash: The hash of the transaction.
    • block_height: The block height of the transaction.
    • event_type: The type of the event.
    • address: The address that performs the operation.
    • src_validator_address: The source validator address, non-empty for Redelegate and RedelegateOnBehalf events.
    • dst_validator_address: The destination validator address, non-empty for Stake, StakeOnBehalf, Redelegate, RedelegateOnBehalf, Unstake, UnstakeOnBehalf, CreateValidator, Unjail, UnjailOnBehalf and UpdateValidatorCommission events.
    • dst_address: The destination address, non-empty for SetOperator, SetWithdrawalAddress and SetRewardAddress events.
  • count: The number of operations in the current page.
  • total: The total number of operations.
{
  "code": 200,
  "msg": {
    "operations": [
      {
        "tx_hash": "0x9f75c84b90e802c4218471ef4e1b68687b847394b1d6de5bbf4d29606d94d748",
        "block_height": 66,
        "event_type": "Unstake",
        "address": "0x64a2fdc6f7cd8aa42e0bb59bf80bc47bffbe4a73",
        "src_validator_address": "",
        "dst_validator_address": "0x00a842dbd3d11176b4868dd753a552b8919d5a63",
        "dst_address": "",
        "status_ok": false,
        "error_code": "unspecified",
        "amount": "1024000000000"
      },
      {
        "tx_hash": "0xdf236f25a1544256cf829188b23ba62a938430aac408b4ace6fa97acde66f34d",
        "block_height": 64,
        "event_type": "Stake",
        "address": "0x64a2fdc6f7cd8aa42e0bb59bf80bc47bffbe4a73",
        "src_validator_address": "",
        "dst_validator_address": "0x00a842dbd3d11176b4868dd753a552b8919d5a63",
        "dst_address": "",
        "status_ok": true,
        "error_code": "",
        "amount": "1024000000000"
      }
    ],
    "count": 2,
    "total": 2
  },
  "error": ""
}
4. Delegator Accumulated Rewards

[GET] /api/rewards/{evm_address}

Path Params
Name Type Example Required
evm_address string 0x64a2fdc6f7cd8aa42e0bb59bf80bc47bffbe4a73 Yes
Response
  • address: The address of the delegator.
  • amount: The accumulated rewards of the delegator in gwei.
  • last_update_height: Last updated block height of the rewards.
{
  "code": 200,
  "msg": {
    "address": "0x64a2fdc6f7cd8aa42e0bb59bf80bc47bffbe4a73",
    "amount": "450275716080",
    "last_update_height": 216
  },
  "error": ""
}
5. Network Total Stake Amount

[GET] /api/staking/total_stake

Response
  • total_stake_amount: Latest network total stake amount.
  • last_update_time: Latest update unix timestamp of total_stake_amount.
{
  "code": 200,
  "msg": {
    "total_stake_amount": "123456789000",
    "last_update_time": "1744005579"
  },
  "error": ""
}
6. Network Total Stake Amount History

[GET] /api/staking/total_stake/history

Query Params
Name Type Example Required
interval string 1d(default), 7d, 30d, all No
Response
  • total_stake_amount_history: A list of total stake amount as well as update time.
    • total_stake_amount: Network total stake amount.
    • update_at: Update unix timestamp of total_stake_amount.
{
  "code": 200,
  "msg": {
    "total_stake_amount_history": [
      "total_stake_amount": "123456789000",
      "update_at": "1744005579"
    ]
  },
  "error": ""
}

Native Story API

1. Staking Params

[GET] /api/staking/params

Response
  • params: The staking params.
    • unbonding_time: The unbonding time in nanoseconds.
    • max_validators: The max number of validators.
    • max_entries: The max number of entries.
    • historical_entries: The max number of historical entries.
    • bond_denom: The denom of the token.
    • min_commission_rate: The min commission rate for validators.
    • min_delegation: The min delegation in gwei.
    • periods: The staking periods.
      • period_type: The type of the period.
        • 0: FLEXIBLE
        • 1: SHORT
        • 2: MEDIUM
        • 3: LONG
      • duration: The minimum duration of the period in nanoseconds.
      • rewards_multiplier: The rewards multiplier of the period.
    • token_types: The types of the tokens.
      • token_type: The type of the token.
        • 0: LOCKED
        • 1: UNLOCKED
      • rewards_multiplier: The rewards multiplier of the token type.
    • singularity_height: The singularity height.
{
  "code": 200,
  "msg": {
    "params": {
      "unbonding_time": "10000000000000",
      "max_validators": 32,
      "max_entries": 14,
      "historical_entries": 10000,
      "bond_denom": "stake",
      "min_commission_rate": "0.050000000000000000",
      "min_delegation": "1024000000000",
      "periods": [
        {
          "period_type": 0,
          "duration": "0",
          "rewards_multiplier": "1.000000000000000000"
        },
        {
          "period_type": 1,
          "duration": "60000000000",
          "rewards_multiplier": "1.051000000000000000"
        },
        {
          "period_type": 2,
          "duration": "120000000000",
          "rewards_multiplier": "1.160000000000000000"
        },
        {
          "period_type": 3,
          "duration": "900000000000",
          "rewards_multiplier": "1.340000000000000000"
        }
      ],
      "token_types": [
        {
          "token_type": 0,
          "rewards_multiplier": "0.500000000000000000"
        },
        {
          "token_type": 1,
          "rewards_multiplier": "1.000000000000000000"
        }
      ],
      "singularity_height": "10000"
    }
  },
  "error": ""
}
2. Staking Pool

[GET] /api/staking/pool

Response
  • pool: The staking pool info.
    • bonded_tokens: The total number of bonded tokens in gwei.
    • not_bonded_tokens: The total number of not bonded tokens in gwei.
{
  "code": 200,
  "msg": {
    "pool": {
      "not_bonded_tokens": "15308800000000",
      "bonded_tokens": "6144004000000"
    }
  },
  "error": ""
}
3. Validators Info

[GET] /api/staking/validators

Query Params
Name Type Example
status string BOND_STATUS_UNBONDED, BOND_STATUS_UNBONDING, BOND_STATUS_BONDED
pagination.key string
pagination.offset string 100
pagination.limit string 10
pagination.count_total string true
pagination.reverse string false
Response
  • validators: The list of validators.
    • operator_address: The evm address of the validator.
    • consensus_pubkey: The base64 encoded compressed public key of the validator.
    • jailed: Whether the validator is jailed.
    • status: The status of the validator.
      • 1: BOND_STATUS_UNBONDED
      • 2: BOND_STATUS_UNBONDING
      • 3: BOND_STATUS_BONDED
    • tokens: The total staked tokens on the validator in gwei.
    • delegator_shares: The total delegator shares on the validator.
    • description: The description of the validator.
      • moniker: The moniker of the validator.
    • commission: The commission of the validator.
    • support_token_type: The support token type of the validator.
      • 0: LOCKED
      • 1: UNLOCKED
    • uptime: The uptime of the validator, empty if the validator has never been bonded.
    • apr: The apr of the validator, affected by the network apr and the validator's commission rate.
  • pagination: The pagination info.
    • next_key: The key to query the next page.
    • total: The total number of validators.
{
  "code": 200,
  "msg": {
    "validators": [
      {
        "operator_address": "0xc5c0beeac8b37ed52f6a675ee2154d926a88e3ec",
        "consensus_pubkey": {
          "type": "tendermint/PubKeySecp256k1",
          "value": "AqBVHHkyOfiie29Wrez6hMvC644kbZfPgXA1jFEs7Uwq"
        },
        "jailed": false,
        "status": 3,
        "tokens": "10039668001000000",
        "delegator_shares": "10039668001000000.000000000000000000",
        "description": {
          "moniker": "0x0FC41199CE588948861A8DA86D725A5A073AE91A"
        },
        "commission": {
          "commission_rates": {
            "rate": "0.070000000000000000",
            "max_rate": "0.100000000000000000",
            "max_change_rate": "0.010000000000000000"
          },
          "update_time": "2025-01-19T15:00:00Z"
        },
        "support_token_type": 0,
        "uptime": "98.84%",
        "apr": "18.43%"
      },
      {
        "operator_address": "0xcd29b70ff04c0aa386f7b3453df0e5ed3d4f67bb",
        "consensus_pubkey": {
          "type": "tendermint/PubKeySecp256k1",
          "value": "A9mdRUGE+sv2oD6jfrNvalDGmELqOtQgOKjVU3vRWyWU"
        },
        "jailed": false,
        "status": 3,
        "tokens": "20317549001000000",
        "delegator_shares": "20317549001000000.000000000000000000",
        "description": {
          "moniker": "0x768A39103B552E7AE56635DD4E9B55922AAFC504"
        },
        "commission": {
          "commission_rates": {
            "rate": "0.070000000000000000",
            "max_rate": "0.100000000000000000",
            "max_change_rate": "0.010000000000000000"
          },
          "update_time": "2025-01-19T15:00:00Z"
        },
        "support_token_type": 1,
        "uptime": "99.8%",
        "apr": "36.86%"
      },
      {
        "operator_address": "0xcd5faabca5bea3c5fc5e2371c7b397604720c2c2",
        "consensus_pubkey": {
          "type": "tendermint/PubKeySecp256k1",
          "value": "A/9SMxZTnh3Rq96Eygg9MfB6g82euMXhjT5nMWrhLlyf"
        },
        "jailed": false,
        "status": 3,
        "tokens": "10035524001000000",
        "delegator_shares": "10035524001000000.000000000000000000",
        "description": {
          "moniker": "0x99C28AE30CBEFEFF75E91C66692FE0BD9279B861"
        },
        "commission": {
          "commission_rates": {
            "rate": "0.070000000000000000",
            "max_rate": "0.100000000000000000",
            "max_change_rate": "0.010000000000000000"
          },
          "update_time": "2025-01-19T15:00:00Z"
        },
        "support_token_type": 0,
        "uptime": "98.64%",
        "apr": "18.43%"
      },
      {
        "operator_address": "0xdb8e606ad7c02f37e43d10a10126791dc94b0434",
        "consensus_pubkey": {
          "type": "tendermint/PubKeySecp256k1",
          "value": "A6KRGirXFYsv5oVQz8d8YIl0Nj23bXo2jLHui72y12Bi"
        },
        "jailed": false,
        "status": 3,
        "tokens": "10061004001000000",
        "delegator_shares": "10061004001000000.000000000000000000",
        "description": {
          "moniker": "0x9DFC26A7662106EEEC5E87B20CBB690CFCE73A05"
        },
        "commission": {
          "commission_rates": {
            "rate": "0.070000000000000000",
            "max_rate": "0.100000000000000000",
            "max_change_rate": "0.010000000000000000"
          },
          "update_time": "2025-01-19T15:00:00Z"
        },
        "support_token_type": 1,
        "uptime": "99.82%",
        "apr": "36.86%"
      }
    ],
    "pagination": {
      "next_key": "",
      "total": "5"
    }
  },
  "error": ""
}
4. Validator Info

[GET] /api/staking/validators/{validator_address}

Path Params
Name Type Example Required
validator_address string 0x64a2fdc6f7cd8aa42e0bb59bf80bc47bffbe4a73 Yes
Response
  • operator_address: The evm address of the validator.
  • consensus_pubkey: The base64 encoded compressed public key of the validator.
  • jailed: Whether the validator is jailed.
  • status: The status of the validator.
    • 1: BOND_STATUS_BONDED
    • 2: BOND_STATUS_UNBONDING
    • 3: BOND_STATUS_UNBONDED
  • tokens: The total staked tokens on the validator in gwei.
  • delegator_shares: The total delegator shares on the validator.
  • description: The description of the validator.
    • moniker: The moniker of the validator.
  • commission: The commission of the validator.
  • support_token_type: The support token type of the validator.
    • 0: LOCKED
    • 1: UNLOCKED
  • uptime: The uptime of the validator, empty if the validator has never been bonded.
  • apr: The apr of the validator, affected by the network apr and the validator's commission rate.
{
  "code": 200,
  "msg": {
    "operator_address": "0xcd5faabca5bea3c5fc5e2371c7b397604720c2c2",
    "consensus_pubkey": {
      "type": "tendermint/PubKeySecp256k1",
      "value": "A/9SMxZTnh3Rq96Eygg9MfB6g82euMXhjT5nMWrhLlyf"
    },
    "jailed": false,
    "status": 3,
    "tokens": "10035524001000000",
    "delegator_shares": "10035524001000000.000000000000000000",
    "description": {
      "moniker": "0x99C28AE30CBEFEFF75E91C66692FE0BD9279B861"
    },
    "commission": {
      "commission_rates": {
        "rate": "0.070000000000000000",
        "max_rate": "0.100000000000000000",
        "max_change_rate": "0.010000000000000000"
      },
      "update_time": "2025-01-19T15:00:00Z"
    },
    "support_token_type": 0,
    "uptime": "98.64%",
    "apr": "18.43%"
  },
  "error": ""
}
5. Delegations of a Validator

[GET] /api/staking/validators/{validator_address}/delegations

Path Params
Name Type Example Required
validator_address string 0x64a2fdc6f7cd8aa42e0bb59bf80bc47bffbe4a73 Yes
Query Params
Name Type Example Required
pagination.key string No
pagination.offset string 100 No
pagination.limit string 10 No
pagination.count_total string true No
pagination.reverse string false No
Response
  • delegation_responses: The list of delegations.
    • delegation: The delegation info.
      • delegator_address: The evm address of the delegator.
      • validator_address: The evm address of the validator.
    • balance: The balance of the delegation.
      • denom: The denom of the balance.
      • amount: The amount of the balance in gwei.
  • pagination: The pagination info.
    • next_key: The key to query the next page.
    • total: The total number of delegations.
{
  "code": 200,
  "msg": {
    "delegation_responses": [
      {
        "delegation": {
          "delegator_address": "0x00a842dbd3d11176b4868dd753a552b8919d5a63",
          "validator_address": "0x00a842dbd3d11176b4868dd753a552b8919d5a63",
          "shares": "1000000.000000000000000000",
          "rewards_shares": "500000.000000000000000000"
        },
        "balance": {
          "denom": "stake",
          "amount": "1000000"
        }
      },
      {
        "delegation": {
          "delegator_address": "0x64a2fdc6f7cd8aa42e0bb59bf80bc47bffbe4a73",
          "validator_address": "0x00a842dbd3d11176b4868dd753a552b8919d5a63",
          "shares": "6144000000000.000000000000000000",
          "rewards_shares": "3072000000000.000000000000000000"
        },
        "balance": {
          "denom": "stake",
          "amount": "6144000000000"
        }
      }
    ],
    "pagination": {
      "next_key": "",
      "total": "2"
    }
  },
  "error": ""
}
6. Delegation of a Validator

[GET] /api/staking/validators/{validator_address}/delegations/{delegator_address}

Path Params
Name Type Example Required
validator_address string 0x64a2fdc6f7cd8aa42e0bb59bf80bc47bffbe4a73 Yes
delegator_address string 0x64a2fdc6f7cd8aa42e0bb59bf80bc47bffbe4a73 Yes
Response
  • delegation_response: The delegation info.
    • delegation: The delegation info.
      • delegator_address: The evm address of the delegator.
      • validator_address: The evm address of the validator.
    • balance: The balance of the delegation.
      • denom: The denom of the balance.
      • amount: The amount of the balance in gwei.
{
  "code": 200,
  "msg": {
    "delegation_response": {
      "delegation": {
        "delegator_address": "0x64a2fdc6f7cd8aa42e0bb59bf80bc47bffbe4a73",
        "validator_address": "0x00a842dbd3d11176b4868dd753a552b8919d5a63",
        "shares": "6144000000000.000000000000000000",
        "rewards_shares": "3072000000000.000000000000000000"
      },
      "balance": {
        "denom": "stake",
        "amount": "6144000000000"
      }
    }
  },
  "error": ""
}
7. Period Delegations of a Validator

[GET] /api/staking/validators/{validator_address}/delegators/{delegator_address}/period_delegations

Path Params
Name Type Example Required
validator_address string 0x64a2fdc6f7cd8aa42e0bb59bf80bc47bffbe4a73 Yes
delegator_address string 0x64a2fdc6f7cd8aa42e0bb59bf80bc47bffbe4a73 Yes
Query Params
Name Type Example Required
pagination.key string No
pagination.offset string 100 No
pagination.limit string 10 No
pagination.count_total string true No
pagination.reverse string false No
Response
  • period_delegation_responses: The list of period delegations.
    • period_delegation: The period delegation info.
      • delegator_address: The evm address of the delegator.
      • validator_address: The evm address of the validator.
      • period_delegation_id: The id of the period delegation.
      • end_time: The time after which unstaking is allowed for the period delegation.
    • balance: The balance of the period delegation.
      • denom: The denom of the balance.
      • amount: The amount of the balance in gwei.
  • pagination: The pagination info.
    • next_key: The key to query the next page.
    • total: The total number of period delegations.
{
  "code": 200,
  "msg": {
    "period_delegation_responses": [
      {
        "period_delegation": {
          "delegator_address": "0x64a2fdc6f7cd8aa42e0bb59bf80bc47bffbe4a73",
          "validator_address": "0x00a842dbd3d11176b4868dd753a552b8919d5a63",
          "period_delegation_id": "0",
          "shares": "6144000000000.000000000000000000",
          "rewards_shares": "3072000000000.000000000000000000",
          "end_time": "2025-01-31T23:16:16.421292251Z"
        },
        "balance": {
          "denom": "stake",
          "amount": "6144000000000"
        }
      }
    ],
    "pagination": {
      "next_key": "",
      "total": "1"
    }
  },
  "error": ""
}
8. Period Delegation of a Validator

[GET] /api/staking/validators/{validator_address}/delegators/{delegator_address}/period_delegations/{period_delegation_id}

Path Params
Name Type Example Required
validator_address string 0x64a2fdc6f7cd8aa42e0bb59bf80bc47bffbe4a73 Yes
delegator_address string 0x64a2fdc6f7cd8aa42e0bb59bf80bc47bffbe4a73 Yes
period_delegation_id string 0 Yes
Response
  • period_delegation: The period delegation info.
    • delegator_address: The evm address of the delegator.
    • validator_address: The evm address of the validator.
    • period_delegation_id: The id of the period delegation.
    • end_time: The time after which unstaking is allowed for the period delegation.
  • balance: The balance of the period delegation.
    • denom: The denom of the balance.
    • amount: The amount of the balance in gwei.
{
  "code": 200,
  "msg": {
    "period_delegation_response": {
      "period_delegation": {
        "delegator_address": "0x64a2fdc6f7cd8aa42e0bb59bf80bc47bffbe4a73",
        "validator_address": "0x00a842dbd3d11176b4868dd753a552b8919d5a63",
        "period_delegation_id": "0",
        "shares": "6144000000000.000000000000000000",
        "rewards_shares": "3072000000000.000000000000000000",
        "end_time": "2025-01-31T23:16:16.421292251Z"
      },
      "balance": {
        "denom": "stake",
        "amount": "6144000000000"
      }
    }
  },
  "error": ""
}
9. Delegations of a Delegator

[GET] /api/staking/delegations/{delegator_address}

Path Params
Name Type Example Required
delegator_address string 0x64a2fdc6f7cd8aa42e0bb59bf80bc47bffbe4a73 Yes
Query Params
Name Type Example Required
pagination.key string No
pagination.offset string 100 No
pagination.limit string 10 No
pagination.count_total string true No
pagination.reverse string false No
Response
  • delegation_responses: The list of delegations.
    • delegation: The delegation info.
      • delegator_address: The evm address of the delegator.
      • validator_address: The evm address of the validator.
    • balance: The balance of the delegation.
      • denom: The denom of the balance.
      • amount: The amount of the balance in gwei.
  • pagination: The pagination info.
    • next_key: The key to query the next page.
    • total: The total number of delegations.
{
  "code": 200,
  "msg": {
    "delegation_responses": [
      {
        "delegation": {
          "delegator_address": "0x64a2fdc6f7cd8aa42e0bb59bf80bc47bffbe4a73",
          "validator_address": "0x00a842dbd3d11176b4868dd753a552b8919d5a63",
          "shares": "6144000000000.000000000000000000",
          "rewards_shares": "3072000000000.000000000000000000"
        },
        "balance": {
          "denom": "stake",
          "amount": "6144000000000"
        }
      },
      {
        "delegation": {
          "delegator_address": "0x64a2fdc6f7cd8aa42e0bb59bf80bc47bffbe4a73",
          "validator_address": "0x64a2fdc6f7cd8aa42e0bb59bf80bc47bffbe4a73",
          "shares": "1024000000000.000000000000000000",
          "rewards_shares": "1024000000000.000000000000000000"
        },
        "balance": {
          "denom": "stake",
          "amount": "972800000000"
        }
      }
    ],
    "pagination": {
      "next_key": "",
      "total": "2"
    }
  },
  "error": ""
}
10. Unbonding Delegations of a Delegator

[GET] /api/staking/delegators/{delegator_address}/unbonding_delegations

Path Params
Name Type Example Required
delegator_address string 0x64a2fdc6f7cd8aa42e0bb59bf80bc47bffbe4a73 Yes
Query Params
Name Type Example Required
pagination.key string No
pagination.offset string 100 No
pagination.limit string 10 No
pagination.count_total string true No
pagination.reverse string false No
Response
  • unbonding_responses: The list of unbonding delegations.
    • delegator_address: The evm address of the delegator.
    • validator_address: The evm address of the validator.
    • entries: The list of entries in the unbonding delegation.
      • creation_height: The height at which the unbonding delegation was created.
      • completion_time: The time at which the unbonding delegation will be completed.
      • initial_balance: The initial balance of the unbonding delegation.
      • balance: The current balance of the unbonding delegation, may be less than the initial balance due to slashing.
      • unbonding_id: The unique id of the unbonding delegation.
  • pagination: The pagination info.
    • next_key: The key to query the next page.
    • total: The total number of unbonding delegations.
{
  "code": 200,
  "msg": {
    "unbonding_responses": [
      {
        "delegator_address": "0x64a2fdc6f7cd8aa42e0bb59bf80bc47bffbe4a73",
        "validator_address": "0x00a842dbd3d11176b4868dd753a552b8919d5a63",
        "entries": [
          {
            "creation_height": "15",
            "completion_time": "2025-02-01T02:03:07.77114334Z",
            "initial_balance": "1024000000000",
            "balance": "1024000000000",
            "unbonding_id": "1"
          },
          {
            "creation_height": "16",
            "completion_time": "2025-02-01T02:03:10.403828008Z",
            "initial_balance": "1024000000000",
            "balance": "1024000000000",
            "unbonding_id": "2"
          }
        ]
      }
    ],
    "pagination": {
      "next_key": "",
      "total": "1"
    }
  },
  "error": ""
}

Documentation

Index

Constants

View Source 
const (
	IndexModeReader = "reader"
	IndexModeWriter = "writer"
)
View Source 
const (
	TokenTypeLocked   = 0
	TokenTypeUnlocked = 1
)
View Source 
const (
	CacheEngineRedis = "redis"
)
View Source 
const (
	DatabaseEnginePostgres = "postgres"
)

Variables

View Source 
var (
	ErrInternalDataServiceError = errors.New("internal data service error")
	ErrInternalAPIServiceError  = errors.New("internal api service error")
	ErrParseParameter           = errors.New("parse parameter error")
	ErrInvalidParameter         = errors.New("invalid parameter")
)

Functions

func GetCachedData 

func GetCachedData[T any](ctx context.Context, rdb *redis.Client, key string) (*T, bool)

func ParsePaginationParams 

func ParsePaginationParams(c *gin.Context) map[string]string

func SetCachedData 

func SetCachedData[T any](ctx context.Context, rdb *redis.Client, key string, data T) bool

Types

type BlockchainConfig 

type BlockchainConfig struct {
	ConsensusChainID    string `toml:"consensus_chain_id"`
	CometbftRPCEndpoint string `toml:"cometbft_rpc_endpoint"`
	StoryAPIEndpoint    string `toml:"story_api_endpoint"`
	GethRPCEndpoint     string `toml:"geth_rpc_endpoint"`
}

type CacheConfig 

type CacheConfig struct {
	Engine     string `toml:"engine"`
	ConfigFile string `toml:"config_file"`
}

type Config 

type Config struct {
	Blockchain BlockchainConfig `toml:"blockchain"`
	Server     ServerConfig     `toml:"server"`
	Database   DatabaseConfig   `toml:"database"`
	Cache      CacheConfig      `toml:"cache"`
}

func (Config) Validate 

func (c Config) Validate() error

type DatabaseConfig 

type DatabaseConfig struct {
	Engine     string `toml:"engine"`
	ConfigFile string `toml:"config_file"`
}

type DelegationInfo 

type DelegationInfo struct {
	Delegation struct {
		DelegatorAddress string `json:"delegator_address"`
		ValidatorAddress string `json:"validator_address"`
		Shares           string `json:"shares"`
		RewardsShares    string `json:"rewards_shares"`
	} `json:"delegation"`
	Balance struct {
		Denom  string `json:"denom"`
		Amount string `json:"amount"`
	} `json:"balance"`
}

type DelegationResponse 

type DelegationResponse struct {
	DelegationResponse DelegationInfo `json:"delegation_response"`
}

type DelegationsResponse 

type DelegationsResponse struct {
	DelegationResponses []DelegationInfo `json:"delegation_responses"`
	Pagination          Pagination       `json:"pagination"`
}

type DistributionParamsResponse 

type DistributionParamsResponse struct {
	Params struct {
		Ubi string `json:"ubi"`
	} `json:"params"`
}

type EstimatedAPRData 

type EstimatedAPRData struct {
	APR string `json:"apr"`
}

type Interval 

type Interval string
const (
	IntervalOneDay     Interval = "1d"
	IntervalSevenDays  Interval = "7d"
	IntervalThirtyDays Interval = "30d"
	IntervalAllTime    Interval = "all"
)

type MintParamsResponse 

type MintParamsResponse struct {
	Params struct {
		MintDenom         string `json:"mint_denom"`
		InflationsPerYear string `json:"inflations_per_year"`
		BlocksPerYear     string `json:"blocks_per_year"`
	} `json:"params"`
}

type NetworkStatus 

type NetworkStatus string
const (
	StatusNormal   NetworkStatus = "Normal"
	StatusDegraded NetworkStatus = "Degraded"
	StatusDown     NetworkStatus = "Down"
)

type NetworkStatusData 

type NetworkStatusData struct {
	Status        NetworkStatus `json:"status"`
	CLBlockNumber int64         `json:"consensus_block_height"`
	ELBlockNumber int64         `json:"execution_block_height"`
}

type OperationsData 

type OperationsData struct {
	Operations []*db.Operation `json:"operations"`
	Count      int             `json:"count"`
	Total      int64           `json:"total"`
}

type Pagination 

type Pagination struct {
	NextKey string `json:"next_key"`
	Total   string `json:"total"`
}

type PeriodDelegationInfo 

type PeriodDelegationInfo struct {
	PeriodDelegation struct {
		DelegatorAddress   string `json:"delegator_address"`
		ValidatorAddress   string `json:"validator_address"`
		PeriodDelegationID string `json:"period_delegation_id"`
		PeriodType         int    `json:"period_type"`
		Shares             string `json:"shares"`
		RewardsShares      string `json:"rewards_shares"`
		EndTime            string `json:"end_time"`
	} `json:"period_delegation"`
	Balance struct {
		Denom  string `json:"denom"`
		Amount string `json:"amount"`
	} `json:"balance"`
}

type PeriodDelegationResponse 

type PeriodDelegationResponse struct {
	PeriodDelegationResponse PeriodDelegationInfo `json:"period_delegation_response"`
}

type PeriodDelegationsResponse 

type PeriodDelegationsResponse struct {
	PeriodDelegationResponses []PeriodDelegationInfo `json:"period_delegation_responses"`
	Pagination                Pagination             `json:"pagination"`
}

type QueryResponse 

type QueryResponse[T any] struct {
	Code  int    `json:"code"`
	Msg   T      `json:"msg"`
	Error string `json:"error"`
}

func GetDistributionParams 

func GetDistributionParams(apiEndpoint string) (*QueryResponse[DistributionParamsResponse], error)

func GetMintParams 

func GetMintParams(apiEndpoint string) (*QueryResponse[MintParamsResponse], error)

func GetStakingDelegation 

func GetStakingDelegation(apiEndpoint, validatorAddr, delegatorAddr string) (*QueryResponse[DelegationResponse], error)

func GetStakingDelegatorDelegations 

func GetStakingDelegatorDelegations(apiEndpoint, delegatorAddr string, params map[string]string) (*QueryResponse[DelegationsResponse], error)

func GetStakingDelegatorUnbondingDelegations 

func GetStakingDelegatorUnbondingDelegations(apiEndpoint, delegatorAddr string, params map[string]string) (*QueryResponse[UnbondingDelegationsResponse], error)

func GetStakingParams 

func GetStakingParams(apiEndpoint string) (*QueryResponse[StakingParamsResponse], error)

func GetStakingPool 

func GetStakingPool(apiEndpoint string) (*QueryResponse[StakingPoolResponse], error)

func GetStakingValidator 

func GetStakingValidator(apiEndpoint, validatorAddr string) (*QueryResponse[ValidatorResponse], error)

func GetStakingValidatorDelegations 

func GetStakingValidatorDelegations(apiEndpoint, validatorAddr string, params map[string]string) (*QueryResponse[DelegationsResponse], error)

func GetStakingValidatorDelegatorPeriodDelegation 

func GetStakingValidatorDelegatorPeriodDelegation(apiEndpoint, validatorAddr, delegatorAddr, delegationID string) (*QueryResponse[PeriodDelegationResponse], error)

func GetStakingValidatorDelegatorPeriodDelegations 

func GetStakingValidatorDelegatorPeriodDelegations(apiEndpoint, validatorAddr, delegatorAddr string, params map[string]string) (*QueryResponse[PeriodDelegationsResponse], error)

func GetStakingValidators 

func GetStakingValidators(apiEndpoint string, params map[string]string) (*QueryResponse[ValidatorsResponse], error)

type Response 

type Response struct {
	Code  int    `json:"code"`
	Msg   any    `json:"msg"`
	Error string `json:"error"`
}

type RewardsData 

type RewardsData struct {
	Address          string `json:"address"`
	Amount           string `json:"amount"`
	LastUpdateHeight int64  `json:"last_update_height"`
}

type Server 

type Server struct {
	// contains filtered or unexported fields
}

func NewServer 

func NewServer(ctx context.Context, dir string, conf *Config) (*Server, error)

func (*Server) EstimatedAPRHandler 

func (s *Server) EstimatedAPRHandler() gin.HandlerFunc

func (*Server) GetSystemAPRPercentage 

func (s *Server) GetSystemAPRPercentage() (decimal.Decimal, error)

func (*Server) GracefulQuit 

func (s *Server) GracefulQuit() error

func (*Server) NetworkStatusHandler 

func (s *Server) NetworkStatusHandler() gin.HandlerFunc

func (*Server) OperationsHandler 

func (s *Server) OperationsHandler() gin.HandlerFunc

func (*Server) RewardsHandler 

func (s *Server) RewardsHandler() gin.HandlerFunc

func (*Server) Run 

func (s *Server) Run()

func (*Server) StakingDelegationHandler 

func (s *Server) StakingDelegationHandler() gin.HandlerFunc

func (*Server) StakingDelegatorDelegationsHandler 

func (s *Server) StakingDelegatorDelegationsHandler() gin.HandlerFunc

func (*Server) StakingDelegatorUnbondingDelegationsHandler 

func (s *Server) StakingDelegatorUnbondingDelegationsHandler() gin.HandlerFunc

func (*Server) StakingParamsHandler 

func (s *Server) StakingParamsHandler() gin.HandlerFunc

func (*Server) StakingPoolHandler 

func (s *Server) StakingPoolHandler() gin.HandlerFunc

func (*Server) StakingValidatorDelegationsHandler 

func (s *Server) StakingValidatorDelegationsHandler() gin.HandlerFunc

func (*Server) StakingValidatorDelegatorPeriodDelegationHandler 

func (s *Server) StakingValidatorDelegatorPeriodDelegationHandler() gin.HandlerFunc

func (*Server) StakingValidatorDelegatorPeriodDelegationsHandler 

func (s *Server) StakingValidatorDelegatorPeriodDelegationsHandler() gin.HandlerFunc

func (*Server) StakingValidatorHandler 

func (s *Server) StakingValidatorHandler() gin.HandlerFunc

func (*Server) StakingValidatorsHandler 

func (s *Server) StakingValidatorsHandler() gin.HandlerFunc

func (*Server) TotalStakeHandler 

func (s *Server) TotalStakeHandler() gin.HandlerFunc

func (*Server) TotalStakeHistoryHandler 

func (s *Server) TotalStakeHistoryHandler() gin.HandlerFunc

type ServerConfig 

type ServerConfig struct {
	IndexMode   string `toml:"index_mode"`
	ServiceMode string `toml:"service_mode"`
	ServicePort string `toml:"service_port"`
}

type StakeAmountData 

type StakeAmountData struct {
	TotalStakeAmount int64 `json:"total_stake_amount"`
	UpdateAt         int64 `json:"update_at"`
}

type StakingParamsResponse 

type StakingParamsResponse struct {
	Params struct {
		UnbondingTime     string `json:"unbonding_time"`
		MaxValidators     int    `json:"max_validators"`
		MaxEntries        int    `json:"max_entries"`
		HistoricalEntries int    `json:"historical_entries"`
		BondDenom         string `json:"bond_denom"`
		MinCommissionRate string `json:"min_commission_rate"`
		MinDelegation     string `json:"min_delegation"`
		Periods           []struct {
			PeriodType        int    `json:"period_type"`
			Duration          string `json:"duration"`
			RewardsMultiplier string `json:"rewards_multiplier"`
		} `json:"periods"`
		TokenTypes []struct {
			TokenType         int    `json:"token_type"`
			RewardsMultiplier string `json:"rewards_multiplier"`
		} `json:"token_types"`
		SingularityHeight string `json:"singularity_height"`
	} `json:"params"`
}

type StakingPoolResponse 

type StakingPoolResponse struct {
	Pool struct {
		NotBondedTokens string `json:"not_bonded_tokens"`
		BondedTokens    string `json:"bonded_tokens"`
	} `json:"pool"`
}

type StakingValidatorData 

type StakingValidatorData struct {
	ValidatorInfo
	Uptime string `json:"uptime"`
	APR    string `json:"apr"`
}

type StakingValidatorsData 

type StakingValidatorsData struct {
	Validators []StakingValidatorData `json:"validators"`
	Pagination Pagination             `json:"pagination"`
}

type UnbondingDelegationsResponse 

type UnbondingDelegationsResponse struct {
	UnbondingResponses []struct {
		DelegatorAddress string `json:"delegator_address"`
		ValidatorAddress string `json:"validator_address"`
		Entries          []struct {
			CreationHeight string `json:"creation_height"`
			CompletionTime string `json:"completion_time"`
			InitialBalance string `json:"initial_balance"`
			Balance        string `json:"balance"`
			UnbondingID    string `json:"unbonding_id"`
		} `json:"entries"`
	} `json:"unbonding_responses"`
	Pagination Pagination `json:"pagination"`
}

type ValidatorInfo 

type ValidatorInfo struct {
	OperatorAddress string `json:"operator_address"`
	ConsensusPubKey struct {
		Type  string `json:"type"`
		Value string `json:"value"`
	} `json:"consensus_pubkey"`
	Jailed          bool   `json:"jailed"`
	Status          int    `json:"status"`
	Tokens          string `json:"tokens"`
	RewardsTokens   string `json:"rewards_tokens"`
	DelegatorShares string `json:"delegator_shares"`
	Description     struct {
		Moniker string `json:"moniker"`
	} `json:"description"`
	Commission struct {
		CommissionRates struct {
			Rate          string `json:"rate"`
			MaxRate       string `json:"max_rate"`
			MaxChangeRate string `json:"max_change_rate"`
		} `json:"commission_rates"`
		UpdateTime string `json:"update_time"`
	} `json:"commission"`
	SupportTokenType int `json:"support_token_type"`
}

type ValidatorResponse 

type ValidatorResponse struct {
	Validator ValidatorInfo `json:"validator"`
}

type ValidatorsResponse 

type ValidatorsResponse struct {
	Validators []ValidatorInfo `json:"validators"`
	Pagination Pagination      `json:"pagination"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.