Skip to content
Merged
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
61 changes: 61 additions & 0 deletions docs/build/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,67 @@

* [✅ Clarity 4 is now LIVE! ](whats-new/clarity-4-is-now-live.md)

## Learn Clarinet

* [Overview](clarinet/overview.md)
* [Quickstart](clarinet/quickstart.md)
* [Project Structure](clarinet/project-structure.md)
* [Project Development](clarinet/project-development.md)
* [Contract Interaction](clarinet/contract-interaction.md)
* [Validation and Analysis](clarinet/validation-and-analysis.md)
* [Clarity Formatter](clarinet/clarity-formatter.md)
* [Local Blockchain Development](clarinet/local-blockchain-development.md)
* [Contract Deployment](clarinet/contract-deployment.md)
* [FAQ](clarinet/faq.md)

## Clarinet JS SDK

* [Overview](clarinet-js-sdk/overview.md)
* [Unit Testing](clarinet-js-sdk/unit-testing.md)
* [Integration Testing](clarinet-js-sdk/integration-testing.md)
* [Mainnet Execution Simulation](clarinet-js-sdk/mainnet-execution-simulation.md)

## Clarinet Integrations

* [Pyth Oracle Integration](clarinet-integrations/pyth-oracle-integration.md)
* [Chainhook Integration](clarinet-integrations/chainhook-integration.md)
* [Stacks.js Integration](clarinet-integrations/stacks.js-integration.md)
* [sBTC Integration](clarinet-integrations/sbtc-integration.md)
* [VSCode Extension](clarinet-integrations/vscode-extension.md)

## Learn Stacks.js

* [Overview](stacks.js/overview.md)
* [Accounts & Addresses](stacks.js/accounts-and-addresses.md)
* [Private Keys](stacks.js/private-keys.md)
* [Networks](stacks.js/networks.md)
* [Read Only Calls](stacks.js/read-only-calls.md)
* [Build Transactions](stacks.js/build-transactions.md)
* [Contract Calls](stacks.js/contract-calls.md)
* [Contract Deployment](stacks.js/contract-deployment.md)
* [Address Validation](stacks.js/address-validation.md)
* [Encoding & Decoding](stacks.js/encoding-and-decoding.md)
* [Network Configuration](stacks.js/network-configuration.md)
* [Unit Conversion](stacks.js/unit-conversion.md)

## Stacks Connect

* [Connect Wallet](stacks-connect/connect-wallet.md)
* [Broadcast Transactions](stacks-connect/broadcast-transactions.md)
* [Message Signing](stacks-connect/message-signing.md)
* [Migration Guide](stacks-connect/migration-guide.md)
* [Wallet Support](stacks-connect/wallet-support.md)

## Post-Conditions

* [Overview](post-conditions/overview.md)
* [Implementing Post Conditions](post-conditions/implementing-post-conditions.md)

## Stacks.js Integrations

* [Pyth Oracle Integration](stacks.js-integrations/pyth-oracle-integration.md)
* [React Native Integration](stacks.js-integrations/react-native-integration.md)

***

