Skip to content

Commit

Permalink
Merge pull request #6 from marcinx/main
Browse files Browse the repository at this point in the history
1.0.0
  • Loading branch information
marcinx authored Oct 5, 2022
2 parents 1835de1 + 79ec5ab commit e053beb
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# COINQVEST SEP-6 Client (Node JS)

This client communicates with COINQVEST's Stellar [SEP-6](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0006.md) transfer server documented [here](https://www.coinqvest.com/en/sep6-docs). 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](https://www.coinqvest.com/en/sep6-docs#clients).
This client communicates with COINQVEST's Stellar [SEP-6](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0006.md) transfer server documented [here](https://www.coinqvest.com/en/sep6-api-docs). 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](https://www.coinqvest.com/en/sep6-api-docs).

Read our [stellar.toml](https://www.coinqvest.com/.well-known/stellar.toml) to inspect available COINQVEST assets on the Stellar Network. At the time of writing we support wrapped Bitcoin and Litecoin.

Expand Down Expand Up @@ -32,7 +32,7 @@ let response = await client.get('/deposit', {
// 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](https://www.coinqvest.com/en/sep6-docs#get-deposit). Bitcoin sent to the received deposit address is tokenized onto Stellar and sent to above account. The tokenized Bitcoin can be [sent and received](https://developers.stellar.org/docs/tutorials/send-and-receive-payments) on the Stellar Network, [exchanged](https://developers.stellar.org/docs/encyclopedia/path-payments) for other assets on the SDEX, or be deposited into Stellar's [liquidity pools](https://developers.stellar.org/docs/encyclopedia/liquidity-on-stellar-sdex-liquidity-pools).
Returns a Bitcoin deposit address alongside some additional context information documented [here](https://www.coinqvest.com/en/sep6#get-deposit). Bitcoin sent to the received deposit address is tokenized onto Stellar and sent to above account. The tokenized Bitcoin can be [sent and received](https://developers.stellar.org/docs/tutorials/send-and-receive-payments) on the Stellar Network, [exchanged](https://developers.stellar.org/docs/encyclopedia/path-payments) for other assets on the SDEX, or be deposited into Stellar's [liquidity pools](https://developers.stellar.org/docs/encyclopedia/liquidity-on-stellar-sdex-liquidity-pools).

**Withdraw Bitcoin from Stellar**
```javascript
Expand All @@ -43,11 +43,11 @@ let response = await client.get('/withdraw', {
// 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](https://www.coinqvest.com/en/sep6-docs#get-withdraw). Tokenized Bitcoin sent to the given account is burned on the Stellar Network and released into the Bitcoin address given in the request.
Returns a Stellar account and memo alongside some additional context information documented [here](https://www.coinqvest.com/en/sep6#get-withdraw). 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](https://www.coinqvest.com/en/sep6-docs) or email us at service@coinqvest.com if you have questions.
Please inspect our [SEP-6 API docs](https://www.coinqvest.com/en/sep6-api-docs) or email us at service@coinqvest.com if you have questions.

Support and Feedback
--------------------
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"author": "COINQVEST LLC",
"name": "sep6-client",
"description": "Node JS based Stellar SEP-6 Client by COINQVEST",
"version": "0.0.3",
"version": "1.0.0",
"main": "./lib/index.js",
"keywords": [
"stellar",
Expand Down

0 comments on commit e053beb

Please sign in to comment.