diff --git a/src/common/navigation.yaml b/src/common/navigation.yaml index 8b4758d7..dad773f7 100644 --- a/src/common/navigation.yaml +++ b/src/common/navigation.yaml @@ -70,7 +70,7 @@ sections: - path: /glossary - path: /deploy-tips - external: - href: 'https://blockstack.github.io/stacks-blockchain-api/' + href: 'https://hirosystems.github.io/stacks-blockchain-api/' title: Stacks Blockchain API - path: /stacks-node-configuration - external: diff --git a/src/pages/contributing.md b/src/pages/contributing.md index 3ba89629..1ebc4b60 100644 --- a/src/pages/contributing.md +++ b/src/pages/contributing.md @@ -56,6 +56,7 @@ see a button in the upper right of the screen that says "Fork." [You can read ab This is a generalized workflow for contributing to these docs: - Clone your fork to your local machine with this command `git clone git@github.com:/docs.blockstack.git` +- Enter your project folder `cd docs.blockstack` - Create a branch `git checkout -b feat/my-feature-branch`. - Run the command `yarn` to install all of the dependencies. - Make the changes you wish and then commit them with this kind of message: `git commit -am "feat: some new feature or content"`. diff --git a/src/pages/references/stacking-contract.md b/src/pages/references/stacking-contract.md index acc36e78..09e7d1ad 100644 --- a/src/pages/references/stacking-contract.md +++ b/src/pages/references/stacking-contract.md @@ -8,7 +8,7 @@ import { StackingErrorcodeReference, StackingFunctionReference } from '@componen ## 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://blockstack.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://hirosystems.github.io/stacks-blockchain-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. diff --git a/src/pages/understand-stacks/accounts.md b/src/pages/understand-stacks/accounts.md index fad97d95..193ae9dc 100644 --- a/src/pages/understand-stacks/accounts.md +++ b/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 -STX balance and nonce can be obtained through the [`GET /v2/accounts/`](https://blockstack.github.io/stacks-blockchain-api/#operation/get_account_info) endpoint: +STX balance and nonce can be obtained through the [`GET /v2/accounts/`](https://hirosystems.github.io/stacks-blockchain-api/#operation/get_account_info) endpoint: ```bash # for mainnet, replace `testnet` with `mainnet` @@ -141,7 +141,7 @@ Sample response: ### Get all token balances -All token balances can be obtained through the [`GET /extended/v1/address//balances`](https://blockstack.github.io/stacks-blockchain-api/#operation/get_account_balance) endpoint: +All token balances can be obtained through the [`GET /extended/v1/address//balances`](https://hirosystems.github.io/stacks-blockchain-api/#operation/get_account_balance) endpoint: ```bash # for mainnet, replace `testnet` with `mainnet` @@ -166,7 +166,7 @@ Sample response: ### Get all asset events -All asset events associated with the account can be obtained through the [`GET /extended/v1/address//assets`](https://blockstack.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//assets`](https://hirosystems.github.io/stacks-blockchain-api/#operation/get_account_balance) endpoint: ```bash # for mainnet, replace `testnet` with `mainnet` diff --git a/src/pages/understand-stacks/network.md b/src/pages/understand-stacks/network.md index 6fa92c6d..7255d28c 100644 --- a/src/pages/understand-stacks/network.md +++ b/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. -Fee estimates can obtained through the [`GET /v2/fees/transfer`](https://blockstack.github.io/stacks-blockchain-api/#operation/get_fee_transfer) endpoint: +Fee estimates can obtained through the [`GET /v2/fees/transfer`](https://hirosystems.github.io/stacks-blockchain-api/#operation/get_fee_transfer) endpoint: ```bash # 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. -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://blockstack.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://hirosystems.github.io/stacks-blockchain-api/#operation/get_network_block_times) endpoint: ```bash # 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 -A read-only contract call can be done using the [`POST /v2/contracts/call-read///`](https://blockstack.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///`](https://hirosystems.github.io/stacks-blockchain-api/#operation/call_read_only_function) endpoint: ```bash # 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 -The network information can be obtained using the [`GET /v2/info`](https://blockstack.github.io/stacks-blockchain-api/#operation/get_core_api_info) endpoint: +The network information can be obtained using the [`GET /v2/info`](https://hirosystems.github.io/stacks-blockchain-api/#operation/get_core_api_info) endpoint: ```bash # for mainnet, replace `testnet` with `mainnet` diff --git a/src/pages/understand-stacks/stacks-blockchain-api.md b/src/pages/understand-stacks/stacks-blockchain-api.md index c94ca31a..c263a218 100644 --- a/src/pages/understand-stacks/stacks-blockchain-api.md +++ b/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: -- [POST /v2/transactions](https://blockstack.github.io/stacks-blockchain-api/#operation/post_core_node_transactions) -- [GET /v2/contracts/interface/{contract_address}/{contract_name}](https://blockstack.github.io/stacks-blockchain-api/#operation/get_contract_interface) -- [POST /v2/map_entry/{contract_address}/{contract_name}/{map_name}](https://blockstack.github.io/stacks-blockchain-api/#operation/get_contract_data_map_entry) -- [GET /v2/contracts/source/{contract_address}/{contract_name}](https://blockstack.github.io/stacks-blockchain-api/#operation/get_contract_source) -- [GET /v2/accounts/{principal}](https://blockstack.github.io/stacks-blockchain-api/#operation/get_account_info) -- [POST /v2/contracts/call-read/{contract_address}/{contract_name}/{function_name}](https://blockstack.github.io/stacks-blockchain-api/#operation/call_read_only_function) -- [GET /v2/fees/transfer](https://blockstack.github.io/stacks-blockchain-api/#operation/get_fee_transfer) -- [GET /v2/info](https://blockstack.github.io/stacks-blockchain-api/#operation/get_core_api_info) +- [POST /v2/transactions](https://hirosystems.github.io/stacks-blockchain-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) +- [POST /v2/map_entry/{contract_address}/{contract_name}/{map_name}](https://hirosystems.github.io/stacks-blockchain-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/accounts/{principal}](https://hirosystems.github.io/stacks-blockchain-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) +- [GET /v2/fees/transfer](https://hirosystems.github.io/stacks-blockchain-api/#operation/get_fee_transfer) +- [GET /v2/info](https://hirosystems.github.io/stacks-blockchain-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`. diff --git a/src/pages/understand-stacks/testnet.md b/src/pages/understand-stacks/testnet.md index 638415c6..407822eb 100644 --- a/src/pages/understand-stacks/testnet.md +++ b/src/pages/understand-stacks/testnet.md @@ -21,7 +21,7 @@ https://stacks-node-api.testnet.stacks.co/ ### 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://blockstack.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://hirosystems.github.io/stacks-blockchain-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." diff --git a/src/pages/understand-stacks/transactions.md b/src/pages/understand-stacks/transactions.md index 1f89af05..bf7bb4a1 100644 --- a/src/pages/understand-stacks/transactions.md +++ b/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 | | 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://blockstack.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://hirosystems.github.io/stacks-blockchain-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).