GET/infopubliczny
Zwraca obiekt zawierający opis funkcji i informacje kontekstowe dotyczące serwera przesyłania SEP-6. Jest zgodny z oficjalnymi definicjami Stellar SEP-6 opisanymi tutaj.
GET
/info
GET
/deposit
GET
/withdraw
GET
/transaction
GET
/transactions
SEP-6 firmy Stellar (Stellar Ecosystem Proposal 6) definiuje protokół budowania zgodnego mostu pomiędzy siecią Stellar a innymi blockchainami lub sieciami bankowymi. Umożliwia to łatwe wpłacanie i wypłacanie aktywów opartych na Stellar na koncie Stellar użytkownika przy użyciu zwykłych transakcji bankowych lub blockchain.
SEP-6 zapewnia standaryzację tych procesów, ułatwiając twórcom portfeli i innym integratorom Stellar dodanie obsługi wielu kotwic bez konieczności dostosowywania ich implementacji dla każdej z nich. Zapewnia zdefiniowany zestaw punktów końcowych API i oczekiwanych zachowań, wraz ze specyfikacją sposobu reprezentowania zasobów.
Warto zauważyć, że SEP-6 jest częścią większego pakietu propozycji ekosystemu Stellar, z których każda definiuje konkretny komponent ekosystemu Stellar, mając na celu zapewnienie interoperacyjności i standaryzacji całej sieci.
Ta usługa transferu Stellar SEP-6 umożliwia tokenizację (wpłatę) i detokenizację (wypłatę) Bitcoinów i Litecoinów w Stellar Network. Uzyskaj do niego dostęp programowo lub dokonuj wpłat i wypłat za pomocą naszego interfejsu internetowego.
Aktywa w sieci Stellar Network to cyfrowe (tokenizowane) reprezentacje wszystkiego, co ma wartość.
Whalestack emituje aktywa dla Bitcoin i Litecoin, jak wymieniono poniżej. Pokaż więcej.
Whalestack stawia na pełną przejrzystość dzięki serwerowi transferu SEP-6. Wszystkie transakcje są jawnie kontrolowalne. Dla Twojego spokoju ducha ujawniamy szczegóły, takie jak podaż w obiegu, adresy gorących i zimnych portfeli, szczegóły konta, identyfikatory transakcji blockchain i salda. Fundusze w naszym posiadaniu pozostają bezpiecznie w naszych gorących lub zimnych portfelach, używanych wyłącznie do przelewów SEP-6
Stellar SEP-6 oferuje standardowy sposób dla różnych aplikacji Stellar, niezależnie od tego, czy są to portfele, wymiany, czy użytkownicy końcowi, bezproblemową interakcję z emitentami aktywów – niezależnie od tego, czy są one określane jako kotwice, mosty czy rampy. Aby uzyskać wyczerpujący wgląd w implementację SEP-6 Whalestack, zobacz naszą dokumentację dla programistów.
Aktywa Whalestack są integralnie wplecione w naszą platformę przetwarzania płatności. Zapewnia to stały strumień ruchu do pul płynności, generując w ten sposób opłaty za konwersję i stymulując możliwości arbitrażu. Zapoznaj się z naszą dokumentacją dotyczącą puli płynności lub skontaktuj się, aby uzyskać więcej informacji.
Aby współdziałać z naszym serwerem transferowym SEP-6, upewnij się, że masz zasilone konto Stellar i ustanowione trustlines dla żądanego zasobu. Warto zauważyć, że nasza usługa SEP-6 nie wymaga pozwolenia, więc nie ma potrzeby uwierzytelniania ani nawet konta Whalestack, aby rozpocząć.
Zasoby to cyfrowe (tokenizowane) reprezentacje wszystkiego, co ma wartość w sieci Stellar. Zazwyczaj są one wspierane przez fiducjarne waluty lub kryptowaluty. Whalestack emituje aktywa dla Bitcoin i Litecoin, jak wymieniono poniżej. Należy pamiętać, że jedyną oficjalną i ważną domeną internetową wystawcy Whalestack jest whalestack.com
.
BTC:GCQVEST7KIWV3KOSNDDUJKEPZLBFWKM7DUS4TCLW2VNVPCBGTDRVTEIT
Informacje o Depozycie | Informacje o Wypłacie |
Min. kwota: 0.0005 BTC Max. amount: 100 BTC Opłata (stała): 0 BTC Opłata (procent): 0 % |
Min. kwota: 0.0005 BTC Max. amount: 100 BTC Opłata (stała): 0 BTC Opłata (procent): 0 % |
W sieci Stellar, korzystając z aktywa SEP-6, zasadniczo pokładasz zaufanie w dostawcy usług, takim jak Whalestack, w zakresie bezpiecznego zarządzania Twoimi depozytami i honorowania wypłat. To pojęcie zaufania zostało ucieleśnione w Stellar poprzez koncepcję linii zaufania. Linie zaufania to znaczniki dodawane do Twojego konta Stellar, które umożliwiają przechowywanie określonego tokena. Określają maksymalną ilość tokena, którą jesteś gotowy przechowywać.
Aby móc handlować, otrzymywać lub nawet przechowywać dowolne aktywa w sieci Stellar, wymagana jest linia zaufania z kontem wydawniczym danego aktywa. To konto emisyjne odnosi się do konta Stellar usługodawcy, z którego pochodzi zasób. Linie zaufania są ustanawiane poprzez operację zmiany zaufania, a za każdą z nich pobierana jest opłata za rezerwę podstawową w wysokości 0,5 XLM. Zasadniczo dla każdej utworzonej linii zaufania wymagana jest niewydawalna rezerwa w wysokości 0,5 XLM do czasu rozwiązania linii zaufania.
Aby skonfigurować linie zaufania, będziesz potrzebować kodu zasobu, konta wydawcy i czasami domeny wydawcy, jak opisano poniżej.
BTC:GCQVEST7KIWV3KOSNDDUJKEPZLBFWKM7DUS4TCLW2VNVPCBGTDRVTEIT
Wiele portfeli i giełd Stellar posiada intuicyjne interfejsy, które ułatwiają dodawanie i usuwanie linii zaufania dla różnych aktywów. Znane platformy Stellar to m.in. Freighter, Albedo, xBull, StellarX, Rabet, Lumenswap, Scopuly, LOBSTR i StellarTerm. Dla tych, którzy szukają niestandardowego podejścia, Stellar Laboratory udostępnia narzędzia umożliwiające bezpieczne tworzenie spersonalizowanych operacji zaufania w zakresie zmian.
Warto wspomnieć, że nie wspieramy żadnych usług zewnętrznych. Zalecamy podejście programistyczne (szczegóły poniżej) lub wykorzystanie Stellar Laboratory.
Jeśli chcesz programistycznie dodać linię zaufania, upewnij się, że masz dostęp do jednego z pakietów SDK Stellar, wystarczająco zasilonego konta Stellar wraz z jego tajnym kluczem i linii kodu do wdrożenia operacji zmiany zaufania. Oto fragment kodu JavaScript ilustrujący dodanie linii zaufania dla zasobów Bitcoin i Litecoin Stellar firmy Whalestack. Pamiętaj, jeśli zamierzasz później usunąć linię zaufania, ustaw parametr limitu linii zaufania w swojej operacji na 0, po wyczyszczeniu wszelkich sald aktywów (jeśli istnieją).
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);
}
})()
Angażowanie się w pule płynności jest otwarte i niewymagające pozwolenia. Podstawowe pule płynności Whalestack to XLM/BTC
i BTC/LTC
. Pule te są wykorzystywane głównie podczas transakcji wymiany aktywów na Whalestack. Nasz wybór tych par jest dwojaki: Po pierwsze, są to uznane pary handlowe na głównych scentralizowanych giełdach, co ułatwia mapowanie arbitrażu. Po drugie, wybór ten gwarantuje, że BTC i LTC zawsze będą miały drogę do innych znaczących aktywów w sieci za pośrednictwem XLM.
84cf93f8d1c22e150b8f0022b3c9a39d03976da6b5143818327bf298358ce5e7
Na platformie Whalestack działania takie jak checkout, wpłaty, swapy i wypłaty wykorzystują płynność wyżej wymienionych pul, gdy tylko ma miejsce wymiana aktywów. Częściej jest to wymiana pomiędzy Bitcoinem lub Litecoinem i fiat stablecoin, taką jak USDC. W rezultacie platforma Whalestack konsekwentnie generuje jednokierunkowy ruch w puli, torując drogę możliwościom arbitrażu. Poza tym powszechny handel publiczny w Stellar Network również pochłania płynność i przyczynia się do wzrostu wolumenu. Jeśli jesteś animatorem rynku lub arbitrem, zapraszamy Cię do głębszego zagłębienia się i nawiązania z nami kontaktu.
Przed przystąpieniem do inwestowania zalecamy zapoznanie się z koncepcjami puli płynności i zrozumienie ryzyka związanego z nietrwałą stratą. Niektóre wnikliwe zasoby obejmują: Liquidity, Liquidity, Liquidity, Introducing Automated Market Makers on Stellar i AMMs in the Stellar Ecosystem.
Uczestnictwo w pulach płynności nie wymaga żadnych zezwoleń. Aby skutecznie zaangażować się, należy ustanowić linie zaufania dla aktywów i odpowiadających im pul płynności. Kilka portfeli Stellar, takich jak xBull, Lumenswap, LOBSTR i StellarX, oferuje interfejsy ułatwiające wpłaty i wypłaty. Jednak formalnie nie wspieramy żadnych platform stron trzecich. Zalecamy bezpośrednią współpracę z pulami programowo lub za pośrednictwem Stellar Laboratory, aby zachować pełną kontrolę nad kluczami, bezpieczeństwem i dostosowywaniem.
Fundacja Stellar Development skrupulatnie udokumentowała niuanse związane z uczestnictwem w programowej puli płynności. Sugerujemy skorzystanie z tego kompleksowego przewodnika. Obejmuje przykłady od tworzenia i depozytów po wypłaty i monitorowania puli płynności.
Tokenizuje i wpłaca Bitcoin lub Litecoin do Sieci Stellar.
Detokenizuje aktywa Bitcoin lub Litecoin w Stellar i wymienia je na ich natywny blockchain.
Sprawdza status transferu SEP-6 dla danego żądania transferu lub id transakcji blockchain.
Interfejs API transferu SEP-6 firmy Whalestack umożliwia płynną tokenizację (wpłatę) i detokenizację (wypłatę) Bitcoinów i Litecoinów w Stellar Network. W tym przewodniku opisano kroki niezbędne do osiągnięcia tego celu.
Stellar SEP-6 ustanawia ujednolicone podejście do portfeli, wymiany, użytkowników końcowych i aplikacji Stellar w celu płynnej komunikacji z emitentami aktywów, często określanymi jako kotwice, mosty lub rampy, takie jak Whalestack. Aby uzyskać pełne zrozumienie, możesz zapoznać się z oficjalną dokumentacją. Jeśli jednak szukasz zwięzłego punktu wyjścia, poniżej przygotowaliśmy dla Ciebie najważniejsze informacje.
Serwer transferowy Whalestack SEP-6 jest hostowany pod adresem sep6.whalestack.com
. Interakcja z nim jest prosta: wysyłaj żądania HTTP GET i interpretuj odpowiedzi. Aby to ułatwić, użyj klienta REST dostosowanego do preferowanego przez Ciebie języka programowania (oferujemy implementacje dla PHP, NodeJS i Ruby) lub narzędzi takich jak cURL lub wget. Warto zauważyć, że ponieważ dostęp do wszystkich punktów końcowych SEP-6 odbywa się poprzez HTTP GET, do podstawowych interakcji może wystarczyć okno przeglądarki. Whalestack działa w ramach domeny whalestack.com
. Naszą konfigurację pliku stellar.toml możesz zobaczyć tutaj.
Przed zagłębieniem, upewnij się, że posiadasz zasilone konto Stellar z ustalonymi liniami zaufania trust do asset, za pomocą których zamierzasz przeprowadzać transakcje. Nasza implementacja SEP-6 nie wymaga uprawnień, co neguje uwierzytelnianie, a nawet konta Whalestack.
Serwer transferu udostępnia pięć punktów końcowych, wszystkie zgodne ze specyfikacją SEP-6 i dostępne za pośrednictwem protokołu HTTP GET. Szczegółowe specyfikacje tych punktów końcowych można znaleźć tutaj.
/info
Udostępnia obiekt opisowy szczegółowo przedstawiający funkcje i kontekst serwera transferu SEP-6./deposit
Oferuje obiekt zawierający niezbędne informacje o depozycie, określający kroki transferu środków i otrzymywania tokenizowanych aktywów w Stellar./withdraw
Przedstawia obiekt szczegółowo opisujący procedury wypłat, w tym sposób odkupienia aktywów z powrotem do ich natywnego blockchainu./transaction
Pobiera informacje na temat konkretnej transakcji wpłaty lub wypłaty SEP-6./transactions
Wyświetla listę wszystkich transakcji powiązanych z serwerem transferu SEP-6.
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":{}}
Zwraca adres depozytu Bitcoin wraz z dodatkowymi informacjami kontekstowymi udokumentowanymi tutaj. Bitcoin wysłany na otrzymany adres depozytu jest tokenizowany na Stellar i wysyłany na powyższe konto. Tokenizowany Bitcoin można wysyłać i odbierać w sieci Stellar, wymieniać na inne aktywa w SDEX lub zdeponować w pulach płynności Stellar.
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"}}
Zwraca konto Stellar i notatkę wraz z dodatkowymi informacjami kontekstowymi udokumentowanymi tutaj. Tokenizowany Bitcoin wysłany na dane konto jest spalany w sieci Stellar i uwalniany na adres Bitcoin podany w żądaniu.
Serwer transferu SEP-6 współpracuje z dowolnym klientem REST w dowolnym języku programowania, a pakiety SDK dla PHP, Ruby i NodeJS opublikowaliśmy w naszym GitHub, aby pomóc Ci szybko rozpocząć pracę.
Zwraca obiekt zawierający opis funkcji i informacje kontekstowe dotyczące serwera przesyłania SEP-6. Jest zgodny z oficjalnymi definicjami Stellar SEP-6 opisanymi tutaj.
curl 'https://sep6.whalestack.com/info'
{ "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 } } }
Nazwa | Rodzaj | Opis | Zerowalny |
---|---|---|---|
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 |
{ "status":"400", "error":"invalid request (and more information explaining the error"" }
Nazwa | Rodzaj | Opis | Zerowalny |
---|---|---|---|
status |
string | The issued HTTP status code. | false |
error |
string | A human readable string explaining the error. | false |
Zwraca obiekt z informacjami o depozycie zawierającymi wszystkie informacje potrzebne do dokonania płatności i otrzymania tokenizowanych aktywów w Stellar. Jest zgodny z oficjalnymi definicjami Stellar SEP-6 opisanymi tutaj.
curl 'https://sep6.whalestack.com/deposit?asset_code=BTC&account=GDONUHZKLSYLDOZWR2TDW25GFXOBWCCKTPK34DLUVSOMFHLGURX6FNU6'
Key | Rodzaj | Opis | Zerowalny | Obowiązkowy |
---|---|---|---|---|
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 |
{ "how":"bc1qj633nx575jm28smgcp3mx6n3gh0zg6ndr0ew23", "id":"085a2e4aca82edd52d12b37388da", "eta":600, "min_amount":"0.0001000", "max_amount":"100.0000000", "fee_fixed":"0.0000000", "fee_fixed":"0.0000000", "extra_info":{} }
Nazwa | Rodzaj | Opis | ZerowalnyNullable |
---|---|---|---|
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 |
{ "status":"400", "error":"Account does not have a trustline for BTC-GCQVEST7KIWV3KOSNDDUJKEPZLBFWKM7DUS4TCLW2VNVPCBGTDRVTEIT." }
Nazwa | Rodzaj | Opis | Zerowalny |
---|---|---|---|
status |
string | The issued HTTP status code. | false |
error |
string | A human readable string explaining the error. | false |
Zwraca obiekt z informacją o wypłacie zawierającą wszystkie informacje potrzebne do wykupienia aktywów na bazowy blockchain. Jest zgodny z oficjalnymi definicjami Stellar SEP-6 opisanymi tutaj.
curl 'https://sep6.whalestack.com/withdraw?asset_code=BTC&dest=bc1qj633nx575jm28smgcp3mx6n3gh0zg6ndr0ew23'
Key | Rodzaj | Opis | Zerowalny | Obowiązkowy |
---|---|---|---|---|
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 |
{ "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" } }
Nazwa | Rodzaj | Opis | Zerowalny |
---|---|---|---|
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 |
{ "status":"400", "error":"Invalid destination address." }
Nazwa | Rodzaj | Opis | Zerowalny |
---|---|---|---|
status |
string | The issued HTTP status code. | false |
error |
string | A human readable string explaining the error. | false |
Zwraca obiekt z informacjami o transakcji dotyczącej wpłaty lub wypłaty SEP-6. Jest zgodny z oficjalnymi definicjami Stellar SEP-6 opisanymi tutaj.
Wymaga external_transaction_id
(tj. identyfikatora transakcji Bitcoin lub Litecoin), stellar_transaction_id
lub id
podanego przez Whalestack w odpowiedzi HTTP na żądanie wpłaty, wypłaty lub transakcji.
curl 'https://sep6.whalestack.com/transaction?external_transaction_id=914f2fe1175101d5d1b3fc75c053cc090590bb0e251b938c255598c828742c43'
Key | Rodzaj | Opis | Zerowalny | Obowiązkowy |
---|---|---|---|---|
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 |
{ "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", } }
Nazwa | Rodzaj | Opis | Zerowalny |
---|---|---|---|
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 |
{ "status":"404", "error":"not found" }
Nazwa | Rodzaj | Opis | Zerowalny |
---|---|---|---|
status |
string | The issued HTTP status code. | false |
error |
string | A human readable string explaining the error. | false |
Zwraca listę obiektów transakcji zgodnie z opisem w /transaction
. Jest zgodny z oficjalnymi definicjami Stellar SEP-6 opisanymi tutaj.
curl 'https://sep6.whalestack.com/transactions?asset_code=BTC&account=GACK3ODRMGCTRH6HNVETEOF2ZK5G5QUIGLDFFZQSLM6RZJ2LFY3VWQBT'
Key | Rodzaj | Opis | Zerowalny | Obowiązkowy |
---|---|---|---|---|
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 |
{ "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" } ] }
Nazwa | Rodzaj | Opis | Zerowalny |
---|---|---|---|
transactions |
array | An array of transaction objects as described in /transaction . |
false |
{ "status":"500", "error":"internal server error" }
Nazwa | Rodzaj | Opis | Zerowalny |
---|---|---|---|
status |
string | The issued HTTP status code. | false |
error |
string | A human readable string explaining the error. | false |
https://github.com/whalestackhq/sep6-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.
Copy the contents of src
into the include path of your project.
Usage Client
include('SEP6Client.class.php');
$client = new SEP6Client();
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.
Please inspect our SEP-6 API docs or email us at service [at] whalestack.com if you have questions.
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.
git checkout -b my-new-feature
)git commit -am 'Add some feature'
)git push origin my-new-feature
)https://github.com/whalestackhq/sep6-client-nodejs |
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.
npm install sep6-client
Usage Client
const Sep6Client = require('sep6-client');
const client = new Sep6Client();
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.
Please inspect our SEP-6 API docs or email us at service [at] whalestack.com if you have questions.
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.
git checkout -b my-new-feature
)git commit -am 'Add some feature'
)git push origin my-new-feature
)https://github.com/whalestackhq/sep6-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.
gem install sep6_client
Usage Client
require 'sep_client/client'
client = Sep6Client::Client.new()
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.
Please inspect our SEP-6 API docs or email us at service [at] whalestack.com if you have questions.
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.
git checkout -b my-new-feature
)git commit -am 'Add some feature'
)git push origin my-new-feature
)
Serwer transferowy SEP-6 Whalestack jest przejrzysty i kontrolowalny. Poniżej znajduje się szczegółowe zestawienie najnowszej historii wpłat i wypłat z serwera transferowego SEP-6. Użyj punktu końcowego /transactions
, aby sprawdzić i przejrzeć całą historię serwera transferu oraz zweryfikować wskazane rezerwy portfela.