Skip to content

Commit d63a4c1

Browse files
feat: use @stacks/clarinet-sdk (#1744)
* feat: use @stacks/clarinet-sdk * fix: update other references to hirosystems repo and packages * chore: update repos-to-monitor * chore: remove package-lock --------- Co-authored-by: eric <eric@stackslabs.com>
1 parent 3c0f5f9 commit d63a4c1

File tree

13 files changed

+40
-58
lines changed

13 files changed

+40
-58
lines changed

docs/build/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -669,7 +669,7 @@ Now that you have the basics down, here are some ways to continue your Stacks de
669669

670670
### Development Tools
671671

672-
* [**Clarinet**](https://github.com/hirosystems/clarinet): Local development environment for Clarity
672+
* [**Clarinet**](https://github.com/stx-labs/clarinet): Local development environment for Clarity
673673
* [**Hiro Platform**](https://platform.hiro.so/): Hosted development environment
674674
* [**Stacks Explorer**](https://explorer.stacks.co/): View transactions and contracts on mainnet
675675

docs/build/build-a-frontend/post-conditions-with-stacks.js.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ So they are sent as part of the transaction when the user initiates it, meaning
1010

1111
Whenever you are transferring an asset (fungible or non-fungible) from one address to another, you should take advantage of post conditions.
1212

13-
We're going to use [Stacks.js](https://github.com/hirosystems/stacks.js/tree/master/packages/transactions#post-conditions) to familiarize ourselves with them.
13+
We're going to use [Stacks.js](https://github.com/stx-labs/stacks.js/tree/master/packages/transactions#post-conditions) to familiarize ourselves with them.
1414

1515
### STX Post Condition
1616

docs/learn/network-fundamentals/accounts.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ An account is generated from a 24-word mnemonic phrase. This is often referred t
3030
If the seed phrase is lost, access to the associated account cannot be restored. No person or organization can recover a lost seed phrase.
3131
{% endhint %}
3232

33-
The easiest way to generate a new Stacks account is to use the [Stacks CLI](https://github.com/hirosystems/stacks.js/tree/master/packages/cli):
33+
The easiest way to generate a new Stacks account is to use the [Stacks CLI](https://github.com/stx-labs/stacks.js/tree/master/packages/cli):
3434

3535
{% code title="Generate a new account (CLI)" %}
3636
```bash
@@ -78,7 +78,7 @@ Note that a new account automatically exists for each new private key. There is
7878
Addresses are created by generating the [RIPEMD-160 hash](https://en.wikipedia.org/wiki/RIPEMD#RIPEMD-160_hashes) of the [SHA256](https://en.bitcoinwiki.org/wiki/SHA-256) of the public key. BTC addresses are encoded with [Base58Check](https://bitcoin.it/wiki/Base58Check_encoding). For Stacks addresses, [c32check](https://github.com/stacks-network/c32check) is used. Deriving an address from a public key can be done without internet access, for instance using the c32check `c32addressDecode` method.
7979
{% endhint %}
8080

81-
Alternatively to the CLI creation, the [Stacks Transactions JS](https://github.com/hirosystems/stacks.js/tree/master/packages/transactions) library can be used:
81+
Alternatively to the CLI creation, the [Stacks Transactions JS](https://github.com/stx-labs/stacks.js/tree/master/packages/transactions) library can be used:
8282

8383
{% code title="Generate a private key & derive address (transactions library)" %}
8484
```js

docs/learn/network-fundamentals/network-basics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,14 @@ The API will respond with the fee rate (as integer):
3131
1
3232
```
3333

34-
[The Stacks Transactions JS library](https://github.com/hirosystems/stacks.js/tree/master/packages/transactions) supports fee estimation for:
34+
[The Stacks Transactions JS library](https://github.com/stx-labs/stacks.js/tree/master/packages/transactions) supports fee estimation for:
3535

3636
* token transfers (`estimateTransfer`)
3737
* contract deploys (`estimateContractDeploy`)
3838
* non read-only contract calls (`estimateContractFunctionCall`)
3939

4040
{% hint style="info" %}
41-
For an implementation using a different language than JavaScript, please review [this reference implementation](https://github.com/hirosystems/stacks.js/blob/master/packages/transactions/src/builders.ts#L97).
41+
For an implementation using a different language than JavaScript, please review [this reference implementation](https://github.com/stx-labs/stacks.js/blob/master/packages/transactions/src/builders.ts#L97).
4242
{% endhint %}
4343

4444
### Nonces

docs/operate/stacking-stx/operate-a-stacking-pool.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -397,7 +397,7 @@ Additionally, you can choose to call the stacking functions directly from the [d
397397

398398
The fields and process will be the same, but the UI will differ.
399399

400-
Finally, you can stack using JS and the [@stacks/stacking](https://github.com/hirosystems/stacks.js/tree/main/packages/stacking) package if you prefer. Again, the functions and parameters will be the same, you will just be writing your JS code directly instead of using a UI.
400+
Finally, you can stack using JS and the [@stacks/stacking](https://github.com/stx-labs/stacks.js/tree/main/packages/stacking) package if you prefer. Again, the functions and parameters will be the same, you will just be writing your JS code directly instead of using a UI.
401401

402402
If you are interested in using this method, you'll want to follow the [stacking guide](https://docs.hiro.so/stacks.js/guides/how-to-integrate-stacking) created by Hiro, and be sure to integrate the new parameters described in [Hiro's Nakamoto update doc](https://docs.hiro.so/nakamoto/stacks-js).
403403
{% endhint %}

docs/operate/stacking-stx/solo-stack.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -335,7 +335,7 @@ Additionally, you can choose to call the stacking functions directly from the [d
335335

336336
The fields and process will be the same, but the UI will differ.
337337

338-
Finally, you can stack using JS and the [@stacks/stacking](https://github.com/hirosystems/stacks.js/tree/main/packages/stacking) package if you prefer. Again, the functions and parameters will be the same, you will just be writing your JS code directly instead of using a UI.
338+
Finally, you can stack using JS and the [@stacks/stacking](https://github.com/stx-labs/stacks.js/tree/main/packages/stacking) package if you prefer. Again, the functions and parameters will be the same, you will just be writing your JS code directly instead of using a UI.
339339

340340
If you are interested in using this method, you'll want to follow the [stacking guide](https://docs.hiro.so/stacks.js/guides/how-to-integrate-stacking) created by Hiro, and be sure to integrate the new parameters described in [Hiro's Nakamoto update doc](https://docs.hiro.so/nakamoto/stacks-js).
341341
{% endhint %}

docs/reference/clarinet-js-sdk/browser-sdk-reference.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The browser build of the Clarinet SDK lets you interact with simnet directly fro
66

77
{% code title="Install" %}
88
```bash
9-
npm install @hirosystems/clarinet-sdk-browser
9+
npm install @stacks/clarinet-sdk-browser
1010
```
1111
{% endcode %}
1212

@@ -18,7 +18,7 @@ The browser SDK implements the same API as the Node.js Clarinet SDK. All methods
1818

1919
{% code title="Empty session (TypeScript)" %}
2020
```ts
21-
import { initSimnet } from '@hirosystems/clarinet-sdk-browser';
21+
import { initSimnet } from '@stacks/clarinet-sdk-browser';
2222

2323
const simnet = await initSimnet();
2424
await simnet.initEmptySession();
@@ -35,7 +35,7 @@ For testing with an existing Clarinet project using a virtual file system:
3535

3636
{% code title="Using a Clarinet project (TypeScript)" %}
3737
```ts
38-
import { initSimnet } from '@hirosystems/clarinet-sdk-browser';
38+
import { initSimnet } from '@stacks/clarinet-sdk-browser';
3939

4040
const simnet = await initSimnet();
4141
await simnet.initSession("/project", "Clarinet.toml");
@@ -57,7 +57,7 @@ Using a Clarinet project in the browser requires setting up a virtual file syste
5757

5858
{% code title="Playground example (TypeScript)" %}
5959
```ts
60-
import { initSimnet } from '@hirosystems/clarinet-sdk-browser';
60+
import { initSimnet } from '@stacks/clarinet-sdk-browser';
6161
import { Cl } from '@stacks/transactions';
6262

6363
// Initialize simnet
@@ -88,7 +88,7 @@ console.log(count.result); // (ok u1)
8888

8989
{% code title="Browser test example (TypeScript + Vitest)" %}
9090
```ts
91-
import { initSimnet } from '@hirosystems/clarinet-sdk-browser';
91+
import { initSimnet } from '@stacks/clarinet-sdk-browser';
9292
import { expect } from 'vitest';
9393

9494
const simnet = await initSimnet();

docs/reference/clarinet-js-sdk/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ npm init -y
1919
Install the Clarinet JS SDK and its dependencies:
2020

2121
```bash
22-
npm install @hirosystems/clarinet-sdk vitest @stacks/transactions
22+
npm install @stacks/clarinet-sdk vitest @stacks/transactions
2323
```
2424

2525
## Project structure
@@ -101,7 +101,7 @@ Set up Vitest so the SDK can bootstrap the testing environment:
101101

102102
```js
103103
import { defineConfig } from "vitest/config";
104-
import { vitestSetupFilePath } from "@hirosystems/clarinet-sdk/vitest";
104+
import { vitestSetupFilePath } from "@stacks/clarinet-sdk/vitest";
105105

106106
export default defineConfig({
107107
test: {

docs/reference/clarinet-js-sdk/sdk-reference.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The Clarinet JS SDK provides a comprehensive suite of helpers for testing and in
1313
## Installation
1414

1515
```bash
16-
npm install @hirosystems/clarinet-sdk
16+
npm install @stacks/clarinet-sdk
1717
```
1818

1919
## Initialize simulated network
@@ -29,7 +29,7 @@ initSimnet(manifestPath?: string): Promise<Simnet>
2929
```
3030

3131
```ts
32-
import { initSimnet } from '@hirosystems/clarinet-sdk';
32+
import { initSimnet } from '@stacks/clarinet-sdk';
3333

3434
const simnet = await initSimnet();
3535
```
@@ -321,7 +321,7 @@ mineBlock(txs: Tx[]): ParsedTransactionResult[]
321321
```
322322

323323
```ts
324-
import { tx } from '@hirosystems/clarinet-sdk';
324+
import { tx } from '@stacks/clarinet-sdk';
325325
import { Cl } from '@stacks/transactions';
326326

327327
const block = simnet.mineBlock([

docs/reference/clarinet/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,15 @@ winget install clarinet
3535
{% tab title="Source" %}
3636
```bash
3737
sudo apt install build-essential pkg-config libssl-dev
38-
git clone https://github.com/hirosystems/clarinet
38+
git clone https://github.com/stx-labs/clarinet
3939
cd clarinet
4040
cargo clarinet-install
4141
```
4242
{% endtab %}
4343

4444
{% tab title="Binary" %}
4545
```bash
46-
wget -nv https://github.com/hirosystems/clarinet/releases/latest/download/clarinet-linux-x64-glibc.tar.gz -O clarinet-linux-x64.tar.gz
46+
wget -nv https://github.com/stx-labs/clarinet/releases/latest/download/clarinet-linux-x64-glibc.tar.gz -O clarinet-linux-x64.tar.gz
4747
tar -xf clarinet-linux-x64.tar.gz
4848
chmod +x ./clarinet
4949
mv ./clarinet /usr/local/bin

0 commit comments

Comments
 (0)