@proton/hyperion
Advanced tools
Using Yarn:
yarn add @eoscafe/hyperion
or using NPM:
npm install --save @eoscafe/hyperion
CommonJS
const { JsonRpc } = require("@eoscafe/hyperion")
const fetch = require("isomorphic-fetch")
const endpoint = "https://eos.hyperion.eosrio.io"
const rpc = new JsonRpc(endpoint, { fetch })
TypeScript
import { JsonRpc } from "@eoscafe/hyperion"
import fetch from "isomorphic-fetch"
const endpoint = "https://eos.hyperion.eosrio.io"
const rpc = new JsonRpc(endpoint, { fetch })
HYPERION_ENDPOINT=<Enter Hyperion Endpoint> # "https://eos.hyperion.eosrio.io"
# State
/v2/state/alive
/v2/state/get_key_accounts
/v2/state/get_tokens
/v2/state/get_voters
/v2/state/get_links
# History
/v2/history/get_abi_snapshot
/v2/history/get_actions
/v2/history/get_created_accounts
/v2/history/get_creator
/v2/history/get_deltas
/v2/history/get_transacted_accounts
/v2/history/get_transaction
/v2/history/get_transfers
JsonRpc
endpoint string hyperion endpointconst endpoint = "https://br.eosrio.io"
const rpc = new JsonRpc(endpoint, { fetch })
simple server healthcheck
const response = await rpc.alive();
console.log(response);
// => {"status": "OK"}
Returns Promise<Alive> alive
GET /v2/history/get_abi_snapshot
fetch contract abi at specific block
const response = await rpc.get_abi_snapshot("eosio", 200);
console.log(response.version);
// => "eosio::abi/1.0"
for (const table of response.tables) {
console.log(table);
// => { name: 'producers', index_type: 'i64', key_names: [ 'owner' ], key_types: [ 'uint64' ], type: 'producer_info' }
}
Returns Promise<GetAbiSnapshot> abi snapshot
get voters
options object Optional parameters (optional, default {})
const response = await rpc.get_voters({ producer: "eoscafeblock", limit: 100 });
console.log(response.voters);
// => "[{
// "account": "guzdkmrtgage",
// "weight": 78434695236505280,
// "last_vote": 64804768
// }]"
Returns Promise<GetVoters> voters
get actions based on notified account
account string notified accountoptions object Optional parameters (optional, default {})
options.filter string? code::name filteroptions.skip number? skip [n] actions (pagination)options.limit number? limit of [n] actions per pageoptions.sort string? sort directionoptions.after string? filter after specified date (ISO8601)options.before string? filter before specified date (ISO8601)options.transfer_to string? transfer filter tooptions.transfer_from string? transfer filter fromoptions.transfer_symbol string? transfer filter symboloptions.act_name string? act nameoptions.act_account string? act accountconst response = await rpc.get_actions("eoscafeblock", {
filter: "eosio.token:*",
skip: 100,
limit: 100,
});
for (const action of response.actions) {
console.log(action);
// => { act: { account: 'eosio.token', name: 'transfer', ... } }
}
Returns Promise<GetActions> get actions
GET /v2/history/get_created_accounts
get created accounts
account string created accountconst response = await rpc.get_created_accounts("eosnationftw");
console.log(response);
// => {"accounts": [{"name":"eosnationdsp","trx_id":"728d4a4da36a98d9048080461dacaf975ad083e8158ef84edea60cc755ab2c1a","timestamp":"2019-02-28T22:36:45.000"}, ... ]}
Returns Promise<GetCreatedAccounts> get creator
get creator
account string created accountconst response = await rpc.get_creator("eosnationftw");
console.log(response);
// => { account: 'eosnationftw', creator: 'gyztcmrvgqge', timestamp: '2018-06-10T13:06:43.500', ... }
Returns Promise<GetCreator> get creator
get deltas
code string contract accountscope string table scopetable string table namepayer string payer accountconst response = await rpc.get_deltas("eosio.token", "eosnationftw", "accounts", "eosnationftw");
console.log(response);
// => { "query_time": 19, "total": { "value": 486, "relation": "eq" }, "deltas": [ ... ] }
Returns Promise<GetDeltas> get deltas
get account by public key
public_key string Contract account targeted by the action.const response = await rpc.get_key_accounts("EOS5Mto3Km6BCVxowb6LkkFaT9oaUwLVgswgcxvY4Qgc4rhHry4Tv");
console.log(response.account_names);
// => [ 'eoscafeblock' ]
Returns Promise<GetKeyAccounts> key accounts
get tokens
account string accountconst response = await rpc.get_tokens("eosnationftw");
for (const token of response.tokens) {
console.log(token);
// => { symbol: 'ZOS', precision: 4, amount: 140, contract: 'zosdiscounts' }
}
Returns Promise<GetTokens> get tokens
GET /v2/history/get_transacted_accounts
get all account that interacted with the source account provided
const response = await rpc.get_transacted_accounts("eoscafeblock", "in");
console.log(response);
// => { query_time: 268, account: 'eoscafeblock', total_in: 1092369.1827, inputs: [ ... ] }
Returns Promise<GetTransactedAccounts> transacted accounts
GET /v2/history/get_transaction
get all actions belonging to the same transaction
id string transaction idconst response = await rpc.get_transaction("42dacd5722001b734be46a2140917e06cd21d42425f927f506c07b4388b07f62");
for (const action of response.actions) {
console.log(action);
// => { act: { account: 'eosio', name: 'buyrambytes', ... }}
}
Returns Promise<GetTransaction> transaction
get token transfers utilizing the eosio.token standard
options object Optional parameters (optional, default {})
options.from string? source accountoptions.to string? destination accountoptions.symbol string? token symboloptions.contract string? token contractoptions.skip number? skip [n] actions (pagination)options.limit number? limit of [n] actions per pageoptions.after string? filter after specified date (ISO8601)options.before string? filter before specified date (ISO8601)const response = await rpc.get_transfers({to: "eosnewyorkio"});
for (const action of response.actions) {
console.log(action.act.data);
// => { from: 'eosio.bpay', to: 'eosnewyorkio', amount: 326.524, symbol: 'EOS', memo: 'producer block pay' }
}
Returns Promise<GetTransfers> transfers
simple server healthcheck
const response = await rpc.alive();
console.log(response);
// => {"status": "OK"}
Returns Promise<Alive> alive
GET /v2/history/get_abi_snapshot
fetch contract abi at specific block
const response = await rpc.get_abi_snapshot("eosio", 200);
console.log(response.version);
// => "eosio::abi/1.0"
for (const table of response.tables) {
console.log(table);
// => { name: 'producers', index_type: 'i64', key_names: [ 'owner' ], key_types: [ 'uint64' ], type: 'producer_info' }
}
Returns Promise<GetAbiSnapshot> abi snapshot
get voters
options object Optional parameters (optional, default {})
const response = await rpc.get_voters({ producer: "eoscafeblock", limit: 100 });
console.log(response.voters);
// => "[{
// "account": "guzdkmrtgage",
// "weight": 78434695236505280,
// "last_vote": 64804768
// }]"
Returns Promise<GetVoters> voters
get actions based on notified account
account string notified accountoptions object Optional parameters (optional, default {})
options.filter string? code::name filteroptions.skip number? skip [n] actions (pagination)options.limit number? limit of [n] actions per pageoptions.sort string? sort directionoptions.after string? filter after specified date (ISO8601)options.before string? filter before specified date (ISO8601)options.transfer_to string? transfer filter tooptions.transfer_from string? transfer filter fromoptions.transfer_symbol string? transfer filter symboloptions.act_name string? act nameoptions.act_account string? act accountconst response = await rpc.get_actions("eoscafeblock", {
filter: "eosio.token:*",
skip: 100,
limit: 100,
});
for (const action of response.actions) {
console.log(action);
// => { act: { account: 'eosio.token', name: 'transfer', ... } }
}
Returns Promise<GetActions> get actions
GET /v2/history/get_created_accounts
get created accounts
account string created accountconst response = await rpc.get_created_accounts("eosnationftw");
console.log(response);
// => {"accounts": [{"name":"eosnationdsp","trx_id":"728d4a4da36a98d9048080461dacaf975ad083e8158ef84edea60cc755ab2c1a","timestamp":"2019-02-28T22:36:45.000"}, ... ]}
Returns Promise<GetCreatedAccounts> get creator
get creator
account string created accountconst response = await rpc.get_creator("eosnationftw");
console.log(response);
// => { account: 'eosnationftw', creator: 'gyztcmrvgqge', timestamp: '2018-06-10T13:06:43.500', ... }
Returns Promise<GetCreator> get creator
get deltas
code string contract accountscope string table scopetable string table namepayer string payer accountconst response = await rpc.get_deltas("eosio.token", "eosnationftw", "accounts", "eosnationftw");
console.log(response);
// => { "query_time": 19, "total": { "value": 486, "relation": "eq" }, "deltas": [ ... ] }
Returns Promise<GetDeltas> get deltas
get account by public key
public_key string Contract account targeted by the action.const response = await rpc.get_key_accounts("EOS5Mto3Km6BCVxowb6LkkFaT9oaUwLVgswgcxvY4Qgc4rhHry4Tv");
console.log(response.account_names);
// => [ 'eoscafeblock' ]
Returns Promise<GetKeyAccounts> key accounts
get tokens
account string accountconst response = await rpc.get_tokens("eosnationftw");
for (const token of response.tokens) {
console.log(token);
// => { symbol: 'ZOS', precision: 4, amount: 140, contract: 'zosdiscounts' }
}
Returns Promise<GetTokens> get tokens
GET /v2/history/get_transacted_accounts
get all account that interacted with the source account provided
const response = await rpc.get_transacted_accounts("eoscafeblock", "in");
console.log(response);
// => { query_time: 268, account: 'eoscafeblock', total_in: 1092369.1827, inputs: [ ... ] }
Returns Promise<GetTransactedAccounts> transacted accounts
GET /v2/history/get_transaction
get all actions belonging to the same transaction
id string transaction idconst response = await rpc.get_transaction("42dacd5722001b734be46a2140917e06cd21d42425f927f506c07b4388b07f62");
for (const action of response.actions) {
console.log(action);
// => { act: { account: 'eosio', name: 'buyrambytes', ... }}
}
Returns Promise<GetTransaction> transaction
get token transfers utilizing the eosio.token standard
options object Optional parameters (optional, default {})
options.from string? source accountoptions.to string? destination accountoptions.symbol string? token symboloptions.contract string? token contractoptions.skip number? skip [n] actions (pagination)options.limit number? limit of [n] actions per pageoptions.after string? filter after specified date (ISO8601)options.before string? filter before specified date (ISO8601)const response = await rpc.get_transfers({to: "eosnewyorkio"});
for (const action of response.actions) {
console.log(action.act.data);
// => { from: 'eosio.bpay', to: 'eosnewyorkio', amount: 326.524, symbol: 'EOS', memo: 'producer block pay' }
}
Returns Promise<GetTransfers> transfers
FAQs
Hyperion HTTP API Javascript library
The npm package @proton/hyperion receives a total of 94 weekly downloads. As such, @proton/hyperion popularity was classified as not popular.
We found that @proton/hyperion demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.