GET/infoPubblico
Fornisce un elemento contenente una descrizione delle funzionalità e informazioni di contesto sul server di trasferimento SEP-6. Conforma le definizioni ufficiali di Stellar SEP-6 descritte qui.
Sviluppatori
Documentazione APIGET /info
GET /deposit
GET /withdraw
GET /transaction
GET /transactions
Trasparenza
Prova delle RiserveInizia
Il SEP-6 di Stellar (Stellar Ecosystem Proposal 6) definisce il protocollo per la creazione di un ponte conforme tra la rete Stellar e altre blockchain o reti bancarie. Ciò consente che gli asset basati su Stellar siano facilmente depositati e prelevati dal conto Stellar di un utente utilizzando transazioni regolari sulla blockchain o bancarie.
Il SEP-6 garantisce che questi processi siano standardizzati, semplificando così agli sviluppatori di portafogli e ad altri integratori di Stellar l'aggiunta di supporto per più ancoraggi senza dover adattare la propria implementazione per ognuno di essi. Esso fornisce un insieme definito di endpoint API e comportamenti attesi, insieme a una specifica su come gli asset dovrebbero essere rappresentati.
È importante notare che il SEP-6 fa parte di una più ampia serie di Proposte per l'Ecosistema Stellar (SEP), ciascuna delle quali definisce un componente specifico dell'ecosistema Stellar, mirando a garantire che l'intera rete rimanga interoperabile e standardizzata.
Whalestack SEP-6
Questo servizio di trasferimento SEP-6 di Stellar ti consente di tokenizzare (depositare) e detokenizzare (prelevare) Bitcoin e Litecoin sulla rete Stellar. Accedici programmaticamente o effettua depositi e prelievi utilizzando la nostra interfaccia web.
Gli Asset di Whalestack
Gli asset sulla rete Stellar sono rappresentazioni digitali (tokenizzate) di qualsiasi cosa abbia un valore.
Whalestack emette asset per Bitcoin e Litecoin come elencato di seguito. Mostra altro.
Trasparenza
Whalestack dà priorità alla piena trasparenza con il suo server di trasferimento SEP-6. Tutte le transazioni sono apertamente verificabili. Per la tua tranquillità, divulghiamo dettagli come l'offerta circolante, gli indirizzi del portafoglio hot e cold , le specifiche dell'account, gli ID delle transazioni blockchain e i saldi. I fondi in nostra custodia rimangono in modo sicuro all'interno dei nostri portafogli hot o cold, utilizzati esclusivamente per i trasferimenti SEP-6.
For Developers
Il SEP-6 di Stellar offre un modo standardizzato per varie applicazioni Stellar, che siano portafogli, scambi o utenti finali, di interagire in modo fluido con gli emittenti di asset, che siano chiamati ancoraggi, ponti o rampe. Per una visione completa dell'implementazione SEP-6 di Whalestack, consulta la nostra documentazione per sviluppatori.
Market Makers e Arbitrageurs
Gli asset di Whalestack sono completamente integrati nella nostra piattaforma di elaborazione dei pagamenti. Ciò assicura un flusso costante di traffico verso le pool di liquidità, generando così commissioni di conversione e stimolando opportunità di arbitraggio. Approfondisci la nostra documentazione sulla pool di liquidità o contattaci per ulteriori informazioni.
Linee Fiduciarie
Per interagire con il nostro server di trasferimento SEP-6, assicurati di avere un conto Stellar finanziato e di aver stabilito linee di credito per l'asset desiderato. In modo significativo, il nostro servizio SEP-6 è senza autorizzazioni, quindi non è necessaria l'autenticazione o persino un account Whalestack per iniziare.
Asset Whalestack
Gli asset sono rappresentazioni digitali (tokenizzate) di qualsiasi cosa abbia valore sulla Stellar Network. Sono tipicamente supportati da valute fiat o criptovalute. Whalestack emette asset per Bitcoin e Litecoin come elencato di seguito. Si prega di notare che l'unico dominio web ufficiale e valido dell'emittente Whalestack è whalestack.com.
BTC:GCQVEST7KIWV3KOSNDDUJKEPZLBFWKM7DUS4TCLW2VNVPCBGTDRVTEIT
| Info Depositi | Info Prelievo |
|
Importo minimo: 0.0005 BTC Importo Massimo: 100 BTC Tariffa (fissa): 0 BTC Commissione (percentuale): 0 % |
Importo minimo: 0.0005 BTC Importo Massimo: 100 BTC Tariffa (fissa): 0 BTC Commissione (percentuale): 0 % |
Linee Fiduciarie
Sulla rete Stellar, quando utilizzi un asset SEP-6, stai fondamentalmente affidandoti al fornitore di servizi, come Whalestack, per gestire in modo sicuro i tuoi depositi e rispettare i prelievi. Questa nozione di fiducia è incorporata in Stellar attraverso il concetto di trustline. Le trustline sono marcatori aggiunti al tuo account Stellar che ti consentono di detenere un token specifico. Essi delineano la quantità massima di quel token che sei disposto a detenere.
Per negoziare, ricevere o anche detenere qualsiasi asset sulla rete Stellar, è obbligatoria una trustline con l'account emittente dell'asset. Questo account emittente si riferisce all'account Stellar del fornitore di servizi che ha originato l'asset. Le trustline vengono create tramite l'operazione di modifica della fiducia, e ognuna comporta una tassa di riserva di base di 0,5 XLM. Essenzialmente, per ogni trustline che crei, è obbligatoria una riserva di 0,5 XLM che non può essere spesa fino a quando la trustline non viene sciolta.
Asset Forniti da Whalestack
Per impostare trustline, avrai bisogno del codice dell'asset, dell'account dell'emittente e talvolta del dominio dell'emittente, come descritto di seguito.
Bitcoin (Su Stellar)
Dominio Emittente: whalestack.com
BTC:GCQVEST7KIWV3KOSNDDUJKEPZLBFWKM7DUS4TCLW2VNVPCBGTDRVTEIT
Aggiungi la Trustline tramite Portafogli
Molti portafogli e exchange Stellar presentano interfacce intuitive che agevolano l'aggiunta e la rimozione di trustline per vari asset. Piattaforme rinomate su Stellar includono Freighter, Albedo, xBull, StellarX, Rabet, Lumenswap, Scopuly, LOBSTR e StellarTerm. Per coloro che cercano un approccio personalizzato, il Stellar Laboratory fornisce strumenti per creare in modo sicuro operazioni personalizzate di modifica della fiducia.
È importante sottolineare che non avalliamo alcun servizio esterno. Sosteniamo l'utilizzo di approcci programmabili (dettagliati di seguito) o l'uso del Stellar Laboratory.
L'Aggiunta di Trustline in modo Programmatico
Se desideri aggiungere in modo programmatico una trustline, assicurati di avere accesso a uno dei SDK Stellar, un account Stellar finanziato sufficientemente insieme alla sua chiave segreta, e le linee di codice per implementare l'operazione di modifica della fiducia. Ecco uno snippet JavaScript che illustra l'aggiunta di trustline per gli asset Stellar Bitcoin e Litecoin di Whalestack. Ricorda, se hai l'intenzione di eliminare una trustline in seguito, imposta il parametro di limite della trustline nell'operazione a 0, dopo aver azzerato eventuali bilanci dell'asset.
Node JS
const sdk = require('stellar-sdk');
const server = new sdk.Horizon.Server('https://horizon.stellar.org');
// Whalestack's Assets
const BtcAsset = new sdk.Asset('BTC', 'GCQVEST7KIWV3KOSNDDUJKEPZLBFWKM7DUS4TCLW2VNVPCBGTDRVTEIT');
const LtcAsset = new sdk.Asset('LTC', 'GCQVEST7KIWV3KOSNDDUJKEPZLBFWKM7DUS4TCLW2VNVPCBGTDRVTEIT');
(async function main() {
const keyPair = sdk.Keypair.fromSecret(process.env.secretKey);
const account = await server.loadAccount(keyPair.publicKey());
const fee = await server.fetchBaseFee();
const transaction = new sdk.TransactionBuilder(account, {
fee, networkPassphrase: sdk.Networks.PUBLIC
})
.addOperation(
sdk.Operation.changeTrust({
source: keyPair.publicKey(),
asset: BtcAsset,
amount: "922337203685.4775807"
})
)
.addOperation(
sdk.Operation.changeTrust({
source: keyPair.publicKey(),
asset: LtcAsset,
amount: "922337203685.4775807"
})
)
.setTimeout(30)
.build();
// sign the transaction
transaction.sign(keyPair);
try {
const transactionResult = await server.submitTransaction(transaction);
console.log(transactionResult);
} catch (e) {
console.error(e.message);
}
})()
Riserva di Liquidità
Partecipare alle pool di liquidità è aperto e senza necessità di autorizzazioni. Le principali pool di liquidità di Whalestack sono XLM/BTC e BTC/LTC. Queste pool entrano principalmente in gioco durante le transazioni di scambio di asset su Whalestack. La nostra selezione di queste coppie è duplice: Innanzitutto, sono coppie di trading riconosciute su scambi centralizzati mainstream, facilitando la mappatura dell'arbitraggio. In secondo luogo, questa scelta assicura che BTC e LTC abbiano sempre una via per raggiungere altri asset significativi sulla rete tramite XLM.
84cf93f8d1c22e150b8f0022b3c9a39d03976da6b5143818327bf298358ce5e7
Ruolo dei Market Maker e degli Arbitraggisti
Sulla piattaforma Whalestack, azioni come checkouts, depositi, swap e prelievi attingono alla liquidità delle suddette pool ogni volta che si verifica uno scambio di asset. Più frequentemente, questo scambio avviene tra Bitcoin o Litecoin e una stablecoin fiat, come ad esempio USDC. Di conseguenza, la piattaforma Whalestack genera in modo consistente un traffico unidirezionale nelle pool, aprendo la strada a opportunità di arbitraggio. Inoltre, il trading pubblico generale sulla rete Stellar consuma liquidità e contribuisce al volume delle transazioni. Se sei un market maker o un arbitraggista, ti invitiamo a approfondire e a coinvolgerti con noi.
Coinvolgersi con le Pool di Liquidità
Prima di immergerti, consigliamo di familiarizzare con i concetti delle pool di liquidità e di comprendere i rischi associati alla perdita temporanea. Alcune risorse interessanti includono: Liquidity, Liquidity, Liquidity, Introducing Automated Market Makers on Stellar e AMMs in the Stellar Ecosystem.
La partecipazione alle pool di liquidità non richiede autorizzazioni. Per coinvolgerti in modo efficace, devi stabilire una trustline per gli asset e le rispettive pool di liquidità. Diverse wallet Stellar, come xBull, Lumenswap, LOBSTR e StellarX, offrono interfacce per agevolare depositi e prelievi. Tuttavia, non approviamo formalmente alcune piattaforme di terze parti. Consigliamo di coinvolgersi direttamente con le pool programmaticamente o tramite il Laboratorio Stellar per mantenere il pieno controllo sulle chiavi, la sicurezza e la personalizzazione.
Indicazioni per gli Sviluppatori
La Stellar Development Foundation ha documentato meticolosamente le sfumature della partecipazione programmata alle pool di liquidità. Suggeriamo di fare riferimento a questa guida completa. Questo include esempi che vanno dalla creazione e deposito fino a prelievi e monitoraggio delle pool di liquidità.
Deposito
Tokenizzare e depositare Bitcoin o Litecoin sulla Rete Stellar.
Prelievo
Detokenizza gli asset Bitcoin o Litecoin su Stellar e li riscatta sulla loro blockchain originaria.
Stato Transazione
Interroga lo stato del trasferimento SEP-6 per una specifica richiesta di trasferimento o un identificativo di transazione blockchain.
Documentazione API
L'API di Trasferimento SEP-6 di Whalestack ti consente di tokenizzare (depositare) e detokenizzare (prelevare) in modo fluido Bitcoin e Litecoin sulla Stellar Network. Questa guida illustra i passaggi necessari per raggiungere tale obiettivo.
Introduzione a Stellar SEP-6
Stellar SEP-6 stabilisce un approccio standardizzato per portafogli, scambi, utenti finali e applicazioni Stellar per interfacciarsi in modo fluido con gli emittenti di asset, spesso chiamati ancore, ponti o rampe, come Whalestack. Per una comprensione approfondita, puoi consultare la sua documentazione ufficiale. Tuttavia, se stai cercando un punto di partenza conciso, abbiamo sintetizzato gli elementi essenziali per te di seguito.
Server di Trasferimento SEP-6 di Whalestack
Il server di trasferimento SEP-6 di Whalestack è ospitato su sep6.whalestack.com. L'interazione con esso è semplice: invia richieste HTTP GET e interpreta le risposte. Per facilitare ciò, utilizza un client REST adatto al tuo linguaggio di programmazione preferito (offriamo implementazioni per PHP, NodeJS, e Ruby) o utilizza strumenti come cURL o wget. In particolare, poiché tutti gli endpoint SEP-6 sono accessibili tramite HTTP GET, una finestra del browser potrebbe essere sufficiente per interazioni rudimentali. Whalestack opera sotto il dominio whalestack.com. Puoi visualizzare la nostra configurazione stellar.toml qui.
Inizia
Prima di iniziare, assicurati di possedere un account Stellar finanziato con trustline stabiliti qui per l'asset con cui intendi effettuare la transazione. La nostra implementazione SEP-6 è senza autorizzazione, eliminando la necessità di autenticazione o anche di un account Whalestack.
API Endpoints
Il server di trasferimento presenta cinque endpoint, tutti conformi alla specifica SEP-6 e accessibili tramite HTTP GET. Le specifiche dettagliate per questi endpoint possono essere esplorate qui.
/infoFornisce un oggetto descrittivo che evidenzia le funzionalità e il contesto del server di trasferimento SEP-6./depositOffre un oggetto contenente informazioni essenziali sul deposito, delineando i passaggi per trasferire fondi e ricevere asset tokenizzati su Stellar./withdrawPresenta un elemento che evidenzia le procedure di prelievo, inclusa la modalità di riscatto degli asset alla loro blockchain originaria./transactionRecupera informazioni su una transazione specifica di deposito o prelievo SEP-6./transactionsElenca tutte le transazioni associate al server di trasferimento SEP-6.
Esempi
Effettua un deposito di Bitcoin su Stellar
JavaScript
const Sep6Client = require('sep6-client');
const client = new Sep6Client('sep6.whalestack.com');
let response = await client.get('/deposit', {
'asset_code': 'BTC',
'account': 'GDONUHZKLSYLDOZWR2TDW25GFXOBWCCKTPK34DLUVSOMFHLGURX6FNU6',
'memo': 'Sent via SEP-6',
'memo_type': 'text'
});
// console.log(response.data) -> {"how":"bc1qj633nx575jm28smgcp3mx6n3gh0zg6ndr0ew23","id":"f2118ef4115642870638616a4372","eta":600,"min_amount":"0.00001","max_amount":"100.0000000","extra_info":{}}
Fornisce un indirizzo di deposito Bitcoin insieme a alcune informazioni di contesto aggiuntive documentate qui. Il Bitcoin inviato all'indirizzo di deposito ricevuto viene tokenizzato su Stellar e inviato all'account sopra indicato. Il Bitcoin tokenizzato può essere inviato e ricevuto sulla rete Stellar, scambiato con altri asset sul SDEX o depositato nei pools di liquidità di Stellar.
Prelieva Bitcoin da Stellar
JavaScript
const Sep6Client = require('sep6-client');
const client = new Sep6Client('sep6.whalestack.com');
let response = await client.get('/withdraw', {
'asset_code': 'BTC',
'dest': 'bc1qj633nx575jm28smgcp3mx6n3gh0zg6ndr0ew23'
});
// console.log(response.data) -> {"account_id":"GCQVESTEG3MY2AA4LFF2J5K77IQP4G5WZCUDOJ5RUIPA6ZKRGQ7XXKBR","memo_type":"text","memo":"010cdf0a41410d75b2797a6fa38f","id":"010cdf0a41410d75b2797a6fa38f","min_amount":"0.0005000","max_amount":"100.0000000","fee_fixed":0.0002,"fee_percent":0.2,"extra_info":{"message":"An amount above 100.0000000 will take longer to complete"}}
Restituisce un account Stellar e un memo insieme a alcune informazioni di contesto aggiuntive documentate qui. Il Bitcoin tokenizzato inviato all'account fornito viene distrutto sulla Stellar Network e rilasciato all'indirizzo Bitcoin indicato nella richiesta.
SEP-6 REST Clienti
Il server di trasferimento SEP-6 funziona con qualsiasi client REST in qualsiasi linguaggio di programmazione, e abbiamo pubblicato SDK per PHP, Ruby e NodeJS sul nostro GitHub per aiutarti a iniziare rapidamente.
Richiesta
curl 'https://sep6.whalestack.com/info'
Risposta di Successo application/json
{
"deposit":{
"BTC":{
"enabled":true,
"min_amount":0.0001,
"max_amount":100,
"fee_fixed":0,
"fee_percent":0,
"authentication_required":false
},
"LTC":{
"enabled":true,
"min_amount":0.00001,
"max_amount":10000,
"fee_fixed":0,
"fee_percent":0,
"authentication_required":false
}
},
"withdraw":{
"BTC":{
"enabled":true,
"min_amount":0.0005,
"max_amount":100,
"fee_fixed":0.0002,
"fee_percent":0.2,
"authentication_required":false,
"types":{
"crypto":{
"fields":{
"dest":{
"description":"The Bitcoin target address in any format, i.e. native SegWit (bech32), SegWit (P2SH), or legacy (P2PKH).",
"optional":false
}
}
}
}
},
"LTC":{
"enabled":true,
"min_amount":0.0005,
"max_amount":10000,
"fee_fixed":0.0002,
"fee_percent":0.2,
"authentication_required":false,
"types":{
"crypto":{
"fields":{
"dest":{
"description":"The Litecoin target address in any format, i.e. native SegWit (bech32), SegWit (P2SH), or legacy (P2PKH).",
"optional":false
}
}
}
}
}
},
"transaction":{
"enabled":true,
"authentication_required":false
},
"transactions":{
"enabled":true,
"authentication_required":false
},
"features":{
"account_creation":false,
"claimable_balances":false
},
"fee":{
"enabled":false
},
"deposit-exchange":{
"enabled":false
},
"withdraw-exchange":{
"enabled":false
},
"supply":{
"BTC":{
"circulating_supply":5.671082,
"circulating_supply_components":{
"amount":1.0399347,
"claimable_balances_amount":0,
"liquidity_pools_amount":4.6311473
},
"hotwallet_reserves":1.6826130,
"coldwallet_reserves":4.0000000,
"total_reserves":5.6826130
},
"LTC":{
"circulating_supply":318.5104129,
"circulating_supply_components":{
"amount":136.3382091,
"claimable_balances_amount":0,
"liquidity_pools_amount":182.1722038
},
"hotwallet_reserves":118.6363572,
"coldwallet_reserves":200.0000000,
"total_reserves":318.6363572
}
}
}
Caratteristiche della Risposta di Successo
| Nome | Categoria | Descrizione | Nullable |
|---|---|---|---|
deposit |
object | An object containing an associative list of assets available for deposit and additional context information about the assets. Each asset is identified by its key, which is the asset code. | false |
.ASSET_CODE |
object | An object containing context information about the asset identified in the deposit object's key attribute. | false |
.enabled |
boolean | Indicates whether deposit transactions are enabled. If set to false then this is the only attribute of the object. |
false |
.min_amount |
float | Indicates the minimum deposit amount on the /deposit endpoint. |
false |
.max_amount |
float | Indicates the maximum deposit amount on the /deposit endpoint. |
false |
.fee_fixed |
float | Indicates the fixed fee on the /deposit endpoint. In units of the deposited asset. |
false |
.fee_percent |
float | Indicates the percentage fee on the /deposit endpoint. In units of percentage points. |
false |
.authentication_required |
boolean | Indicates whether authentication for this asset is required on the /deposit endpoint. If set to true then requests must be authenticated via SEP-10. |
false |
withdraw |
object | An object containing an associative list of assets available for withdrawal and additional context information about the assets. Each asset is identified by its key, which is the asset code. | false |
.ASSET_CODE |
object | An object containing context information about the asset identified in the withdraw object's key attribute. | false |
.enabled |
boolean | Indicates whether withdrawal transactions are enabled. If set to false then this is the only attribute of the object. |
false |
.min_amount |
float | Indicates the minimum withdrawal amount on the /withdraw endpoint. |
false |
.max_amount |
float | Indicates the maximum withdrawal amount on the /withdraw endpoint. |
false |
.fee_fixed |
float | Indicates the fixed fee on the /withdraw endpoint. In units of the deposited asset. |
false |
.fee_percent |
float | Indicates the percentage fee on the /withdraw endpoint. In units of percentage points. |
false |
.authentication_required |
boolean | Indicates whether authentication for this asset is required on the /withdraw endpoint. If set to true then requests must be authenticated via SEP-10. |
false |
.types |
object | An object containing instructions for `dest` parameter on the /withdraw endpoint. |
false |
transaction |
object | An object containing information about the /transaction endpoint. |
false |
.enabled |
boolean | Indicates whether the /transaction is enabled. If set to false then this is the only attribute of the object. |
false |
.authentication_required |
boolean | Indicates whether the /transaction requires authentication. If set to true then requests must be authenticated via SEP-10. |
false |
transactions |
object | An object containing information about the /transactions endpoint. |
false |
.enabled |
boolean | Indicates whether the /transactions is enabled. If set to false then this is the only attribute of the object. |
false |
.authentication_required |
boolean | Indicates whether the /transactions requires authentication. If set to true then requests must be authenticated via SEP-10. |
false |
features |
object | An object containing information about possible additional features provided by the SEP-6 server. | false |
.account_creation |
boolean | Indicates whether the SEP-6 transfer server supports creating accounts for users requesting deposits (Whalestack does not). | false |
.claimable_balances |
boolean | Indicates whether the SEP-6 transfer server supports sending deposits as claimable balances to accounts that do not have a trustline established (Whalestack does not, a trustline is required prior to receiving a deposit address). | false |
fee |
object | An object containing information about the optional SEP-6 /fee endpoint. | false |
.enabled |
boolean | Indicates whether the /fee endpoint is enabled (in Whalestack SEP-6 it is not because we use the fee_fixed and fee_percent above in lieu of a dedicated fee endpoint). If set to false then this is the only attribute of the object. |
false |
.authentication_required |
boolean | Indicates whether the /fee requires authentication. If set to true then requests must be authenticated via SEP-10. |
false |
deposit-exchange |
object | An object containing information about the optional SEP-6 /deposit-exchange endpoint. | false |
.enabled |
boolean | Indicates whether the /deposit-exchange endpoint is enabled (in Whalestack SEP-6 it is not). If set to false then this is the only attribute of the object. |
false |
.authentication_required |
boolean | Indicates whether the /deposit-exchange requires authentication. If set to true then requests must be authenticated via SEP-10. |
false |
withdraw-exchange |
object | An object containing information about the optional SEP-6 /withdraw-exchange endpoint. | false |
.enabled |
boolean | Indicates whether the /withdraw-exchange endpoint is enabled (in Whalestack SEP-6 it is not). If set to false then this is the only attribute of the object. |
false |
.authentication_required |
boolean | Indicates whether the /withdraw-exchange requires authentication. If set to true then requests must be authenticated via SEP-10. |
false |
supply |
object | An object containing circulating supplies, hot wallet, and cold wallet reserves for above-mentioned assets. Cached five minutes. | false |
Risposta di Errore application/json
{
"status":"400",
"error":"invalid request (and more information explaining the error""
}
Parametri di Risposta dell'Errore
| Nome | Categoria | Descrizione | Nullable |
|---|---|---|---|
status |
string | The issued HTTP status code. | false |
error |
string | A human readable string explaining the error. | false |
GET/depositPubblico
Fornisce un oggetto con informazioni sul deposito contenenti tutte le informazioni necessarie per effettuare un pagamento e ricevere asset tokenizzati su Stellar. Conforma le definizioni ufficiali di Stellar SEP-6 descritte qui.
Richiesta
curl 'https://sep6.whalestack.com/deposit?asset_code=BTC&account=GDONUHZKLSYLDOZWR2TDW25GFXOBWCCKTPK34DLUVSOMFHLGURX6FNU6'
Parametri della Richiesta (GET)
| Key | Categoria | Descrizione | Nullable | Obbligatorio |
|---|---|---|---|---|
asset_code |
string | The asset code of the asset you wish to deposit. | false | mandatory |
account |
string | The Stellar account to which you wish to deposit. As a prerequisite for receiving tokenized funds the account must have a trustline for the desired asset. | false | mandatory |
type |
string | Requests a specific Bitcoin or Litecoin address type. Allowed types are p2sh-segwit, bech32, legacy. Defaults to bech32. |
false | optional |
memo |
string | An optional memo to be sent to the above Stellar account. If a memo is given its type must also be specified in memo_type. |
false | optional |
memo_type |
string | A string specifying the given memo type. Valid options are text, id, and hash. |
false | optional |
email_address |
string | Reserved for future use. An optional email address for receiving email updates related to this deposit transfer. | false | optional |
on_change_callback |
string | An optional URL listening for status updates related to this deposit transfer. The callback sends an HTTP POST request with a JSON object conforming to the one described in /transaction.Your server should respond with a 200 OK HTTP status code upon to acknowledge the callback. If we don't see a 200 OK response we will keep re-sending the callback for a while until we encounter one and eventually give up (after 48 hours or so). Callbacks are signed via an HTTP header, as documented here. |
false | optional |
Risposta di Successo application/json
{
"how":"bc1qj633nx575jm28smgcp3mx6n3gh0zg6ndr0ew23",
"id":"085a2e4aca82edd52d12b37388da",
"eta":600,
"min_amount":"0.0001000",
"max_amount":"100.0000000",
"fee_fixed":"0.0000000",
"fee_fixed":"0.0000000",
"extra_info":{}
}
Caratteristiche della Risposta di Successo
| Nome | Categoria | Descrizione | NullableNullable |
|---|---|---|---|
how |
string | The blockchain address to which the deposit should be sent. | false |
id |
string | A unique identifier given by Whalestack. Save this client-side to reference and query this deposit and related blockchain transactions using the /transaction endpoint. |
false |
eta |
integer | An estimated time of fund transfer in seconds. The actual time can vary depending on underlying blockchain speed and used fees. | false |
min_amount |
string | The minimum deposit amount for the fund transfer to trigger. Deposits below the minimum threshold stay pending until the sum of all made deposits matches or exceeds this amount. | false |
max_amount |
string | The maximum deposit amount. | false |
fee_fixed |
string | Indicates the fixed fee for this deposit. In units of the deposited asset. | false |
fee_percent |
string | Indicates the percentage fee for this deposit. In units of percentage points. | false |
extra_info |
object | An object optionally containing exactly one field message containing a human readable text string with additional information. |
false |
Risposta di Errore application/json
{
"status":"400",
"error":"Account does not have a trustline for BTC-GCQVEST7KIWV3KOSNDDUJKEPZLBFWKM7DUS4TCLW2VNVPCBGTDRVTEIT."
}
Parametri di Risposta dell'Errore
| Nome | Categoria | Descrizione | Nullable |
|---|---|---|---|
status |
string | The issued HTTP status code. | false |
error |
string | A human readable string explaining the error. | false |
GET/withdrawPubblico
Fornisce un oggetto con informazioni sul prelievo contenenti tutte le informazioni necessarie per riscattare asset sulla blockchain sottostante. Conforma le definizioni ufficiali di Stellar SEP-6 descritte qui.
Richiesta
curl 'https://sep6.whalestack.com/withdraw?asset_code=BTC&dest=bc1qj633nx575jm28smgcp3mx6n3gh0zg6ndr0ew23'
Parametri della Richiesta (GET)
| Key | Categoria | Descrizione | Nullable | Obbligatorio |
|---|---|---|---|---|
asset_code |
string | The asset code of the asset you wish to redeem. | false | mandatory |
dest |
string | The Bitcoin (or Litecoin) target address in any format, i.e. native SegWit (bech32), SegWit (P2SH), or legacy (P2PKH). | false | mandatory |
email_address |
string | Reserved for future use. An optional email address for receiving email updates related to this withdrawal transfer. | false | optional |
on_change_callback |
string | An optional URL listening for status updates related to this withdrawal transfer. The callback sends an HTTP POST request with a JSON object conforming to the one described in /transaction.Your server should respond with a 200 OK HTTP status code upon to acknowledge the callback. If we don't see a 200 OK response we will keep re-sending the callback for a while until we encounter one and eventually give up (after 48 hours or so). Callbacks are signed via an HTTP header, as documented here. |
false | optional |
type |
string | Optional parameter indicating the type of withdrawal. The only currently allowed value is crypto. |
false | optional |
Risposta di Successo application/json
{
"account_id":"GCQVESTEG3MY2AA4LFF2J5K77IQP4G5WZCUDOJ5RUIPA6ZKRGQ7XXKBR",
"memo_type":"text",
"memo":"cf86a99b3e6ecd1359a0d2992e70",
"id":"cf86a99b3e6ecd1359a0d2992e70",
"min_amount":"0.0005000",
"max_amount":"100.0000000",
"fee_fixed":0.0002,
"fee_percent":0.2,
"extra_info":{
"message":"An amount above 100.0000000 BTC will take longer to complete"
}
}
Caratteristiche della Risposta di Successo
| Nome | Categoria | Descrizione | Nullable |
|---|---|---|---|
account_id |
string | The Stellar account to which the funds should be sent. | false |
memo |
string | A mandatory memo to be included in the Stellar withdrawal transaction. It is vital to include the memo. Funds sent without the memo might not be able to be resolved or refunded. | false |
memo_type |
integer | The memo type (always text). |
false |
id |
string | A unique identifier given by Whalestack. Save this client-side to reference and query this withdrawal and related blockchain transactions using the /transaction endpoint. |
false |
min_amount |
string | The minimum withdrawal amount for the fund transfer to trigger. Payment operations below the minimum threshold stay pending until the sum of all made payments matches or exceeds this amount. | false |
max_amount |
string | The maximum withdrawal amount. | false |
fee_fixed |
string | Indicates the fixed fee for this withdrawal. In units of the transferred asset. | false |
fee_percent |
string | Indicates the percentage fee for this withdrawal. In units of percentage points. | false |
extra_info |
object | An object optionally containing exactly one field message containing a human readable text string with additional information. |
false |
Risposta di Errore application/json
{
"status":"400",
"error":"Invalid destination address."
}
Parametri di Risposta dell'Errore
| Nome | Categoria | Descrizione | Nullable |
|---|---|---|---|
status |
string | The issued HTTP status code. | false |
error |
string | A human readable string explaining the error. | false |
GET/transactionPubblico
Fornisce un oggetto con informazioni sulla transazione riguardante un deposito o un prelievo SEP-6. Conforma le definizioni ufficiali di Stellar SEP-6 descritte qui.
Necessita di uno tra external_transaction_id (ad esempio, l'id della transazione Bitcoin o Litecoin), stellar_transaction_id, o id come fornito da Whalestack nella risposta HTTP a una richiesta di deposito, prelievo o transazione.
Richiesta
curl 'https://sep6.whalestack.com/transaction?external_transaction_id=914f2fe1175101d5d1b3fc75c053cc090590bb0e251b938c255598c828742c43'
Parametri della Richiesta (GET)
| Key | Categoria | Descrizione | Nullable | Obbligatorio |
|---|---|---|---|---|
id |
string | A transfer id as given by Whalestack in the HTTP response to a /deposit, /withdraw, or /transactions request. |
true | optional |
stellar_transaction_id |
string | A Stellar transaction id related to a SEP-6 deposit or withdrawal. | true | optional |
external_transaction_id |
string | An external transaction id (i.e. a Bitcoin or Litecoin transaction id) related to a SEP-6 deposit or withdrawal. | true | optional |
Risposta di Successo application/json
{
"transaction":{
"id":"085a2e4aca82edd52d12b37388da-814f2fe117-0",
"status":"completed",
"message":"Transaction fully completed.",
"kind":"deposit",
"amount_in":"0.0001000",
"amount_in_asset":"iso-24165:BTC",
"amount_out":"0.0001000",
"amount_out_asset":"stellar:BTC:GCQVEST7KIWV3KOSNDDUJKEPZLBFWKM7DUS4TCLW2VNVPCBGTDRVTEIT",
"amount_fee":"0.0000000",
"from":"bc1qj633nx575jm28smgcp3mx6n3gh0zg6ndr0ew23",
"started_at":"2022-10-04T20:50:18.307Z",
"completed_at":"2022-10-04T20:51:20.032Z",
"stellar_transaction_id":"a426a057aaba5a5811d5ee243f76c767a6756df89f417610a4ebd114e162596a",
"external_transaction_id":"814f2fe1175101d5d1b3fc75c053cc090590bb0e251b938c255598c828742c43",
}
}
Caratteristiche della Risposta di Successo
| Nome | Categoria | Descrizione | Nullable |
|---|---|---|---|
transaction |
object | An object containing information about the transfer transaction. | false |
.id |
string | A composite id combining the SEP-6 transfer id as given by Whalestack in the HTTP response to a deposit or withdrawal request with a conditional unique suffix in the format -[a-z0-9]{10}-[0-9] identifying a single SEP-6 transfer explicitly. |
false |
.status |
string |
A transaction state as documented here.
Possible states:
completed, pending_external, pending_anchor, pending_stellar, pending_trust, pending_user, pending_user_createaccount, pending_user_transfer_start, pending_user_transfer_complete, pending_customer_info_update, incomplete, expired, too_small, too_large, error.
|
false |
.message |
string | A human-readable text string explaining the status given above. |
false |
.kind |
string | The transaction type. Possible values are deposit and withdrawal. |
false |
.amount_in |
string | Amount received by transfer server at the start of the transaction. A string with up to 7 decimals. Excludes any fees charged before the transfer server received the funds. | true |
.amount_in_asset |
string | The asset received or to be received by the transfer server. The value is in SEP-38 Asset Identification format. | true |
.amount_out |
string | Amount sent by the transfer server to the user at end of transaction. A string with up to 7 decimals. | true |
.amount_out_asset |
string | The asset delivered or to be delivered to the user. The value is in SEP-38 Asset Identification format. | true |
.amount_fee |
string | Amount of fee charged by the transfer server. | true |
.from |
string | A Stellar account in the case of withdrawal transactions or a comma-separated string with all UTXO inputs in the case of deposits. | true |
.started_at |
string | Start date and time of transaction (UTC ISO 8601). | true |
.completed_at |
string | Completion date and time of transaction (UTC ISO 8601). | true |
.stellar_transaction_id |
string | Id on Stellar Network indicating the transaction that either completed the deposit or started the withdrawal. | true |
.external_transaction_id |
string | Id of the blockchain transaction on the external network that either started the deposit or completed the withdrawal. | true |
.withdraw_anchor_account |
string | If this is a withdrawal, this is the anchor's Stellar account that the user transferred (or will transfer) their issued asset to. | true |
.withdraw_memo |
string | Mandatory withdrawal memo given by the transfer server. | true |
.withdraw_memo_type |
string | Mandatory withdrawal memo type given by the transfer server. | true |
related_transactions |
object | An optional list of additional transaction objects for situations in which more than one blockchain transaction is associated with a deposit or withdrawal. | true |
Risposta di Errore application/json
{
"status":"404",
"error":"not found"
}
Parametri di Risposta dell'Errore
| Nome | Categoria | Descrizione | Nullable |
|---|---|---|---|
status |
string | The issued HTTP status code. | false |
error |
string | A human readable string explaining the error. | false |
GET/transactionsPubblico
Restituisce una lista di elementi di transazione come descritto in /transaction. Conforma le definizioni ufficiali di Stellar SEP-6 descritte qui.
Richiesta
curl 'https://sep6.whalestack.com/transactions?asset_code=BTC&account=GACK3ODRMGCTRH6HNVETEOF2ZK5G5QUIGLDFFZQSLM6RZJ2LFY3VWQBT'
Parametri della Richiesta (GET)
| Key | Categoria | Descrizione | Nullable | Obbligatorio |
|---|---|---|---|---|
asset_code |
string | The asset code of interest, e.g. BTC or LTC. |
false | mandatory |
account |
string | The stellar account id involved in the transactions. Without this filter the entire transaction history of the transfer server is queried. | false | optional |
no_older_than |
string | The response should only contain transactions starting on or after this date and time (UTC ISO 8601). | true | optional |
limit |
string | The response should contain at most limit transactions. | true | optional |
kind |
string | A comma-separated list containing the desired transaction kinds. Possible values are deposit and withdrawal. |
true | optional |
paging_id |
string | The response should contain transactions starting prior to this ID (exclusive). | true | optional |
Risposta di Successo application/json
{
"transactions":[
{
"id": "30978809351d5e145b8a9bce49a8",
"kind": "deposit",
"status": "pending_user_transfer_start",
"message": "Please initiate your transfer."
},
{
"id":"085a2e4aca82edd52d12b37388da-814f2fe117-0",
"status":"completed",
"message":"Transaction fully completed.",
"kind":"deposit",
"amount_in":"0.0001000",
"amount_in_asset":"iso-24165:BTC",
"amount_out":"0.0001000",
"amount_out_asset":"stellar:BTC:GCQVEST7KIWV3KOSNDDUJKEPZLBFWKM7DUS4TCLW2VNVPCBGTDRVTEIT",
"amount_fee":"0.0000000",
"from":"bc1qj633nx575jm28smgcp3mx6n3gh0zg6ndr0ew23",
"started_at":"2022-10-04T20:50:18.307Z",
"completed_at":"2022-10-04T20:51:20.032Z",
"stellar_transaction_id":"a426a057aaba5a5811d5ee243f76c767a6756df89f417610a4ebd114e162596a",
"external_transaction_id":"814f2fe1175101d5d1b3fc75c053cc090590bb0e251b938c255598c828742c43"
},
{
"id":"9f5762bbbe11dc58be299b8d68e3-8348091630-0",
"status":"completed",
"message":"Transaction fully completed.",
"kind":"withdraw",
"amount_in":"0.0005000",
"amount_in_asset":"stellar:LTCTEST:GBSY6HJZLWBUUNJHHDLDE3AIBSQCHI6UMIMWOLZ6GUWI3NPPLP6QNGI2",
"amount_out":"0.0002990",
"amount_out_asset":"iso24165:LTC",
"amount_fee":"0.0002010",
"from":"GACK3ODRMGCTRH6HNVETEOF2ZK5G5QUIGLDFFZQSLM6RZJ2LFY3VWQBT",
"started_at":"2022-10-05T00:04:02.168Z",
"completed_at":"2022-10-05T00:12:30.284Z",
"stellar_transaction_id":"83480916303afa78b93831e3964eec748b6265148823d27fecb7c7648a9c87ec#184545592135122945",
"external_transaction_id":"f09c0f9fcf7cf88727b20275b2b231b2a0dbb2563e3ad19fe97b839fe50dff50",
"withdraw_memo":"9f5762bbbe11dc58be299b8d68e3",
"withdraw_memo_type":"text",
"withdraw_anchor_account":"GCQVEST7KIWV3KOSNDDUJKEPZLBFWKM7DUS4TCLW2VNVPCBGTDRVTEIT"
}
]
}
Caratteristiche della Risposta di Successo
| Nome | Categoria | Descrizione | Nullable |
|---|---|---|---|
transactions |
array | An array of transaction objects as described in /transaction. |
false |
Risposta di Errore application/json
{
"status":"500",
"error":"internal server error"
}
Parametri di Risposta dell'Errore
| Nome | Categoria | Descrizione | Nullable |
|---|---|---|---|
status |
string | The issued HTTP status code. | false |
error |
string | A human readable string explaining the error. | false |
Client REST Whalestack SEP-6 per PHP v1.0.0
| https://github.com/whalestackhq/sep6-client-php |
README.md
Whalestack SEP-6 Client (PHP)
This client communicates with Whalestack's Stellar SEP-6 transfer server documented here. It lets you on- and off-ramp Bitcoin on the Stellar Network. This client is written in PHP but we also provide clients in different programming languages.
Read our stellar.toml to inspect available Whalestack assets on the Stellar Network. At the time of writing we support wrapped Bitcoin and Litecoin.
Requirements
- PHP >=5.3.0
- cURL extension for PHP
- OpenSSL extension for PHP
Installation as Drop-In
Copy the contents of src into the include path of your project.
Usage Client
include('SEP6Client.class.php');
$client = new SEP6Client();Examples
Deposit Bitcoin onto Stellar
$response = $client->get('/deposit', array(
'asset_code' => 'BTC',
'account' => 'GDONUHZKLSYLDOZWR2TDW25GFXOBWCCKTPK34DLUVSOMFHLGURX6FNU6',
'memo' => 'Sent via SEP-6',
'memo_type' => 'text'
));
// $response->responseBody -> {"how":"bc1qj633nx575jm28smgcp3mx6n3gh0zg6ndr0ew23","id":"f2118ef4115642870638616a4372","eta":600,"min_amount":"0.00001","max_amount":"100.0000000","extra_info":{}}Returns a Bitcoin deposit address alongside some additional context information documented here. Bitcoin sent to the received deposit address is tokenized onto Stellar and sent to above account. The tokenized Bitcoin can be sent and received on the Stellar Network, exchanged for other assets on the SDEX, or be deposited into Stellar's liquidity pools.
Withdraw Bitcoin from Stellar
$response = $client->get('/withdraw', array(
'asset_code' => 'BTC',
'dest' => 'bc1qj633nx575jm28smgcp3mx6n3gh0zg6ndr0ew23'
));
// $response->responseBody -> {"account_id":"GCQVEST7KIWV3KOSNDDUJKEPZLBFWKM7DUS4TCLW2VNVPCBGTDRVTEIT","memo_type":"text","memo":"010cdf0a41410d75b2797a6fa38f","id":"010cdf0a41410d75b2797a6fa38f","min_amount":"0.0005000","max_amount":"100.0000000","fee_fixed":0.0002,"fee_percent":0.2,"extra_info":{"message":"An amount above 100.0000000 will take longer to complete"}}Returns a Stellar account and memo alongside some additional context information documented here. Tokenized Bitcoin sent to the given account is burned on the Stellar Network and released into the Bitcoin address given in the request.
Documentation
Please inspect our SEP-6 API docs or email us at service [at] whalestack.com if you have questions.
Support and Feedback
We'd love to hear your feedback. If you have specific problems or bugs with this SDK, please file an issue on GitHub. For general feedback and support requests please email service [at] whalestack.com.
Contributing
- Fork it ( https://github.com/whalestackhq/sep6-client-php/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request
Client REST Whalestack SEP-6 per NodeJS v0.0.4
| https://github.com/whalestackhq/sep6-client-nodejs |
README.md
Whalestack SEP-6 Client (Node JS)
This client communicates with Whalestack's Stellar SEP-6 transfer server documented here. It lets you on- and off-ramp Bitcoin on the Stellar Network. This client is written in Node JS but we also provide clients in different programming languages.
Read our stellar.toml to inspect available Whalestack assets on the Stellar Network. At the time of writing we support wrapped Bitcoin and Litecoin.
Requirements
- NodeJS >= 10.14.0
- axios >= 0.21.1
Installation with npm
npm install sep6-client
Usage Client
const Sep6Client = require('sep6-client');
const client = new Sep6Client();Examples
Deposit Bitcoin onto Stellar
let response = await client.get('/deposit', {
'asset_code': 'BTC',
'account': 'GDONUHZKLSYLDOZWR2TDW25GFXOBWCCKTPK34DLUVSOMFHLGURX6FNU6',
'memo': 'Sent via SEP-6',
'memo_type': 'text'
});
// console.log(response.data) -> {"how":"bc1qj633nx575jm28smgcp3mx6n3gh0zg6ndr0ew23","id":"f2118ef4115642870638616a4372","eta":600,"min_amount":"0.00001","max_amount":"100.0000000","extra_info":{}}Returns a Bitcoin deposit address alongside some additional context information documented here. Bitcoin sent to the received deposit address is tokenized onto Stellar and sent to above account. The tokenized Bitcoin can be sent and received on the Stellar Network, exchanged for other assets on the SDEX, or be deposited into Stellar's liquidity pools.
Withdraw Bitcoin from Stellar
let response = await client.get('/withdraw', {
'asset_code': 'BTC',
'dest': 'bc1qj633nx575jm28smgcp3mx6n3gh0zg6ndr0ew23'
});
// console.log(response.data) -> {"account_id":"GCQVEST7KIWV3KOSNDDUJKEPZLBFWKM7DUS4TCLW2VNVPCBGTDRVTEIT","memo_type":"text","memo":"010cdf0a41410d75b2797a6fa38f","id":"010cdf0a41410d75b2797a6fa38f","min_amount":"0.0005000","max_amount":"100.0000000","fee_fixed":0.0002,"fee_percent":0.2,"extra_info":{"message":"An amount above 100.0000000 will take longer to complete"}}Returns a Stellar account and memo alongside some additional context information documented here. Tokenized Bitcoin sent to the given account is burned on the Stellar Network and released into the Bitcoin address given in the request.
Documentation
Please inspect our SEP-6 API docs or email us at service [at] whalestack.com if you have questions.
Support and Feedback
We'd love to hear your feedback. If you have specific problems or bugs with this SDK, please file an issue on GitHub. For general feedback and support requests please email service [at] whalestack.com.
Contributing
- Fork it ( https://github.com/whalestackhq/nodejs-merchant-sdk/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request
Client REST Whalestack SEP-6 per Ruby v0.0.2
| https://github.com/whalestackhq/sep6-client-ruby |
README.md
Whalestack SEP-6 Client (Ruby)
This client communicates with Whalestack's Stellar SEP-6 transfer server documented here. It lets you on- and off-ramp Bitcoin on the Stellar Network. This client is written in Ruby but we also provide clients in different programming languages.
Read our stellar.toml to inspect available Whalestack assets on the Stellar Network. At the time of writing we support wrapped Bitcoin and Litecoin.
Requirements
- Ruby >= 2.0.0
- rest-client >= 2.1.0
- json >= 2.3.0
Installation with gem
gem install sep6_client
Usage Client
require 'sep_client/client'
client = Sep6Client::Client.new()Examples
Deposit Bitcoin onto Stellar
response = client.get('/deposit', {
:asset_code => 'BTC',
:account => 'GDONUHZKLSYLDOZWR2TDW25GFXOBWCCKTPK34DLUVSOMFHLGURX6FNU6',
:memo => 'Sent via SEP-6',
:memo_type => 'text',
})
// print response.body -> {"how":"bc1qj633nx575jm28smgcp3mx6n3gh0zg6ndr0ew23","id":"f2118ef4115642870638616a4372","eta":600,"min_amount":"0.00001","max_amount":"100.0000000","extra_info":{}}Returns a Bitcoin deposit address alongside some additional context information documented here. Bitcoin sent to the received deposit address is tokenized onto Stellar and sent to above account. The tokenized Bitcoin can be sent and received on the Stellar Network, exchanged for other assets on the SDEX, or be deposited into Stellar's liquidity pools.
Withdraw Bitcoin from Stellar
response = client.get('/withdraw', {
:asset_code => 'BTC',
:dest => 'bc1qj633nx575jm28smgcp3mx6n3gh0zg6ndr0ew23'
})
// print response.body -> {"account_id":"GCQVEST7KIWV3KOSNDDUJKEPZLBFWKM7DUS4TCLW2VNVPCBGTDRVTEIT","memo_type":"text","memo":"010cdf0a41410d75b2797a6fa38f","id":"010cdf0a41410d75b2797a6fa38f","min_amount":"0.0005000","max_amount":"100.0000000","fee_fixed":0.0002,"fee_percent":0.2,"extra_info":{"message":"An amount above 100.0000000 will take longer to complete"}}Returns a Stellar account and memo alongside some additional context information documented here. Tokenized Bitcoin sent to the given account is burned on the Stellar Network and released into the Bitcoin address given in the request.
Documentation
Please inspect our SEP-6 API docs or email us at service [at] whalestack.com if you have questions.
Support and Feedback
We'd love to hear your feedback. If you have specific problems or bugs with this SDK, please file an issue on GitHub. For general feedback and support requests please email service [at] whalestack.com.
Contributing
- Fork it ( https://github.com/whalestackhq/ruby-merchant-sdk/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request
Prova delle Riserve
Il server di trasferimento SEP-6 di Whalestack è trasparente e verificabile. Di seguito è riportato un elenco dettagliato della cronologia recente di depositi e prelievi del server di trasferimento SEP-6. Utilizza l'endpoint /transactions per interrogare e ispezionare l'intera cronologia del server di trasferimento e verificare le riserve indicate nel portafoglio.
Con Licenza e Regolamentato nell'Unione Europea