Sinä
Kehittäjille

Poolin API

Jokainen HeroMiners-pooli vastaa samoihin vain luku -tyyppisiin HTTP-päätepisteisiin. Ei avainta, ei tiliä eikä rekisteröitymistä: pyydä URL ja saat takaisin JSONia, ja Access-Control-Allow-Origin: * on asetettu, joten selaimessa oleva sivu voi kutsua sitä suoraan. Rakenna sen avulla rigien valvonta, tilitysilmoittaja, oma koontinäyttö tai tuo poolin tiedot laskentataulukkoon.

Syötä osoitteesi, niin jokainen alla oleva esimerkki on valmis ajettavaksi tätä poolia vastaan. Mitään tähän kirjoittamaasi ei lähetetä muualle kuin pooliin itseensä, ja vain kun painat Suorita.

Perus-URL
https://quantus.herominers.com

Päätepisteet

GET /api/stats

Kaikki, mitä pooli tietää itsestään juuri nyt: poolin ja verkon hashrate, yhdistetyt louhijat ja workerit, viimeisin lohko, maksut, portit ja tilitysasetukset.

Parametrit
address
Tilitysosoite. Lisää kyseisen louhijan kohtaan miner ja kohtaan solo_miner, jos hän louhii myös soolona. Jos se jätetään pois, kumpaakaan avainta ei lähetetä.

Aloita tästä päätepisteestä. Poolin sivu, louhijasivu ja jokainen tämän sivuston kaavio on rakennettu sen pohjalta.

Pyyntö
curl "https://quantus.herominers.com/api/stats"
Vastaus

Objekti, jossa on pool, network, config, charts, lastblock, payments ja visitors, eli kuinka monta ihmistä sivustolla on juuri nyt, muodossa { windowMinutes, activeVisitors, activeLookups }. Lasketaan uudelleen kerran tilastokierroksessa, joten tiheämpi kysely palauttaa samat luvut.

GET /api/live_stats

Sama sisältö kuin /api/stats, mutta pyyntö pidetään auki, kunnes seuraava tilastokierros valmistuu, ja vastataan sitten. Yksi pyyntö päivitystä kohden ajastetun kyselyn sijaan.

Parametrit
address
Sisällytä louhija vastaukseen, kuten /api/stats-päätepisteessä.

Avaa yksi yhteys ja avaa se uudelleen, kun se vastaa. Useampi samanaikainen yhteys samasta IP:stä hylätään koodilla 503, joten älä avaa niitä rinnakkain.

Pyyntö
curl "https://quantus.herominers.com/api/live_stats"
Vastaus

Sama rakenne kuin /api/stats, paitsi että miner ja solo_miner lähetetään aina, tyhjinä jos osoitetta ei annettu. Pyyntö pysyy auki enintään yhden tilastokierroksen ajan.

GET /api/stats_address

Yksi louhija: nykyinen ja keskimääräinen hashrate, kelvolliset ja stale sharet, saldo, maksettu summa sekä samat luvut workereittain.

Parametrit
addresspakollinen
Haettava tilitysosoite.
Pyyntö
curl "https://quantus.herominers.com/api/stats_address"

Syötä yllä address suorittaaksesi tämän. Komento näyttää sen, koska pooli vastaa ilman sitä virheellä.

Vastaus

Objekti, jossa on stats (louhijan kokonaisluvut), payments, charts, unlocked ja workers, taulukko, jossa on yksi merkintä kutakin workeria kohden sen name-kentän mukaan nimettynä. Osoite, joka ei ole koskaan louhinut täällä, saa virheen tyhjän louhijan sijaan.

GET /api/get_blocks

Poolin löytämät lohkot, jotka eivät enää odota: tilitetyt tai orvot. status kertoo kumpi.

Parametrit
heightpakollinen
Palauta lohkot tämän korkeuden alapuolelta. Anna ketjun kärkeä paljon suurempi luku uusinta sivua varten ja sitten pienin saamasi korkeus selataksesi taaksepäin.

Löytäjän osoite peitetään ennen kuin se lähtee poolista, joten tällä päätepisteellä ei voi kerätä osoitteita. time on Unix-sekunteina, reward kolikon pienimpänä yksikkönä, ja soololohkon score on s0, kun se tilitettiin, tai s1, kun siitä tuli orpo.

Pyyntö
curl "https://quantus.herominers.com/api/get_blocks?height=9999999999"
Vastaus

Litteä taulukko, jossa vuorottelevat arvo ja korkeus: [block, height, block, height, ...]. Jokainen lohko on kaksoispisteillä eroteltu:

0hash1time2difficulty3shares4score5nonce6status7reward8finder9region10rewardScheme
GET /api/get_payments

Poolin lähettämät tilitykset joko koko poolista tai yhdelle osoitteelle.

