GET/infopúblico
Retorna um objeto contendo a descrição do recurso e informações de contexto sobre o servidor de transferência SEP-6. Conforme as definições oficiais do Stellar SEP-6 descritas aqui.
Desenvolvedores
Documentação da APIGET /info
GET /deposit
GET /withdraw
GET /transaction
GET /transactions
Transparência
Prova de ReservasInício
O SEP-6 da Stellar (Stellar Ecosystem Proposal 6) define o protocolo para construir uma ponte compatível entre a rede Stellar e outras blockchains ou redes bancárias. Isso permite que ativos baseados na Stellar sejam facilmente depositados e retirados de uma conta Stellar do usuário usando transações regulares de blockchain ou bancárias.
O SEP-6 garante que esses processos sejam padronizados, facilitando para os desenvolvedores de carteiras e outros integradores da Stellar adicionar suporte para múltiplas âncoras sem ter que ajustar sua implementação para cada uma. Ele fornece um conjunto definido de endpoints de API e comportamentos esperados, junto com uma especificação de como os ativos devem ser representados.
Vale ressaltar que o SEP-6 faz parte de um conjunto maior de Propostas do Ecossistema Stellar, cada uma das quais define um componente particular do ecossistema Stellar, visando garantir que toda a rede permaneça interoperável e expansível.
Whalestack SEP-6
Este serviço de transferência SEP-6 da Stellar permite que você tokenize (deposite) e detokenize (retire) Bitcoin e Litecoin na Rede Stellar. Acesse programaticamente ou faça depósitos e retiradas usando nossa interface web.
Ativos da Whalestack
Ativos na Rede Stellar são representações digitais (tokenizadas) de qualquer coisa de valor.
A Whalestack emite ativos para Bitcoin e Litecoin conforme listado abaixo. Exibir mais.
Transparência
A Whalestack prioriza total transparência com seu servidor de transferência SEP-6. Todas as transações são abertamente auditáveis. Para a sua tranquilidade, divulgamos detalhes como o suprimento em circulação, endereços de carteiras quentes e frias, especificações de contas, IDs de transações blockchain e saldos. Os fundos sob nossa custódia permanecem seguros dentro de nossas carteiras quentes ou frias, utilizados exclusivamente para transferências SEP-6.
For Developers
O SEP-6 da Stellar oferece um padrão estabelecido para várias aplicações Stellar, sejam carteiras, exchanges ou usuários finais, para interagir sem problemas com emissores de ativos — seja referindo-se a âncoras, pontes ou rampas. Para obter informações completas sobre a implementação do SEP-6 da Whalestack, consulte nossa documentação para desenvolvedores documentation.
Formadores de Mercado e Arbitragistas
Os ativos da Whalestack são integrados de forma essencial em nossa plataforma de processamento de pagamentos. Isso garante um fluxo constante de tráfego para os pools de liquidez, gerando assim taxas de conversão e estimulando oportunidades de arbitragem. Mergulhe em nossa documentação do pool de liquidez liquidity pool documentation ou entre em contato para mais informações.
Trustlines
Para interagir com nosso servidor de transferência SEP-6, certifique-se de que você tem uma conta Stellar financiada e estabeleceu confiança para o ativo desejado asset. Notavelmente, nosso serviço SEP-6 é sem permissão, então não há necessidade de autenticação ou mesmo uma conta Whalestack para começar.
Ativos Whalestack
Ativos são representações digitais (tokenizadas) de qualquer coisa de valor na Rede Stellar. Eles são tipicamente lastreados por moeda fiduciária ou criptomoedas. A Whalestack emite ativos para Bitcoin e Litecoin conforme listado abaixo. Por favor, note que o único domínio web oficial e válido da emissora Whalestack é whalestack.com.
BTC:GCQVEST7KIWV3KOSNDDUJKEPZLBFWKM7DUS4TCLW2VNVPCBGTDRVTEIT
| Informações de Depósito | Informações de Retirada |
|
Quantia Mín.: 0.0005 BTC Quantia Máx.: 100 BTC Taxa (fixa): 0 BTC Taxa (percentual): 0 % |
Quantia Mín.: 0.0005 BTC Quantia Máx.: 100 BTC Taxa (fixa): 0 BTC Taxa (percentual): 0 % |
Trustlines
Na rede Stellar, quando você utiliza um ativo SEP-6, você está essencialmente depositando confiança no provedor de serviços, como a Whalestack, para gerenciar seus depósitos e honrar seus saques de forma segura. Esta noção de confiança é incorporada no Stellar através do conceito de Trustlines. Trustlines são marcadores adicionados à sua conta Stellar que permitem que você mantenha um token específico. Eles delimitam a quantidade máxima do token que você está preparado para manter.
Para negociar, receber ou até mesmo manter qualquer ativo na rede Stellar, uma Trustline com a conta emissora do ativo conta emissora é obrigatória. Esta conta emissora refere-se à conta Stellar do provedor de serviços que originou o ativo. Trustlines são estabelecidas através da operação change trust operation, e cada uma incorre em uma taxa de reserva base de 0.5 XLM. Essencialmente, para cada Trustline que você cria, uma reserva de 0.5 XLM que não pode ser gasta é obrigatória até que a Trustline seja dissolvida.
Ativos da Whalestack
Para configurar linhas de confiança, você precisará do código do ativo, da conta emissora e, ocasionalmente, do domínio do emissor conforme delineado abaixo.
Bitcoin (na rede Stellar)
Domínio do Emissor: whalestack.com
BTC:GCQVEST7KIWV3KOSNDDUJKEPZLBFWKM7DUS4TCLW2VNVPCBGTDRVTEIT
Adicionando Trustlines via Carteiras
Muitas carteiras e exchanges Stellar possuem interfaces intuitivas que facilitam a adição e remoção de Trustlines para vários ativos. Plataformas Stellar renomadas incluem Freighter, Albedo, xBull, StellarX, Rabet, Lumenswap, Scopuly, LOBSTR, e StellarTerm. Para aqueles que buscam uma abordagem personalizada, o Stellar Laboratory oferece ferramentas para criar operações de mudança de confiança (change trust) personalizadas de forma segura.
Vale a pena mencionar que não endossamos nenhum serviço externo. Nós defendemos abordagens programáticas (detalhadas abaixo) ou o uso do Stellar Laboratory.
Adicionando Trustlines Programaticamente
Se você deseja adicionar uma Trustline programaticamente, garanta que você tenha acesso a um dos SDKs Stellar, uma conta Stellar suficientemente financiada junto com sua chave secreta e códigos de linha para implementar a operação change trust. Aqui está um trecho de JavaScript exemplificando a adição de Trustlines para os ativos Stellar de Bitcoin e Litecoin da Whalestack. Lembre-se, se você pretende deletar uma Trustline mais tarde, defina o parâmetro de limite de Trustline em sua operação para 0, limpando quaisquer saldos de ativos presentes.
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);
}
})()
Piscinas de Liquidez
Participar de piscinas de liquidez é aberto e sem permissão. As piscinas de liquidez primárias da Whalestack são XLM/BTC e BTC/LTC. Estas piscinas entram em jogo predominantemente durante transações de troca de ativos na Whalestack. Nossa seleção desses pares é dupla: Primeiramente, são pares de negociação reconhecidos em exchanges centralizadas mainstream, facilitando a facilidade de mapeamento de arbitragem. Em segundo lugar, essa escolha garante que BTC e LTC sempre tenham uma rota para outros ativos significativos na rede via XLM.
84cf93f8d1c22e150b8f0022b3c9a39d03976da6b5143818327bf298358ce5e7
Papel dos Formadores de Mercado e Arbitradores
Na plataforma Whalestack, ações como checkouts, depósitos, trocas e retiradas, acessam a liquidez das piscinas mencionadas sempre que há uma troca de ativos. Mais frequentemente, essa troca é entre Bitcoin ou Litecoin e uma stablecoin fiduciária, como USDC. Como resultado, a plataforma Whalestack gera consistentemente tráfego unidirecional para as piscinas de liquidez, abrindo caminho para oportunidades de arbitragem. Junto a isso, a negociação pública geral na Rede Stellar também consome liquidez e contribui para o volume. Se você é um formador de mercado ou um arbitrador, convidamos você a se aprofundar e engajar-se conosco.
Engajando com Piscinas de Liquidez
Antes de mergulhar, defendemos que se familiarize com os conceitos de piscinas de liquidez e entenda os riscos associados com perda impermanente. Alguns recursos úteis incluem: Liquidity, Liquidity, Liquidity, Introducing Automated Market Makers on Stellar, e AMMs in the Stellar Ecosystem.
A participação em piscinas de liquidez não requer permissões. Para se engajar efetivamente, você deve estabelecer confianças para os ativos e suas respectivas piscinas de liquidez. Várias carteiras Stellar, como xBull, Lumenswap, LOBSTR, e StellarX, oferecem interfaces para facilitar depósitos e retiradas. No entanto, não endossamos formalmente nenhuma plataforma de terceiros. Recomendamos o engajamento direto com as pools programaticamente ou via Stellar Laboratory para manter o controle total sobre chaves, segurança e conformidade.
Orientação para Desenvolvedores
A Stellar Development Foundation documentou meticulosamente as nuances da participação programática em liquidity pools. Sugerimos a referência a este guia abrangente. Ele abrange exemplos que vão desde a criação de piscinas de liquidez creation e depósitos até retiradas e liquidity pool operations.
Depósito
Tokeniza e deposita Bitcoin ou Litecoin na Rede Stellar.
Retirada
Reverte a tokenização de ativos Bitcoin ou Litecoin na Stellar e os resgata para a sua blockchain nativa.
Status da Transferência
Consulta o status da transferência SEP-6 para um ID de solicitação de transferência ou transação de blockchain específico.
Documentação da API
A API de Transferência SEP-6 da Whalestack permite que você tokenize (depósito) e detokenize (retirada) Bitcoin e Litecoin na Rede Stellar. Este guia delineia os passos necessários para alcançar isso.
Introdução ao Stellar SEP-6
O Stellar SEP-6 estabelece uma abordagem padronizada para carteiras, exchanges, usuários finais e aplicações Stellar interagirem sem problemas com emissores de ativos, frequentemente referidos como âncoras, pontes ou rampas, como a Whalestack. Para um entendimento completo, você pode revisar sua documentação oficial documentação. No entanto, se você está procurando um ponto de partida conciso, destilamos os essenciais para você abaixo.
Servidor de Transferência SEP-6 da Whalestack
O servidor de transferência SEP-6 da Whalestack está hospedado em sep6.whalestack.com. Interagir com ele é direto: envie solicitações HTTP GET e interprete as respostas. Para facilitar isso, utilize um cliente REST adaptado à sua linguagem de programação preferida (oferecemos implementações para PHP, NodeJS e Ruby) ou utilitários como cURL ou wget. Notavelmente, já que todos os endpoints SEP-6 são acessados via HTTP GET, uma janela do navegador poderia ser suficiente para interações rudimentares. A Whalestack opera sob o domínio whalestack.com. Você pode visualizar sua configuração stellar.toml aqui.
Início
Antes de começar, certifique-se de possuir uma conta Stellar financiada com linhas de confiança estabelecidas trustlines para o ativo asset com o qual você pretende transacionar. Nossa implementação SEP-6 é sem permissão, eliminando a necessidade de autenticação ou mesmo uma conta Whalestack.
API Endpoints
O servidor de transferência apresenta cinco endpoints, todos em conformidade com a especificação SEP-6 e acessíveis via HTTP GET. Especificações detalhadas para esses endpoints podem ser exploradas aqui.
/infoFornece um objeto descritivo detalhando as funcionalidades e o contexto do servidor de transferência SEP-6./depositOferece um objeto contendo informações essenciais de depósito, detalhando as etapas para transferir fundos e receber ativos tokenizados no Stellar./withdrawApresenta um objeto detalhando os procedimentos de retirada, incluindo como resgatar ativos de volta para sua blockchain nativa./transactionRecupera informações sobre uma transação específica de depósito ou retirada do SEP-6./transactionsLista todas as transações associadas ao servidor de transferência SEP-6.
Exemplos
Depositar Bitcoin no 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":{}}
Retorna um endereço de depósito de Bitcoin juntamente com algumas informações contextuais adicionais documentadas aqui. Bitcoin enviado para o endereço de depósito recebido é tokenizado no Stellar e enviado para a conta acima. O Bitcoin tokenizado pode ser enviado e recebido na Rede Stellar, trocado por outros ativos no SDEX, ou ser depositado no pool de liquidez do Stellar.
Retirar Bitcoin do 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"}}
Retorna uma conta Stellar e memo junto com algumas informações contextuais adicionais documentadas aqui. Bitcoin tokenizado enviado para a conta fornecida é queimado na Rede Stellar e liberado para o endereço Bitcoin dado na solicitação.
Clientes REST SEP-6
O servidor de transferência SEP-6 funciona com qualquer cliente REST em qualquer linguagem de programação, e publicamos SDKs para PHP, Ruby e NodeJS em nosso GitHub para ajudá-lo a começar rapidamente.
Solicitação
curl 'https://sep6.whalestack.com/info'
Resposta de Sucesso 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
}
}
}
Atributos da Resposta de Sucesso
| Nome | Tipo | Descrição | Anulável |
|---|---|---|---|
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 |
Resposta de Erro application/json
{
"status":"400",
"error":"invalid request (and more information explaining the error""
}
Parâmetros da Resposta de Erro
| Nome | Tipo | Descrição | Anulável |
|---|---|---|---|
status |
string | The issued HTTP status code. | false |
error |
string | A human readable string explaining the error. | false |
GET/depositpúblico
Retorna um objeto com informações de depósito contendo todas as informações necessárias para realizar pagamentos e receber ativos tokenizados na Stellar. Conforme as definições oficiais do Stellar SEP-6 descritas aqui.
Solicitação
curl 'https://sep6.whalestack.com/deposit?asset_code=BTC&account=GDONUHZKLSYLDOZWR2TDW25GFXOBWCCKTPK34DLUVSOMFHLGURX6FNU6'
Parâmetros de Requisição (GET)
| Key | Tipo | Descrição | Anulável | Obrigatório |
|---|---|---|---|---|
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 |
Resposta de Sucesso 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":{}
}
Atributos da Resposta de Sucesso
| Nome | Tipo | Descrição | AnulávelNullable |
|---|---|---|---|
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 |
Resposta de Erro application/json
{
"status":"400",
"error":"Account does not have a trustline for BTC-GCQVEST7KIWV3KOSNDDUJKEPZLBFWKM7DUS4TCLW2VNVPCBGTDRVTEIT."
}
Parâmetros da Resposta de Erro
| Nome | Tipo | Descrição | Anulável |
|---|---|---|---|
status |
string | The issued HTTP status code. | false |
error |
string | A human readable string explaining the error. | false |
GET/withdrawpúblico
Retorna um objeto com informações de retirada contendo todas as informações necessárias para resgatar ativos na blockchain subjacente. Conforme as definições oficiais do Stellar SEP-6 descritas aqui.
Solicitação
curl 'https://sep6.whalestack.com/withdraw?asset_code=BTC&dest=bc1qj633nx575jm28smgcp3mx6n3gh0zg6ndr0ew23'
Parâmetros de Requisição (GET)
| Key | Tipo | Descrição | Anulável | Obrigatório |
|---|---|---|---|---|
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 |
Resposta de Sucesso 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"
}
}
Atributos da Resposta de Sucesso
| Nome | Tipo | Descrição | Anulável |
|---|---|---|---|
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 |
Resposta de Erro application/json
{
"status":"400",
"error":"Invalid destination address."
}
Parâmetros da Resposta de Erro
| Nome | Tipo | Descrição | Anulável |
|---|---|---|---|
status |
string | The issued HTTP status code. | false |
error |
string | A human readable string explaining the error. | false |
GET/transactionpúblico
Retorna um objeto com informações de transação referente a um depósito ou retirada SEP-6. Conforme as definições oficiais do Stellar SEP-6 descritas aqui.
Requer ou um external_transaction_id (ou seja, o id de transação Bitcoin ou Litecoin), um stellar_transaction_id, ou um id fornecido pela Whalestack na resposta HTTP a um pedido de depósito, retirada ou transações.
Solicitação
curl 'https://sep6.whalestack.com/transaction?external_transaction_id=914f2fe1175101d5d1b3fc75c053cc090590bb0e251b938c255598c828742c43'
Parâmetros de Requisição (GET)
| Key | Tipo | Descrição | Anulável | Obrigatório |
|---|---|---|---|---|
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 |
Resposta de Sucesso 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",
}
}
Atributos da Resposta de Sucesso
| Nome | Tipo | Descrição | Anulável |
|---|---|---|---|
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 |
Resposta de Erro application/json
{
"status":"404",
"error":"not found"
}
Parâmetros da Resposta de Erro
| Nome | Tipo | Descrição | Anulável |
|---|---|---|---|
status |
string | The issued HTTP status code. | false |
error |
string | A human readable string explaining the error. | false |
GET/transactionspúblico
Retorna uma lista de objetos de transação conforme descrito em /transaction. Conforme as definições oficiais do Stellar SEP-6 descritas aqui.
Solicitação
curl 'https://sep6.whalestack.com/transactions?asset_code=BTC&account=GACK3ODRMGCTRH6HNVETEOF2ZK5G5QUIGLDFFZQSLM6RZJ2LFY3VWQBT'
Parâmetros de Requisição (GET)
| Key | Tipo | Descrição | Anulável | Obrigatório |
|---|---|---|---|---|
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 |
Resposta de Sucesso 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"
}
]
}
Atributos da Resposta de Sucesso
| Nome | Tipo | Descrição | Anulável |
|---|---|---|---|
transactions |
array | An array of transaction objects as described in /transaction. |
false |
Resposta de Erro application/json
{
"status":"500",
"error":"internal server error"
}
Parâmetros da Resposta de Erro
| Nome | Tipo | Descrição | Anulável |
|---|---|---|---|
status |
string | The issued HTTP status code. | false |
error |
string | A human readable string explaining the error. | false |
Cliente REST SEP-6 da Whalestack para 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
Cliente REST SEP-6 da Whalestack para 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
Cliente REST SEP-6 da Whalestack para 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 de Reservas
O servidor SEP-6 da Whalestack é transparente e auditável. Abaixo está uma declaração detalhada dos depósitos recentes e do histórico de retiradas do servidor de transferência SEP-6. Use o endpoint /transactions para consultar e inspecionar todo o histórico do servidor de transferência e verificar as reservas da carteira indicada.
Licenciada e Regulamentada na UE