* [Bitcoin Integration](bitcoin-integration/README.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Practical guide to testing smart contracts with the Clarinet JS SDK

# Overview

<figure><img src="../.gitbook/assets/image (1) (1).png" alt=""><figcaption><p>source: <a href="https://www.hiro.so/blog/announcing-the-clarinet-sdk-a-javascript-programming-model-for-easy-smart-contract-testing">Hiro blog</a></p></figcaption></figure>
<figure><img src="../.gitbook/assets/clarinet-sdk.png" alt=""><figcaption><p>source: <a href="https://www.hiro.so/blog/announcing-the-clarinet-sdk-a-javascript-programming-model-for-easy-smart-contract-testing">Hiro blog</a></p></figcaption></figure>

The Clarinet JS SDK provides a powerful testing framework for Clarity smart contracts. It integrates with Vitest to let you run comprehensive tests against a simulated blockchain environment.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ Advance the chain to test time-dependent logic:

> **Tip: Console reference**
>
> For a complete list of console commands, see the [CLI reference](cli-reference.md).
> For a complete list of console commands, see the [CLI reference](../../reference/clarinet/cli-reference.md).

## Common issues

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ description: >-

Clarinet is the fastest way to build, test, and deploy smart contracts on the Stacks blockchain. It gives you a local devnet, REPL, testing framework, and debugging tools to ship high-quality Clarity code with confidence.

<div data-with-frame="true"><figure><img src="../.gitbook/assets/image (1).png" alt=""><figcaption></figcaption></figure></div>
<div data-with-frame="true"><figure><img src="../.gitbook/assets/clarinet-diagram.png" alt=""><figcaption></figcaption></figure></div>

## Key features

* [**Leverage a powerful CLI**](cli-reference.md) - Create new projects, manage your smart contracts and their dependencies using clarinet requirements, and interact with your code through the built-in REPL.
* [**Leverage a powerful CLI**](../../reference/clarinet/cli-reference.md) - Create new projects, manage your smart contracts and their dependencies using clarinet requirements, and interact with your code through the built-in REPL.
* [**Write unit tests with the SDK**](../clarinet-js-sdk/unit-testing.md) - Use the Clarinet SDK to write unit tests in a familiar JS environment and validate contract behavior.
* [**Run a private blockchain environment**](local-blockchain-development.md) - Spin up a local devnet with nodes, miners, and APIs so you can test and integrate your code.
* [**VSCode extension**](../clarinet-integrations/vscode-extension.md) - Linter, step by step debugger, helps writing smart contracts (autocompletion, documentation etc).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Typically, we speak of `mainnet` and `testnet` as the networks of Stacks. Most w

As the name suggests, `testnet` is a public network for testing. It's a separate blockchain state that holds test tokens, which have no value.

For completeness we also mention `devnet`. This isn't "one" network, but how developers refer to ephemeral local networks used for testing. It is the same as `testnet`, but for local development. [Learn more](../clarinet/local-blockchain-development.md).
For completeness we also mention `devnet`. This isn't "one" network, but how developers refer to ephemeral local networks used for testing. It is the same as `testnet`, but for local development. [Learn more](../../build/clarinet/local-blockchain-development.md).

## Setting the network

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Overview

<figure><img src="../.gitbook/assets/image (3).png" alt=""><figcaption><p>source: <a href="https://www.hiro.so/blog/taking-a-look-at-recent-stacks-js-improvements">Hiro blog</a></p></figcaption></figure>
<figure><img src="../.gitbook/assets/stacksjs-learn.png" alt=""><figcaption><p>source: <a href="https://www.hiro.so/blog/taking-a-look-at-recent-stacks-js-improvements">Hiro blog</a></p></figcaption></figure>

## Overview

Expand Down
55 changes: 0 additions & 55 deletions docs/reference/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,68 +15,13 @@

## Clarinet

* [Overview](clarinet/overview.md)
* [Quickstart](clarinet/quickstart.md)
* [Project Structure](clarinet/project-structure.md)
* [Project Development](clarinet/project-development.md)
* [Contract Interaction](clarinet/contract-interaction.md)
* [Validation and Analysis](clarinet/validation-and-analysis.md)
* [Clarity Formatter](clarinet/clarity-formatter.md)
* [Local Blockchain Development](clarinet/local-blockchain-development.md)
* [Contract Deployment](clarinet/contract-deployment.md)
* [CLI Reference](clarinet/cli-reference.md)
* [FAQ](clarinet/faq.md)

## Clarinet JS SDK

* [Overview](clarinet-js-sdk/overview.md)
* [Unit Testing](clarinet-js-sdk/unit-testing.md)
* [Integration Testing](clarinet-js-sdk/integration-testing.md)
* [Mainnet Execution Simulation](clarinet-js-sdk/mainnet-execution-simulation.md)
* [SDK Reference](clarinet-js-sdk/sdk-reference.md)
* [Browser SDK Reference](clarinet-js-sdk/browser-sdk-reference.md)

## Clarinet Integrations

* [Pyth Oracle Integration](clarinet-integrations/pyth-oracle-integration.md)
* [Chainhook Integration](clarinet-integrations/chainhook-integration.md)
* [Stacks.js Integration](clarinet-integrations/stacks.js-integration.md)
* [sBTC Integration](clarinet-integrations/sbtc-integration.md)
* [VSCode Extension](clarinet-integrations/vscode-extension.md)

## Stacks.js

* [Overview](stacks.js/overview.md)
* [Accounts & Addresses](stacks.js/accounts-and-addresses.md)
* [Private Keys](stacks.js/private-keys.md)
* [Networks](stacks.js/networks.md)
* [Read Only Calls](stacks.js/read-only-calls.md)
* [Build Transactions](stacks.js/build-transactions.md)
* [Contract Calls](stacks.js/contract-calls.md)
* [Contract Deployment](stacks.js/contract-deployment.md)
* [Address Validation](stacks.js/address-validation.md)
* [Encoding & Decoding](stacks.js/encoding-and-decoding.md)
* [Network Configuration](stacks.js/network-configuration.md)
* [Unit Conversion](stacks.js/unit-conversion.md)

## Stacks Connect

* [Connect Wallet](stacks-connect/connect-wallet.md)
* [Broadcast Transactions](stacks-connect/broadcast-transactions.md)
* [Message Signing](stacks-connect/message-signing.md)
* [Migration Guide](stacks-connect/migration-guide.md)
* [Wallet Support](stacks-connect/wallet-support.md)

## Post-Conditions

* [Overview](post-conditions/overview.md)
* [Implementing Post Conditions](post-conditions/implementing-post-conditions.md)

## Stacks.js Integrations

* [Pyth Oracle Integration](stacks.js-integrations/pyth-oracle-integration.md)
* [React Native Integration](stacks.js-integrations/react-native-integration.md)

## Stacks.js References

* [@stacks/network](stacks.js-references/stacks-network.md)
Expand Down