Browse Source

chore: fix hiro api reference urls

friedger-patch-7
Alexander Graebe 3 years ago
parent
commit
1ebc5ab0ea
  1. 2
      src/pages/references/stacking-contract.md
  2. 6
      src/pages/understand-stacks/accounts.md
  3. 8
      src/pages/understand-stacks/network.md
  4. 16
      src/pages/understand-stacks/stacks-blockchain-api.md
  5. 2
      src/pages/understand-stacks/testnet.md
  6. 2
      src/pages/understand-stacks/transactions.md

2
src/pages/references/stacking-contract.md

@ -8,7 +8,7 @@ import { StackingErrorcodeReference, StackingFunctionReference } from '@componen
## Introduction ## Introduction
Stacking is implemented as a smart contract using Clarity. You can always find the Stacking contract identifier using the Stacks Blockchain API [`v2/pox` endpoint](https://hirosystems.github.io/stacks-blockchain-api/#operation/get_pox_info). Stacking is implemented as a smart contract using Clarity. You can always find the Stacking contract identifier using the Stacks Blockchain API [`v2/pox` endpoint](https://docs.hiro.so/api#operation/get_pox_info).
Below is a list of public and read-only functions as well as error codes that can be returned by those methods. Below is a list of public and read-only functions as well as error codes that can be returned by those methods.

6
src/pages/understand-stacks/accounts.md

@ -121,7 +121,7 @@ Full documentation available at [stacks-gen](https://github.com/psq/stacks-gen).
### Get Stacks (STX) balance and nonce ### Get Stacks (STX) balance and nonce
STX balance and nonce can be obtained through the [`GET /v2/accounts/<stx_address>`](https://hirosystems.github.io/stacks-blockchain-api/#operation/get_account_info) endpoint: STX balance and nonce can be obtained through the [`GET /v2/accounts/<stx_address>`](https://docs.hiro.so/api#operation/get_account_info) endpoint:
```bash ```bash
# for mainnet, replace `testnet` with `mainnet` # for mainnet, replace `testnet` with `mainnet`
@ -141,7 +141,7 @@ Sample response:
### Get all token balances ### Get all token balances
All token balances can be obtained through the [`GET /extended/v1/address/<stx_address>/balances`](https://hirosystems.github.io/stacks-blockchain-api/#operation/get_account_balance) endpoint: All token balances can be obtained through the [`GET /extended/v1/address/<stx_address>/balances`](https://docs.hiro.so/api#operation/get_account_balance) endpoint:
```bash ```bash
# for mainnet, replace `testnet` with `mainnet` # for mainnet, replace `testnet` with `mainnet`
@ -166,7 +166,7 @@ Sample response:
### Get all asset events ### Get all asset events
All asset events associated with the account can be obtained through the [`GET /extended/v1/address/<stx_address>/assets`](https://hirosystems.github.io/stacks-blockchain-api/#operation/get_account_balance) endpoint: All asset events associated with the account can be obtained through the [`GET /extended/v1/address/<stx_address>/assets`](https://docs.hiro.so/api#operation/get_account_balance) endpoint:
```bash ```bash
# for mainnet, replace `testnet` with `mainnet` # for mainnet, replace `testnet` with `mainnet`

8
src/pages/understand-stacks/network.md

@ -17,7 +17,7 @@ STX amounts should be stored as integers (8 bytes long), and represent the amoun
Fees are used to incentivize miners to confirm transactions on the Stacks 2.0 blockchain. The fee is calculated based on the estimate fee rate and the size of the raw transaction in bytes. The fee rate is a market determined variable. For the [testnet](/understand-stacks/testnet), it is set to 1 micro-STX. Fees are used to incentivize miners to confirm transactions on the Stacks 2.0 blockchain. The fee is calculated based on the estimate fee rate and the size of the raw transaction in bytes. The fee rate is a market determined variable. For the [testnet](/understand-stacks/testnet), it is set to 1 micro-STX.
Fee estimates can obtained through the [`GET /v2/fees/transfer`](https://hirosystems.github.io/stacks-blockchain-api/#operation/get_fee_transfer) endpoint: Fee estimates can obtained through the [`GET /v2/fees/transfer`](https://docs.hiro.so/api#operation/get_fee_transfer) endpoint:
```bash ```bash
# for mainnet, replace `testnet` with `mainnet` # for mainnet, replace `testnet` with `mainnet`
@ -58,7 +58,7 @@ The time to mine a block, to confirm transactions, will eventually match the exp
-> Transactions can also be mined in [microblocks](/understand-stacks/microblocks), reducing the latency significantly. -> Transactions can also be mined in [microblocks](/understand-stacks/microblocks), reducing the latency significantly.
The block time is hardcoded and will change throughout the implementation phases of the [testnet](/understand-stacks/testnet). The current block time can be obtained through the [`GET /extended/v1/info/network_block_times`](https://hirosystems.github.io/stacks-blockchain-api/#operation/get_network_block_times) endpoint: The block time is hardcoded and will change throughout the implementation phases of the [testnet](/understand-stacks/testnet). The current block time can be obtained through the [`GET /extended/v1/info/network_block_times`](https://docs.hiro.so/api#operation/get_network_block_times) endpoint:
```bash ```bash
# for mainnet, replace `testnet` with `mainnet` # for mainnet, replace `testnet` with `mainnet`
@ -86,7 +86,7 @@ However, for read-only function calls, transactions are **not** required. Instea
-> Read-only function calls do not require transaction fees -> Read-only function calls do not require transaction fees
A read-only contract call can be done using the [`POST /v2/contracts/call-read/<stx_address>/<contract_name>/<function_name>`](https://hirosystems.github.io/stacks-blockchain-api/#operation/call_read_only_function) endpoint: A read-only contract call can be done using the [`POST /v2/contracts/call-read/<stx_address>/<contract_name>/<function_name>`](https://docs.hiro.so/api#operation/call_read_only_function) endpoint:
```bash ```bash
# for mainnet, replace `testnet` with `mainnet` # for mainnet, replace `testnet` with `mainnet`
@ -119,7 +119,7 @@ The [status checker](https://stacks-status.com/) is a service that provides a us
### Network info ### Network info
The network information can be obtained using the [`GET /v2/info`](https://hirosystems.github.io/stacks-blockchain-api/#operation/get_core_api_info) endpoint: The network information can be obtained using the [`GET /v2/info`](https://docs.hiro.so/api#operation/get_core_api_info) endpoint:
```bash ```bash
# for mainnet, replace `testnet` with `mainnet` # for mainnet, replace `testnet` with `mainnet`

16
src/pages/understand-stacks/stacks-blockchain-api.md

@ -34,13 +34,13 @@ The Stacks 2.0 Blockchain API is centrally hosted. However, every running Stacks
While the Node RPC API doesn't give the same functionality as the hosted Stacks 2.0 Blockchain API, you get similar functionality in a way that is scoped to that specific node. The RPC API includes the following endpoints: While the Node RPC API doesn't give the same functionality as the hosted Stacks 2.0 Blockchain API, you get similar functionality in a way that is scoped to that specific node. The RPC API includes the following endpoints:
- [POST /v2/transactions](https://hirosystems.github.io/stacks-blockchain-api/#operation/post_core_node_transactions) - [POST /v2/transactions](https://docs.hiro.so/api#operation/post_core_node_transactions)
- [GET /v2/contracts/interface/{contract_address}/{contract_name}](https://hirosystems.github.io/stacks-blockchain-api/#operation/get_contract_interface) - [GET /v2/contracts/interface/{contract_address}/{contract_name}](https://docs.hiro.so/api#operation/get_contract_interface)
- [POST /v2/map_entry/{contract_address}/{contract_name}/{map_name}](https://hirosystems.github.io/stacks-blockchain-api/#operation/get_contract_data_map_entry) - [POST /v2/map_entry/{contract_address}/{contract_name}/{map_name}](https://docs.hiro.so/api#operation/get_contract_data_map_entry)
- [GET /v2/contracts/source/{contract_address}/{contract_name}](https://hirosystems.github.io/stacks-blockchain-api/#operation/get_contract_source) - [GET /v2/contracts/source/{contract_address}/{contract_name}](https://docs.hiro.so/api#operation/get_contract_source)
- [GET /v2/accounts/{principal}](https://hirosystems.github.io/stacks-blockchain-api/#operation/get_account_info) - [GET /v2/accounts/{principal}](https://docs.hiro.so/api#operation/get_account_info)
- [POST /v2/contracts/call-read/{contract_address}/{contract_name}/{function_name}](https://hirosystems.github.io/stacks-blockchain-api/#operation/call_read_only_function) - [POST /v2/contracts/call-read/{contract_address}/{contract_name}/{function_name}](https://docs.hiro.so/api#operation/call_read_only_function)
- [GET /v2/fees/transfer](https://hirosystems.github.io/stacks-blockchain-api/#operation/get_fee_transfer) - [GET /v2/fees/transfer](https://docs.hiro.so/api#operation/get_fee_transfer)
- [GET /v2/info](https://hirosystems.github.io/stacks-blockchain-api/#operation/get_core_api_info) - [GET /v2/info](https://docs.hiro.so/api#operation/get_core_api_info)
~> If you run a local node, it exposes an HTTP server on port `20443`. The info endpoint would be `localhost:20443/v2/info`. ~> If you run a local node, it exposes an HTTP server on port `20443`. The info endpoint would be `localhost:20443/v2/info`.

2
src/pages/understand-stacks/testnet.md

@ -21,7 +21,7 @@ https://stacks-node-api.testnet.stacks.co/
### Faucet ### Faucet
The testnet faucet provides you with free Stacks Token (STX) to test with. These are not the same as STX on mainnet and have no value. You can get STX from the faucet on the [Stacks Explorer Sandbox](https://explorer.stacks.co/sandbox/faucet?chain=testnet), or using the [API](https://hirosystems.github.io/stacks-blockchain-api/#tag/Faucets). The testnet faucet provides you with free Stacks Token (STX) to test with. These are not the same as STX on mainnet and have no value. You can get STX from the faucet on the [Stacks Explorer Sandbox](https://explorer.stacks.co/sandbox/faucet?chain=testnet), or using the [API](https://docs.hiro.so/api#tag/Faucets).
To get STX tokens from within the Explorer Sandbox, navigate to the "Faucet" tab and click "Request STX" button. If you would like to get enough STX tokens to try out [Stacking](/understand-stacks/stacking), and click "I want to stack." To get STX tokens from within the Explorer Sandbox, navigate to the "Faucet" tab and click "Request STX" button. If you would like to get enough STX tokens to try out [Stacking](/understand-stacks/stacking), and click "I want to stack."

2
src/pages/understand-stacks/transactions.md

@ -38,6 +38,6 @@ The Stacks 2.0 supports a set of different transaction types:
| Contract call | `contract_call` | Contract call for a public, non read-only function | | Contract call | `contract_call` | Contract call for a public, non read-only function |
| Poison Microblock | `poison_microblock` | Punish leaders who intentionally equivocate about the microblocks they package | | Poison Microblock | `poison_microblock` | Punish leaders who intentionally equivocate about the microblocks they package |
A sample of each transaction type can be found in the [Stacks Blockchain API response definition for transactions](https://hirosystems.github.io/stacks-blockchain-api/#operation/get_transaction_by_id). A sample of each transaction type can be found in the [Stacks Blockchain API response definition for transactions](https://docs.hiro.so/api#operation/get_transaction_by_id).
~> Read-only contract call calls do **not** require transactions. Read more about it in the [network guide](/understand-stacks/network#read-only-function-calls). ~> Read-only contract call calls do **not** require transactions. Read more about it in the [network guide](/understand-stacks/network#read-only-function-calls).

Loading…
Cancel
Save