Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sync #99

Merged
merged 6 commits into from
Aug 31, 2023
Merged

sync #99

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion authors.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,9 @@
},
"borngraced": {
"username": "borngraced",
"commit_emails": ["[email protected]"],
"commit_emails": [
"[email protected]"
],
"socials": {
"twitter": "",
"linkedin": ""
Expand Down
5 changes: 3 additions & 2 deletions src/pages/antara/api/gaming/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
export const title = "Antara Gaming SDK";
export const description = "This module-based software is programmed in C++ 17 and is designed for high-speed runtime execution.";
export const description =
"This module-based software is programmed in C++ 17 and is designed for high-speed runtime execution.";

# Gaming

Expand All @@ -9,7 +10,7 @@ Welcome to the Antara Gaming SDK documentation. This module-based software is pr

<Note>

The modules of the Antara Gaming SDK rely on other modules, such as [Oracles](oracles)
The modules of the Antara Gaming SDK rely on other modules, such as [Oracles](/antara/api/oracles/)

</Note>

Expand Down
17 changes: 9 additions & 8 deletions src/pages/antara/api/pegs/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
export const title = "Pegs: Creating Decentralized Stablecoins";
export const description = "The Pegs Antara Module is a mechanism for creating a decentralized stablecoin.";
export const description =
"The Pegs Antara Module is a mechanism for creating a decentralized stablecoin.";

# Pegs

Expand All @@ -23,19 +24,19 @@ For example, a stablecoin can be pegged to a common fiat currency, such as USD o

The Pegs Antara Module requires interactivity with several additional Antara Modules, including the following:

- The [Gateways](gateways) Module
- The [Gateways](/antara/api/gateways/) Module
- This module acts as a bridge between the Smart Chain where Pegs is active and an external cryptocurrency
- The external cryptocurrency must be based on the Bitcoin protocol
- Typically, this external Smart Chain features a coin, such as KMD, that is tradeable in many venues across the cryptocurrency industry
- On the external cryptocurrency blockchain, a user sends cryptocurrency coins to a multisignature address that is controlled by the Gateways Module, which locks the coins against further spending for the duration of the usage of the Pegs Module
- On the Pegs-related Smart Chain, the Gateways Module then issues to the user [tokens](tokens) that represent the value of the user's locked funds
- The [Tokens](tokens) Module
- On the Pegs-related Smart Chain, the Gateways Module then issues to the user [tokens](/antara/api/tokens/) that represent the value of the user's locked funds
- The [Tokens](/antara/api/tokens/) Module
- This module provides the functionality necessary to manage a cryptocurrency-based token system in coordination with the Gateways Module
- These tokens represent the (now locked) value of the external Bitcoin-protocol or Komodo-protocol based cryptocurrency
- These tokens can be spent and traded as actual cryptocurrency; the user who returns them to the Gateways Module at a later time will unlock and receive the associated external funds
- The [Oracles](oracles) Module
- The [Oracles](/antara/api/oracles/) Module
- This module uses an [oraclefeed](https://github.com/KomodoPlatform/komodo/blob/master/src/cc/dapps/oraclefeed.c) app to provide information to the Gateways Module about tokens a user deposits
- The [Prices](prices) Module
- The [Prices](/antara/api/prices/) Module
- The Prices Module obtains data from a range of external sources (defined by a developer) and makes this information available on the Pegs Smart Chain
- This module utilizes functionality from the Oracles Module to transfer the obtained data from the real world into the digital world
- The Prices Module is responsible for tracking the value of an external asset (including assets external to the Komodo ecosystem) for on-chain price mimicry
Expand All @@ -47,7 +48,7 @@ There are several technical elements involved in the Pegs Antara Module that col

###### Creating a Tokenized Cryptocurrency to Back the Stablecoin

The first aspect relies on three different Antara Modules: [Gateways,](gateways) [Tokens,](tokens) and [Oracles.](oracles)
The first aspect relies on three different Antara Modules: [Gateways,](/antara/api/gateways/) [Tokens,](/antara/api/tokens/) and [Oracles.](/antara/api/oracles/)

On any cryptocurrency blockchain that is built on the Bitcoin protocol, such as `KMD`, users send funds to a multisignature address that is controlled by the Komodo-based Gateways Module that is active on this chain. The Gateways Module locks these funds against further spending at this time.

Expand All @@ -57,7 +58,7 @@ As these tokens are `1:1` representations of the locked funds, the value of thes

###### Creating a Reliable Rate of Exchange Between the Stablecoin and the Backing Cryptocurrency

The second aspect relies on the [Prices](./prices) Antara Module.
The second aspect relies on the [Prices](/antara/api/prices/) Antara Module.

Before the user can exchange their tokens for a stablecoin, the Smart Chain must be able to determine the stablecoin's projected market value (such as the market value of `USD`).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
export const title = "Pegs Module Creator Tutorial";
export const description = "This tutorial assists the reader in discovering the process of creating a new Smart Chain with an active stablecoin using the Pegs Antara Module.";
export const description =
"This tutorial assists the reader in discovering the process of creating a new Smart Chain with an active stablecoin using the Pegs Antara Module.";

# Pegs Module Creator Tutorial

Expand Down Expand Up @@ -494,4 +495,4 @@ Any new node joining the `CREATORUSDK` network must use the new launch parameter

## Test the Setup

Follow the [Pegs Module Tutorial - User](pegs-module-user-tutorial) documentation to continue learning about the Pegs Antara Module.
Follow the [Pegs Module Tutorial - User](/antara/tutorials/pegs-module-user-tutorial) documentation to continue learning about the Pegs Antara Module.
34 changes: 13 additions & 21 deletions src/pages/atomicdex/api/v20-dev/hd_wallets_overview/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
export const title = "AtomicDEX: HD Wallets Overview";
export const description = "This document describes all the methods available to activate coins, generate addresses etc., in Hardware Wallet mode.";
export const description =
"This document describes all the methods available to activate coins, generate addresses etc., in Hardware Wallet mode.";

# HD Wallets Overview

Expand All @@ -9,46 +10,40 @@ For example, you can activate DOC with seed phrase or private key in Iguana mode

To get started, [configure and launch the AtomicDEX API](/atomicdex/setup/), then plug in your Trezor hardware wallet device.


## Initialisation and authentication:

- Initialise connection with your Trezor with [task::init_trezor::init](trezor_initialisation/#task-init-trezor-init)
- Check the status of the connecton with [task::init_trezor::status](trezor_initialisation/#task-init-trezor-status)
- Cancel authentication process with [task::init_trezor::cancel](trezor_initialisation/#task-init-trezor-cancel)
- Authenticate using PIN or phrase with [task::init_trezor::user_action](trezor_initialisation/#task-init-trezor-user-action)

- Initialise connection with your Trezor with [task::init_trezor::init](/atomicdex/api/v20-dev/trezor_initialisation/#task-init-trezor-init)
- Check the status of the connecton with [task::init_trezor::status](/atomicdex/api/v20-dev/trezor_initialisation/#task-init-trezor-status)
- Cancel authentication process with [task::init_trezor::cancel](/atomicdex/api/v20-dev/trezor_initialisation/#task-init-trezor-cancel)
- Authenticate using PIN or phrase with [task::init_trezor::user_action](/atomicdex/api/v20-dev/trezor_initialisation/#task-init-trezor-user-action)

## UTXO Coin Activation in Hardware Mode:

- Use [task::enable_utxo::init](/atomicdex/api/v20-dev/coin_activation_tasks/#task-enable-utxo-init) for UTXO coins like KMD, BTC and DOGE.
- Check the activation status with [task::enable_utxo::status](/atomicdex/api/v20-dev/coin_activation_tasks/#task-enable-utxo-status)
- Authenticate the activation with [task::enable_utxo::user_action](/atomicdex/api/v20-dev/coin_activation_tasks/#task-enable-utxo-user-action)


## QTUM Coin Activation in Hardware Mode:

- Use [task::enable_qtum::init](/atomicdex/api/v20-dev/coin_activation_tasks/#task-enable-qtum-init) for QTUM Ecosystem coins.
- Check the activation status with [task::enable_qtum::status](/atomicdex/api/v20-dev/coin_activation_tasks/#task-enable-qtum-status)
- Authenticate the activation with [task::enable_qtum::user_action](/atomicdex/api/v20-dev/coin_activation_tasks/#task-enable-qtum-user-action)


## Withdrawing your Funds:

- Prepare a transaction with [task::withdraw::init](withdraw_tasks/#withdraw-init)
- Check the status of the transaction preparation with [task::withdraw::status](withdraw_tasks/#withdraw-status)
- Cancel the transaction preparation with [task::withdraw::cancel](withdraw_tasks/#withdraw-cancel)

- Prepare a transaction with [task::withdraw::init](/atomicdex/api/v20-dev/withdraw_tasks/#withdraw-init)
- Check the status of the transaction preparation with [task::withdraw::status](/atomicdex/api/v20-dev/withdraw_tasks/#withdraw-status)
- Cancel the transaction preparation with [task::withdraw::cancel](/atomicdex/api/v20-dev/withdraw_tasks/#withdraw-cancel)

## Viewing Hardware Wallet Coin Balances:

- Initialise the balance request with [task::account_balance::init](account_balance_tasks/#task-account-balance-init)
- Check the status of the balance request with [task::account_balance::status](account_balance_tasks/#task-account-balance-status)

- Initialise the balance request with [task::account_balance::init](/atomicdex/api/v20-dev/account_balance_tasks/#task-account-balance-init)
- Check the status of the balance request with [task::account_balance::status](/atomicdex/api/v20-dev/account_balance_tasks/#task-account-balance-status)

## Creating New Addresses:

- Use [can_get_new_address](hd_address_management/#can-get-new-address) to determine if your current address has been used, or should be updated.
- Use [get_new_address](hd_address_management/#get-new-address) to generate a new address
- Use [can_get_new_address](/atomicdex/api/v20-dev/hd_address_management/#can-get-new-address) to determine if your current address has been used, or should be updated.
- Use [get_new_address](/atomicdex/api/v20-dev/hd_address_management/#get-new-address) to generate a new address

<Note>

Expand All @@ -57,12 +52,10 @@ These methods (and others with a `task::` prefix) will be linked to a numeric

</Note>


## Details for HwError error type

When requesting the status of a task, if an `error_type` of `HwError` is returned, the GUI / User should check the details in `error_data` field to know which action is required (as detailed below).


### FoundUnexpectedDevice

The connected Trezor device has a different pubkey value than what was specified in the `device_pubkey` parameter
Expand All @@ -84,7 +77,6 @@ The connected Trezor device has a different pubkey value than what was specified
}
```


### FoundMultipleDevices

Multiple Trezor devices are plugged in. Remove the additional devices, and keep the one you want to use plugged in.
Expand Down
5 changes: 3 additions & 2 deletions src/pages/atomicdex/api/v20-dev/zhtlc_coins/index.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
export const title = "AtomicDEX: ZHTLC Coin Methods";
export const description = "The methods in this document allow activation and management of ZHTLC coins like ARRR, ZOMBIE.";
export const description =
"The methods in this document allow activation and management of ZHTLC coins like ARRR, ZOMBIE.";

# ZHTLC Coin Methods

ZHTLC coins, like Pirate (ARRR) and the test coin ZOMBIE take a little longer to enable, and use a new two step method to enable. Activation can take a little while the first time, as we need to download some block cache data, and build a wallet database. Subsequent enabling will be faster, but still take a bit longer than other coins. The second step for activation is optional, but allows us to check the status of the activation process.

To withdraw ZHTLC coins, you need to use the [task::withdraw](withdraw_tasks) methods:
To withdraw ZHTLC coins, you need to use the [task::withdraw](/atomicdex/api/v20-dev/withdraw_tasks/) methods:

- Generate a transaction with `task::withdraw::init`
- Query its status with `task::withdraw::status`
Expand Down
6 changes: 3 additions & 3 deletions src/pages/atomicdex/api/v20/enable_erc20/index.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
export const title = "AtomicDEX Method: Enable ERC20";
export const description = "The enable_erc20 method allows you to activate additional ERC20 like tokens of a EVM type platform coin.";
export const description =
"The enable_erc20 method allows you to activate additional ERC20 like tokens of a EVM type platform coin.";

# enable_erc20

The `enable_erc20` method allows you to activate additional ERC20 like tokens of a EVM type platform coin. Before using this method, you first need to use the [enable_eth_with_tokens](enable_eth_with_tokens) method.
The `enable_erc20` method allows you to activate additional ERC20 like tokens of a EVM type platform coin. Before using this method, you first need to use the [enable_eth_with_tokens](/atomicdex/api/v20/enable_eth_with_tokens/) method.

| parameter | Type | Description |
| ---------------------------------------- | ------- | -------------------------------------------------------------------------------------------------- |
Expand All @@ -26,7 +27,6 @@ The `enable_erc20` method allows you to activate additional ERC20 like tokens of
```
</CodeGroup>


## Response

```json
Expand Down
6 changes: 3 additions & 3 deletions src/pages/atomicdex/api/v20/enable_slp/index.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
export const title = "AtomicDEX Method: Enable SLP";
export const description = "The enable_slp method allows you to activate additional SLP tokens.";
export const description =
"The enable_slp method allows you to activate additional SLP tokens.";

# enable_slp

The `enable_slp` method allows you to activate additional SLP tokens. Before using this method, you first need to use the [enable_bch_with_tokens](enable_bch_with_tokens) method.
The `enable_slp` method allows you to activate additional SLP tokens. Before using this method, you first need to use the [enable_bch_with_tokens](/atomicdex/api/v20/enable_bch_with_tokens) method.

| parameter | Type | Description |
| ---------------------------------------- | ------- | -------------------------------------------------------------------------------------------------- |
Expand All @@ -26,7 +27,6 @@ The `enable_slp` method allows you to activate additional SLP tokens. Before usi
```
</CodeGroup>


## Response

```json
Expand Down
6 changes: 3 additions & 3 deletions src/pages/atomicdex/api/v20/enable_tendermint_token/index.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
export const title = "AtomicDEX Method: Enable Tendermint Token";
export const description = "The enable_tendermint_token method allows you to activate additional Tendermint assets.";
export const description =
"The enable_tendermint_token method allows you to activate additional Tendermint assets.";

# enable_tendermint_token

The `enable_tendermint_token` method allows you to activate additional Tendermint assets. Before using this method, you first need to use the [enable_tendermint_with_assets](enable_tendermint_with_assets) method.
The `enable_tendermint_token` method allows you to activate additional Tendermint assets. Before using this method, you first need to use the [enable_tendermint_with_assets](/atomicdex/api/v20/enable_tendermint_with_assets) method.

| parameter | Type | Description |
| ---------------------------------------- | ------- | -------------------------------------------------------------------------------------------------- |
Expand All @@ -26,7 +27,6 @@ The `enable_tendermint_token` method allows you to activate additional Tendermin
```
</CodeGroup>


## Response

```json
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
export const title = "Delayed Proof of Work";
export const description = "Komodo’s form of providing security is called Delayed Proof of Work (dPoW). It builds on the most advanced form of blockchain security in existence.";
export const description =
"Komodo’s form of providing security is called Delayed Proof of Work (dPoW). It builds on the most advanced form of blockchain security in existence.";

# Delayed Proof of Work

Expand Down Expand Up @@ -531,7 +532,7 @@ The nature of mining in the Komodo ecosystem serves as an incentive to motivate

The Komodo network on a surface-level is a minable network, like other PoW networks. Any technically savvy user can activate a device capable of mining the Komodo network, and thereby process users’ transactions, mine blocks, and receive rewards. For these miners, the Komodo protocol functions in almost the exact same manner as the Bitcoin blockchain.

Understanding the similarities will explain to the reader the motivations for the notary nodes and other Komodo miners to secure the Komodo network. The differences, on the other hand, are explained [in another section of the Core Technology Discussions.](start-here/core-technology-discussions/miscellaneous#details-regarding-kmd-main-chain)
Understanding the similarities will explain to the reader the motivations for the notary nodes and other Komodo miners to secure the Komodo network. The differences, on the other hand, are explained [in another section of the Core Technology Discussions.](/start-here/core-technology-discussions/miscellaneous/#details-regarding-kmd-main-chain)

<i>
(See the section regarding the 5.1% rewards allocated to all users who hold at
Expand Down Expand Up @@ -624,7 +625,7 @@ On a default PoW-based Smart Chain, therefore, the recipient of any transaction
An important aside here is that Komodo Smart Chains have additional settings
beyond the default PoW-based setup that reduce the time required to wait for
notarizations. In some instances, the waiting time can be eliminated. The
[Channels Antara Module](antara/api/channels/#introduction) is an effective
[Channels Antara Module](/antara/api/channels/#introduction) is an effective
example, as this module allows instantaneous secure transactions.
</Note>

Expand Down
Loading
Loading