Parametrit
timepakollinen
Palauta tilitykset ennen tätä Unix-aikaleimaa sekunteina. Käytä nykyhetkeä uusinta sivua varten ja sitten vanhinta saamaasi aikaleimaa selataksesi taaksepäin.
address
Rajaa yhteen tilitysosoitteeseen. Jätä pois saadaksesi kaikki poolin tekemät tilitykset.
limit
Kuinka monta palautetaan. Rajataan poolin omaan sivukokoon, joten suurempi luku palauttaa vain sen verran.
format
Anna parsed saadaksesi { tx, amount, time }-objekteja raakataulukon sijaan.
conversions
Yhdessä address-parametrin kanssa anna 1 saadaksesi myös vaihtotiedot jokaisesta sivun tilityksestä, joka vaihdettiin toiseen kolikkoon. Vastaus on silloin { payments, conversions }. Ohitetaan, kun käytössä on format=parsed.
Pyyntö
curl "https://quantus.herominers.com/api/get_payments?time=1792922073"
Vastaus

Ilman format-parametria litteä taulukko, jossa vuorottelevat arvo ja aikaleima, ja jokainen arvo on txid:amount. Summat ovat merkkijonoja kolikon pienimpänä yksikkönä, ja niiden on pysyttävä merkkijonoina: luvuksi jäsennettynä tarkkuutta katoaa ketjussa, jossa on 18 desimaalia.

GET /api/get_miners_stats

Poolin kymmenen suurinta louhijaa sekä louhijasivun taustalla olevat jakaumat louhintaohjelmittain ja alueittain.

Pyyntö
curl "https://quantus.herominers.com/api/get_miners_stats"
Vastaus

Objekti, jossa on miners, agents, regions, regionHistory ja statsDisplay. Osoitteet on peitetty. Kun paneeli ei ole käytössä, sen taulukko palautuu tyhjänä ja statsDisplay kertoo sen.

GET /api/get_blocks_search_config

Onko lohkohaku käytössä ja mihin rajoihin haun on mahduttava, jotta hakukentän voi määrittää ennen ensimmäistä hakua.

Pyyntö
curl "https://quantus.herominers.com/api/get_blocks_search_config"
Vastaus

{ enabled, minQueryLength, maxQueryLength, frontendCooldownMs }. Pituudet ovat merkkeinä, ja frontendCooldownMs kertoo, kuinka kauan kahden haun välillä on odotettava.

GET /api/get_miner_payout_level

Osoitteelle tällä hetkellä asetettu tilitysraja kokonaisina kolikkoina.

Parametrit
addresspakollinen
Tilitysosoite.

Vastaava /api/set_miner_payout_level kirjoittaa sen, eikä se ole kaikkien käytettävissä: pyynnön on tultava osoitteen omasta louhinta-IP:stä. Tämä tarkistus ja sen edessä oleva pyyntöraja kuvataan koontinäytön asetusvälilehdellä eikä tässä.

Pyyntö
curl "https://quantus.herominers.com/api/get_miner_payout_level"

Syötä yllä address suorittaaksesi tämän. Komento näyttää sen, koska pooli vastaa ilman sitä virheellä.

Vastaus

{ status: "done", level }. Osoite, joka ei ole koskaan asettanut rajaa, saa poolin vähimmäisarvon.

GET /api/miner_ban_status

Estoilmoitus, jonka louhijasivu näyttää osoitteelle, sekä mahdollinen ylläpitäjän sille jättämä viesti.

Parametrit
addresspakollinen
Tilitysosoite.
Pyyntö
curl "https://quantus.herominers.com/api/miner_ban_status"

Syötä yllä address suorittaaksesi tämän. Komento näyttää sen, koska pooli vastaa ilman sitä virheellä.

Vastaus

{ banned, minerMessage }, ja eston ollessa voimassa myös blockMining, blockPayments ja reason. Se on ilmoitus, jonka louhijasivu näyttää tälle osoitteelle: estetty louhimasta, saamasta tilityksiä tai ei kumpaakaan. minerMessage on ylläpitäjän viesti tälle osoitteelle muodossa { message, type, createdAt, expiresAt }, tai null, kun viestiä ei ole.

Hyviä käytäntöjä

  • Kysy poolin omassa tahdissa. Luvut lasketaan uudelleen kerran tilastokierroksessa, ja /api/stats-vastauksen config.updateInterval kertoo sen pituuden sekunteina. Tiheämpi kysely palauttaa saman vastauksen ja kuluttaa meidän molempien kaistaa.
  • Suosi /api/live_stats-päätepistettä nopean ajastimen sijaan. Se vastaa heti, kun on jotain uutta, mikä on sekä sinulle nopeampaa että poolille kevyempää kuin toistuva kysely.
  • Pidä summat merkkijonoina. Palkkiot ja saldot palautetaan kolikon pienimpänä yksikkönä. Ketjussa, jossa on 18 desimaalia, nämä kokonaisluvut ylittävät sen, mitä JavaScript-luku voi esittää tarkasti, joten jäsentäminen pyöristää tilityksen huomaamatta.
  • Varaudu peitettyihin osoitteisiin. Julkiset listat piilottavat jokaisen osoitteen keskiosan. Omaa koko osoitettasi tarvitset vain sinä, ja vain siellä, missä annat sen itse.
  • Käsittele pyyntöraja odotuksena, ei virheenä. Kun raja on voimassa, vastauksessa on retryMs. Odota sen verran ja yritä uudelleen sen sijaan, että pommitat poolia.
  • Kerro, kuka olet. Työkalusi nimeävä User-Agent ei ole pakollinen, mutta sen avulla voimme kertoa sinulle muutoksesta, eikä sinun tarvitse arvailla, mikä meni rikki.