Relayers
post
https://api.octusbridge.io/v1/relays_pages
/relay_info
Get relayer data
This function is used to return information about a specific relayer based on its address.
It can be used anywhere where details about a specific relayer is needed such as details about events and their confirmation, validating rounds, rewards, stake etc.
Required body parameters:
Name | Example value | Comment |
|---|---|---|
relayAddress | 0:daacff0f136da1d5c9fa73200d481362c44756b0ff7d083ee02e95f00a078557 | Address of the desired relayer |
Name | Example value | Comment |
|---|---|---|
evmStats | - | List of data related to the evm actions |
chainId | 1 | Id of the chain |
potentialConfirmed | 2047 | Number of potential events confirmed |
relayConfirmed | 1801 | Actual number of events confirmed |
frozenStake | 258917.752572214000 | Frozen stake of the relayer |
latestReward | 0 | Reward acquired from the last round |
potentialTotalConfirmed | 20 | Total number of potential events confirmed |
relayTotalConfirmed | 7291 | Actual total number of confirmed events |
successfulRounds | 18 | Rounds that ended successfully for the certain relayer |
totalCountRounds | 20 | Total number of rounds relayer participated in |
totalReward | 8800.73179149 | Total amount of reward the relayer acquired |
untilFrozen | 1661463628000 | Date time until the stake will be frozen |
app.post('/relays_pages/relay_info', (req, res) => {
axios({
method: 'post',
url: `${apiUrl}/relays_pages/relay_info`,
data: {
relayAddress: req.body.relayAddress
}
})
.then(function (response) {
res.send(response.data)
})
.catch(function(error){
console.error(error)
res.send('Error')
})
})
post
https://api.octusbridge.io/v1/relays_pages
/relay_round_info
Get relayer round info
This function use to get validation round info.
It can be used for showing a relayer’s efforts in one specific round.
Following data about the relayer’s performance based on the round number can be displayed:
How much a relayer staked to become a relayer, number of events he confirmed, volume from all the transfers relayer validated happened from everscale to ethereum network and vice versa shown in USDTs, round address, start and end time of the round.
Required body parameters:
Name | Example value | Comment |
|---|---|---|
relayAddress | 0:daacff0f136da1d5c9fa73200d481362c44756b0ff7d083ee02e95f00a078557 | Address of the desired relayer |
Name | Example value | Comment |
|---|---|---|
endTime | 1654604726000 | Date time of the validation round’s end |
ethToTonUsdt | 6119978.1405 | Total amount of ethereum tokens in USDT swapped to everscale tokens and transferred |
eventsConfirmed | 661 | Total number of events the relayer confirmed in the current round |
evmStats | : [ | List of data related to the evm events |
chainId | 1 | Id of the chain |
potentialConfirmed | 144 | Number of potential events confirmed |
relayConfirmed | 143 | Number of actual events confirmed |
relayAddress | 0:daacff0f136da1d5c9fa73200d481362c44756b0ff7d083ee02e95f00a078557 | Address of the relayer |
relayPlace | 1 | Place of the relayer |
roundAddress | 0:20e866e80bb8ded0ad14f7317a58b05d378fd108306aafed64650465cd68b19e | Address of the round certain relayer is participating in |
roundNum | 15 | Round number |
stake | 258917.752572214000 | Amount relayer staked to become one of the participants |
startTime | 1653999926000 | Date time of round start |
tonToEthUsdt | 5567068.9741 | Total amount of everscale tokens in USDT swapped to ethereum tokens and transferred |
totalRoundConfirms | 695 | Number of total confirms in the monitored round |
eventsConfirmedShare | 0.9511 | Share of the relayer per event confirmed |
app.post('/relays_pages/relay_round_info', (req, res) => {
axios({
method: 'post',
url: `${apiUrl}/relays_pages/relay_round_info`,
data: {
relayAddress: req.body.relayAddress,
roundNum: req.body.roundNum
}
})
.then(function (response) {
res.send(response.data)
})
.catch(function(error){
console.error(error)
res.send('Error')
})
})
post
https://api.octusbridge.io/v1/relays_pages
/relays_round_info
Get relayers round info
This function returns list of relayers and details about them based on the round number they are part of.
Can be used for listing all or certain number of relayers when it comes to one validation round.
Some of the details about the relayers are number of confirmed events and the share per event, relay’s address, list of events, place of a relayer and also info about the round such as start and end time, round number and address, etc.
Required body parameters:
Name | Example value | Comment |
|---|---|---|
limit | 10 | Maximum number of relayers to be retrieved |
offset | 0 | Offset |
ordering | stakeascending | Value based on which the retrieved relayer data will be ordered (stakeascending, stakedescending…) |
roundNum | 15 | Round number |
Name | Example value | Comment |
|---|---|---|
relays | : [ | List of relays participating in the given round, determined by the amount set in the limit body parameter |
endTime | 1654604726000 | Date time of the validation round’s end |
ethToTonUsdt | 5567068.9741 | Total amount of ethereum tokens in USDT swapped to everscale tokens and transferred |
eventsConfirmed | 661 | Total number of events the relayer confirmed in the current round |
eventsConfirmedShare | 0.9511 | Share of the relayer per event confirmed |
evmStats | : [] | List of data related to the evm events |
chainId | 0 | Id of the chain |
potentialConfirmed | 0 | Number of potential events confirmed |
relayConfirmed | 0 | Number of actual events confirmed |
relayAddress | 0:ef79b4aac06c33ab3435943d196de9ba9ee48a3e4572c86a8ad3a2bf84b4f767 | Address of the relayer |
relayPlace | null | Place of the relayer |
roundAddress | 0:20e866e80bb8ded0ad14f7317a58b05d378fd108306aafed64650465cd68b19e | Address of the round certain relayer is participating in |
roundNum | 15 | Round number |
stake | 100000 | Amount relayer staked to become one of the participants |
startTime | 1653999926000 | Date time of round start |
tonToEthUsdt | 5567068.9741 | Total amount of everscale tokens in USDT swapped to ethereum tokens and transferred |
totalRoundConfirms | 695 | Number of total confirms in the monitored round |
totalCount | 23 | Total number of relayers participating in the round with given round number |
app.post('/relays_pages/relays_round_info', (req, res) => {
axios({
method: 'post',
url: `${apiUrl}/relays_pages/relays_round_info`,
data: {
limit: req.body.limit,
offset: req.body.offset,
ordering: req.body.ordering,
roundNum: req.body.roundNum
}
})
.then(function (response) {
res.send(response.data)
})
.catch(function(error){
console.error(error)
res.send('Error')
})
})
post
https://api.octusbridge.io/v1/relays_pages
/all_relay_ronds_info
Get all validation rounds info
This function returns all validation relay rounds in which specified relayer took part in.
It can be used for monitoring a relayer's activity and history by retrieving data such as details about events and share per event, round details, relayer’s place and stake, etc. only by inputting relayer’s address.
Required body parameters:
Name | Example value | Comment |
|---|---|---|
limit | 10 | Maximum number of relayers to be retrieved |
offset | 0 | Offset |
ordering | roundnumascending | Value based on which the retrieved relayer data will be ordered (stakeascending, stakedescending…) |
userAddress | 0:daacff0f136da1d5c9fa73200d481362c44756b0ff7d083ee02e95f00a078557 | Address of the relayer |
Name | Example value | Comment |
|---|---|---|
evmStats | [] | List of data related to the evm events |
chainId | 0 | Id of the chain |
potentialConfirmed | 0 | Number of potential events confirmed |
relayConfirmed | 0 | Number of actual events confirmed |
relayAddress | 0:aacff0f136da1d5c9fa73200d481362c44756b0ff7d083ee02e95f00a078557 | Address of the relayer |
relayPlace | null | Place of the relayer |
roundAddress | 0:77f4e7eb93d7fb3432f297782f2cd2e5fb2a62bb05d8a9590ea54c6ab954254d | Address of the round certain relayer is participating in |
roundNum | 1 | Round number |
stake | 244636 | Amount relayer staked to become one of the participants |
startTime | 1645303857000 | Date time of round start |
tonToEthUsdt | 573326.1229 | Total amount of everscale tokens in USDT swapped to ethereum tokens and transferred |
totalRoundConfirms | 108 | Number of total confirms in the monitored round |
totalCount | 18 | Number of validation rounds in which the desired relayer takes part |
app.post('/relays_pages/all_relay_rounds_info', (req, res) => {
axios({
method: 'post',
url: `${apiUrl}/relays_pages/all_relay_rounds_info`,
data: {
limit: req.body.limit,
offset: req.body.offset,
ordering: req.body.ordering,
userAddress: req.body.userAddress
}
})
.then(function (response) {
res.send(response.data)
})
.catch(function(error){
console.error(error)
res.send('Error')
})
})
post
https://api.octusbridge.io/v1/relays_pages
/round_info
Get validation round info
This function returns basic information about relayers based on their addresses, round number and stake.
It can be used for filtering rounds based on their number and showing information about them such as stake and stake changes, information about events, relayers and change in number of them, amount of USDTs transferred through the round duration.
Required body parameters:
Name | Example value | Comment |
|---|---|---|
roundNum | 10 | Round number |
Name | Example value | Comment |
|---|---|---|
averageRelayStake | 106213.02883900 | Average relayers stake |
averageRelayStakeChange | -0.5300 | Change of the average relayers stake in percentage |
ethToTonUsdt | 5204152.7479 | Total amount of ethereum tokens in USDT swapped to everscale tokens and transferred |
eventsConfirmed | 603 | Total number of events the relayer confirmed in the current round |
evmStats | : [ | List of data related to the evm events |
chainId | 1 | Id of the chain |
potentialConfirmed | 142 | Number of potential events confirmed |
relayConfirmed | 0 | Number of actual events confirmed |
relaysCount | 24 | Total number of relayers in the desired round |
relaysCountChange | 9.0900 | Change of number of relayers participating in the round in percentage |
roundNum | 10 | Round number |
tonToEthUsdt | 6007826.4910 | Total amount of everscale tokens in USDT swapped to ethereum tokens and transferred |
totalStake | 2549112.692146446000 | Sum of all the stakes relayers invested in the round |
totalStakeChange | 8.5100 | Change of total stake invested in percentage |
app.post('/relays_pages/round_info', (req, res) => {
axios({
method: 'post',
url: `${apiUrl}/relays_pages/round_info`,
data: {
roundNum: req.body.roundNum
}
})
.then(function (response) {
res.send(response.data)
})
.catch(function(error){
console.error(error)
res.send('Error')
})
})
post
https://api.octusbridge.io/v1/relays_pages
/search/relays
Get relayers info
This function **** returns basic information about relayers based on their addresses, round number and stake.
Required body parameters:
Name | Example value | Comment |
|---|---|---|
createdAtGe | 0 | Value representing bottom border of the date time relayer was created |
createdAtLe | 0 | Value representing top border of the date time relayer was created |
limit | 10 | Maximum number of relayers to be retrieved |
offset | 0 | Offset |
ordering | stakeascending | Value based on which the retrieved relayer data will be ordered (stakeascending, stakedescending) |
relayAddresses | 0:79fc8ce8d32211a4c49adf7de1c9c0fa682ff3a13124ff027f6b92faa308ffeb | List of relayers (addresses) |
roundNum | 10 | Round number |
stakeGe | 50 | Bottom border of the stake amount relayer invested for participating in the round |
stakeLe | 1000000 | Top border of the stake amount relayer invested for participating in the round |
transferContractAddress | 0:cbd090198d22e4b1a77227ba2bff58a05a32049ef2908aebfb461cacd6a474c8 | Address of the transfer contract |
Parameters used for the test:
Name | Value |
|---|---|
limit | 10 |
offset | 0 |
ordering | stakeascending |
Name | Example value | Comment |
|---|---|---|
relays | : [ | List of relays participating in specified round and specified transfer |
createdAt | 1651074897000 | Date time of becoming a relayer |
currentRound | true | True if search refers to a current round, false if not |
potentialTotalConfirmed | 4749 | Number of potential events confirmed |
relayAddress | 0:099341ccbe3f2db59432fc1cc794773b9da06048d14e43ae24ae224dd768145d | Address of the relayer |
relayTotalConfirmed | 4056 | Actual number of events confirmed by a relayer |
slashed | false | True if a relayer was slashed, false if not |
stake | 100000 | Amount relayer staked for participating in the round |
successfulRounds | 10 | Number of successful validation relay rounds of a relayer |
totalRounds | 10 | Number of all rounds relayer participated in |
totalCount | 27 | Total number of records retrieved based on the relayers’ addresses given and transaction contract’s address for the specified round |
app.post('/relays_pages/search/relays', (req, res) => {
axios({
method: 'post',
url: `${apiUrl}/relays_pages/search/relays`,
data: {
createdAtGe: req.body.createdAtGe,
createdAtLe: req.body.createdAtLe,
limit: req.body.limit,
offset: req.body.offset,
ordering: req.body.ordering,
relayAddresses: req.body.relayAddresses,
roundNum: req.body.roundNum,
stakeGe: req.body.stakeGe,
stakeLe: req.body.stakeLe,
transferContractAddress: req.body.transferContractAddress
}
})
.then(function (response) {
res.send(response.data)
})
.catch(function(error){
console.error(error)
res.send('Error')
})
})
post
https://api.octusbridge.io/v1/relays_pages
/search/relays_events
Get relayer
This function returns details about relayer’s events based on the chain id of the event, kind of transfer, receiver’s address, sender’s address, token address, relayer’s address, contract’s address, round number.
It can be used for filtering all the events based on the required parameters and displaying them in the list form along with information such as amount transferred, chain id, sender’s address, receiver’s address, token address etc.
Required body parameters:
Name | Example value | Comment |
|---|---|---|
amountGe | 0 | Bottom border of the transferred amount |
amountLe | 10000000000000000 | Top border of the transferred amount |
chainId | 1 | Id of the event’s chain |
ethUserAddress | 0xcbefe3344284444ac8141c930207b8ff82a3177e | User address on the ethereum network |
limit | 10 | Maximum number of relayers to be retrieved |
offset | 0 | Offset |
ordering | amountascending | Value based on which the retrieved relayer data will be ordered |
relayAddress | - | Address of the relayer |
roundNum | 18 | Round number |
timestampGe | 1642813200000 | Bottom border of the date time of the transfer |
timestampLe | 1656032400000 | Top border of the date time of the transfer |
tokenAddress | 0:a519f99bb5d6d51ef958ed24d337ad75a1c770885dcd42d51d6663f9fcdacfb2 | Address of the transferred token |
tonUserAddress | 0:1fcdda0bdb6cc28476575f1617949188fb9f29d35b9f86217438baf3519058c3 | User address on the everscale network |
transferContractAddress | 0:91b879d842d2292db57abd10d1cd6e83959dd27fb70189d02032314c0de542a9 | Address of the transfer contract |
transferKind | ethtoton | Transfer kind (tontoeth, ethtoton) |
Name | Example value | Comment |
|---|---|---|
relays | :[ | List of relays participating in specified round and specified transfer |
amount | 90000 | Amount of transfer |
chainId | 1 | Id of the event’s chain |
contractAddress | 0:91b879d842d2292db57abd10d1cd6e83959dd27fb70189d02032314c0de542a9 | Address of the transfer contract |
from | 0xcbefe3344284444ac8141c930207b8ff82a3177e | Address of the sender |
timestamp | 1655983612000 | Date time of the transfer |
to | 0:1fcdda0bdb6cc28476575f1617949188fb9f29d35b9f86217438baf3519058c3 | Address of the receiver |
tokenAddress | 0:a519f99bb5d6d51ef958ed24d337ad75a1c770885dcd42d51d6663f9fcdacfb2 | Address of the transferred token |
transferKind | ethtoton | Transfer kind (tontoeth, ethtoton) |
totalCount | 18 | Total number of relays participating in the transfer |
app.post('/relays_pages/search/relays_events', (req, res) => {
axios({
method: 'post',
url: `${apiUrl}/relays_pages/search/relays_events`,
data: {
amountGe: req.body.amountGe,
amountLe: req.body.amountLe,
chainId: req.body.chainId,
ethUserAddress: req.body.ethUserAddress,
limit: req.body.limit,
offset: req.body.offset,
ordering: req.body.ordering,
relayAddress: req.body.relayAddress,
roundNum: req.body.roundNum,
timestampGe: req.body.timestampGe,
timestampLe: req.body.timestampLe,
tokenAddress: req.body.tokenAddress,
tonUserAddress: req.body.tonUserAddress,
transferContractAddress: req.body.transferContractAddress,
transferKind: req.body.transferKind
}
})
.then(function (response) {
res.send(response.data)
})
.catch(function(error){
console.error(error)
res.send('Error')
})
})
post
https://api.octusbridge.io/v1/relays_pages
/search/global_relays_events
Get global relayer
This function returns details about relayer’s events based on the chain id of the event, kind of transfer, receiver’s address, sender’s address, token address, relayer’s address, contract’s address, round number.
It can be used for filtering all the events based on the required parameters and displaying them in the list form along with information such as amount transferred, chain id, sender’s address, receiver’s address, token address etc.
Required body parameters:
Name | Example value | Comment |
|---|---|---|
amountGe | 0 | Bottom border of the transferred amount |
amountLe | 10000000000000000 | Top border of the transferred amount |
chainId | 1 | Id of the event’s chain |
ethUserAddress | 0xcbefe3344284444ac8141c930207b8ff82a3177e | User address on the ethereum network |
limit | 10 | Maximum number of relayers to be retrieved |
offset | 0 | Offset |
ordering | amountascending |