diff --git a/.github/workflows/publish-beta.yml b/.github/workflows/publish-beta.yml index 7c30d608b..18c479874 100644 --- a/.github/workflows/publish-beta.yml +++ b/.github/workflows/publish-beta.yml @@ -3,11 +3,11 @@ name: publish-beta on: push: branches: - - master + - main tags-ignore: - - "**" + - '**' paths-ignore: - - "**.md" + - '**.md' workflow_dispatch: diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 5d140abb8..b9586655c 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -3,11 +3,11 @@ name: publish on: push: branches: - - master + - main tags-ignore: - - "**" + - '**' paths-ignore: - - "**.md" + - '**.md' workflow_dispatch: diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 8d62183fa..141dd31b0 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -2,9 +2,9 @@ name: tests on: push: branches: - - master + - main tags-ignore: - - "**" + - '**' workflow_call: workflow_dispatch: diff --git a/.github/workflows/version.yml b/.github/workflows/version.yml index 81d8d7832..d17e3be16 100644 --- a/.github/workflows/version.yml +++ b/.github/workflows/version.yml @@ -3,11 +3,11 @@ name: version on: push: branches: - - master + - main tags-ignore: - - "**" + - '**' paths-ignore: - - "**.md" + - '**.md' workflow_dispatch: @@ -28,7 +28,7 @@ jobs: - uses: actions/checkout@v3 with: fetch-depth: 0 - ref: master + ref: main - uses: actions/setup-node@v3 with: @@ -51,8 +51,8 @@ jobs: - name: Create Release Pull Request uses: janniks/changesets-action@main with: - title: "chore: version packages" - commit: "chore: version packages" - version: "npm run ci:version" + title: 'chore: version packages' + commit: 'chore: version packages' + version: 'npm run ci:version' env: GITHUB_TOKEN: ${{ secrets.GH_TOKEN || secrets.GITHUB_TOKEN }} diff --git a/README.md b/README.md index b1264ccfa..b3b1b9683 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Stacks.js [![Test Action Badge](https://github.com/hirosystems/stacks.js/actions/workflows/tests.yml/badge.svg)](https://github.com/hirosystems/stacks.js/actions/workflows/tests.yml) [![Monorepo Version Label](https://img.shields.io/github/lerna-json/v/hirosystems/stacks.js?label=monorepo)](https://github.com/hirosystems/stacks.js/tree/master/packages) +# Stacks.js [![Test Action Badge](https://github.com/hirosystems/stacks.js/actions/workflows/tests.yml/badge.svg)](https://github.com/hirosystems/stacks.js/actions/workflows/tests.yml) [![Monorepo Version Label](https://img.shields.io/github/lerna-json/v/hirosystems/stacks.js?label=monorepo)](https://github.com/hirosystems/stacks.js/tree/main/packages) This repo is home to most of the Stacks.js packages, which provide the building blocks to work with the [Stacks blockchain](https://www.stacks.co/what-is-stacks) from JavaScript/TypeScript. @@ -8,24 +8,24 @@ This repo is home to most of the Stacks.js packages, which provide the building #### Stacks Primitives -- [`@stacks/transactions`](https://github.com/hirosystems/stacks.js/tree/master/packages/transactions) Construct, decode transactions and work with Clarity smart contracts on the Stacks blockchain. -- [`@stacks/wallet-sdk`](https://github.com/hirosystems/stacks.js/tree/master/packages/wallet-sdk) Library for building wallets, managing accounts, and handling keys for the Stacks blockchain. -- [`@stacks/storage`](https://github.com/hirosystems/stacks.js/tree/master/packages/storage) Store and fetch files with Gaia, the decentralized storage system. -- [`@stacks/encryption`](https://github.com/hirosystems/stacks.js/tree/master/packages/encryption) Encryption functions used by stacks.js packages. -- [`@stacks/auth`](https://github.com/hirosystems/stacks.js/tree/master/packages/auth) Construct and decode authentication requests for Stacks apps. -- [`@stacks/profile`](https://github.com/hirosystems/stacks.js/tree/master/packages/profile) Functions for manipulating user profiles. -- [`@stacks/network`](https://github.com/hirosystems/stacks.js/tree/master/packages/network) Network and API library for working with Stacks blockchain nodes. -- [`@stacks/common`](https://github.com/hirosystems/stacks.js/tree/master/packages/common) Common utilities used by stacks.js packages. +- [`@stacks/transactions`](https://github.com/hirosystems/stacks.js/tree/main/packages/transactions) Construct, decode transactions and work with Clarity smart contracts on the Stacks blockchain. +- [`@stacks/wallet-sdk`](https://github.com/hirosystems/stacks.js/tree/main/packages/wallet-sdk) Library for building wallets, managing accounts, and handling keys for the Stacks blockchain. +- [`@stacks/storage`](https://github.com/hirosystems/stacks.js/tree/main/packages/storage) Store and fetch files with Gaia, the decentralized storage system. +- [`@stacks/encryption`](https://github.com/hirosystems/stacks.js/tree/main/packages/encryption) Encryption functions used by stacks.js packages. +- [`@stacks/auth`](https://github.com/hirosystems/stacks.js/tree/main/packages/auth) Construct and decode authentication requests for Stacks apps. +- [`@stacks/profile`](https://github.com/hirosystems/stacks.js/tree/main/packages/profile) Functions for manipulating user profiles. +- [`@stacks/network`](https://github.com/hirosystems/stacks.js/tree/main/packages/network) Network and API library for working with Stacks blockchain nodes. +- [`@stacks/common`](https://github.com/hirosystems/stacks.js/tree/main/packages/common) Common utilities used by stacks.js packages. #### Native Smart Contract Interaction -- [`@stacks/bns`](https://github.com/hirosystems/stacks.js/tree/master/packages/bns) Library for interacting with the BNS contract. -- [`@stacks/stacking`](https://github.com/hirosystems/stacks.js/tree/master/packages/stacking) Library for PoX stacking. +- [`@stacks/bns`](https://github.com/hirosystems/stacks.js/tree/main/packages/bns) Library for interacting with the BNS contract. +- [`@stacks/stacking`](https://github.com/hirosystems/stacks.js/tree/main/packages/stacking) Library for PoX stacking. #### Others -- [`@stacks/cli`](https://github.com/hirosystems/stacks.js/tree/master/packages/cli) Command line interface to interact with auth, storage and Stacks transactions. -- `@stacks/keychain` _**DEPRECATED:** replaced by [`@stacks/wallet-sdk`](https://github.com/hirosystems/stacks.js/tree/master/packages/wallet-sdk)_ +- [`@stacks/cli`](https://github.com/hirosystems/stacks.js/tree/main/packages/cli) Command line interface to interact with auth, storage and Stacks transactions. +- `@stacks/keychain` _**DEPRECATED:** replaced by [`@stacks/wallet-sdk`](https://github.com/hirosystems/stacks.js/tree/main/packages/wallet-sdk)_ See the respective `README` in each package directory for installation instructions and usage. diff --git a/packages/auth/README.md b/packages/auth/README.md index 62079f2dd..843674aa8 100644 --- a/packages/auth/README.md +++ b/packages/auth/README.md @@ -1,8 +1,8 @@ # @stacks/auth -Construct and decode authentication requests for Stacks apps. +Construct and decode authentication requests for Stacks apps. -This package provides the auth logic used by the [Stacks Connect](https://github.com/hirosystems/connect) library. If you're looking to integrate Stacks authentication into your web app, Stacks Connect provides a simple API and built-in user interface. See the [authentication tutorial](https://docs.stacks.co/build-apps/references/authentication). +This package provides the auth logic used by the [Stacks Connect](https://github.com/hirosystems/connect) library. If you're looking to integrate Stacks authentication into your web app, Stacks Connect provides a simple API and built-in user interface. See the [authentication tutorial](https://docs.stacks.co/build-apps/references/authentication). ## Installation @@ -15,7 +15,7 @@ npm install @stacks/auth ### Generating an authentication request ```typescript -import { UserSession, makeAuthRequest, AppConfig } from '@stacks/auth' +import { UserSession, makeAuthRequest, AppConfig } from '@stacks/auth'; ``` The app domain is the URL to your website/app. This is how the Stacks authentication system identifies apps and determines what credentials to provide. Changing the app domain is equivalent to changing the app. Note that you also need to have a valid manifest.json file at the domain. @@ -37,7 +37,7 @@ The authentication payloads are encrypted during transit, the encryption key gen const transitKey = userSession.generateAndStoreTransitKey(); ``` -The Stacks auth process will open a compatible Stacks authenticator or browser extension to perform the authentication. So you will need to provide a redirect URL which the authenticator or extension can redirect to with the authentication payload. This page should process the authentication payload. +The Stacks auth process will open a compatible Stacks authenticator or browser extension to perform the authentication. So you will need to provide a redirect URL which the authenticator or extension can redirect to with the authentication payload. This page should process the authentication payload. ```typescript const redirectUri = 'https://www.myapp.com/auth'; @@ -52,14 +52,10 @@ const manifestUri = 'https://www.myapp.com/manifest.json'; Finally generate the authentication request payload: ```typescript -const authRequest = userSession.makeAuthRequest( - transitKey, - redirectUri, - manifestUri -); +const authRequest = userSession.makeAuthRequest(transitKey, redirectUri, manifestUri); ``` -The resulting payload can now be passed to a compatible Stacks authenticator or browser extension. If you are using Stacks connect, this is performed automatically. +The resulting payload can now be passed to a compatible Stacks authenticator or browser extension. If you are using Stacks connect, this is performed automatically. If you would like to implement a Stacks authenticator, check out the reference implementation of the [Stacks browser extension, Hiro Wallet](https://github.com/hirosystems/stacks-wallet-web). @@ -71,7 +67,7 @@ Below, we use `userSession.isSignInPending` to determine if there is an incoming ```typescript if (userSession.isSignInPending()) { - userSession.handlePendingSignIn().then((userData) => { + userSession.handlePendingSignIn().then(userData => { // Do something with userData }); } @@ -97,7 +93,7 @@ userSession.signUserOut(); ### Data encryption -Stacks authentication also provides an easy way to encrypt the user's data. If you are using the [`@stacks/storage`](https://github.com/blockstack/stacks.js/tree/master/packages/storage) package, encryption is automatically enabled. If you would like to perform encryption outside of storage you can use the `userSession.encryptContent` and `userSession.decryptContent` methods. +Stacks authentication also provides an easy way to encrypt the user's data. If you are using the [`@stacks/storage`](https://github.com/blockstack/stacks.js/tree/main/packages/storage) package, encryption is automatically enabled. If you would like to perform encryption outside of storage you can use the `userSession.encryptContent` and `userSession.decryptContent` methods. ```typescript const message = 'My secret message'; diff --git a/packages/transactions/src/clarity/deserialize.ts b/packages/transactions/src/clarity/deserialize.ts index 5e00f46bb..b952d21ef 100644 --- a/packages/transactions/src/clarity/deserialize.ts +++ b/packages/transactions/src/clarity/deserialize.ts @@ -41,7 +41,7 @@ import { bytesToAscii, bytesToUtf8, hexToBytes } from '@stacks/common'; * ``` * * @see - * {@link https://github.com/hirosystems/stacks.js/blob/master/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} + * {@link https://github.com/hirosystems/stacks.js/blob/main/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} */ export default function deserializeCV( serializedClarityValue: BytesReader | Uint8Array | string diff --git a/packages/transactions/src/clarity/serialize.ts b/packages/transactions/src/clarity/serialize.ts index 80580558a..dca638a3e 100644 --- a/packages/transactions/src/clarity/serialize.ts +++ b/packages/transactions/src/clarity/serialize.ts @@ -148,7 +148,7 @@ function serializeStringUtf8CV(cv: StringUtf8CV) { * ``` * * @see - * {@link https://github.com/hirosystems/stacks.js/blob/master/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} + * {@link https://github.com/hirosystems/stacks.js/blob/main/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} */ export function serializeCV(value: ClarityValue): Uint8Array { switch (value.type) { diff --git a/packages/transactions/src/clarity/types/booleanCV.ts b/packages/transactions/src/clarity/types/booleanCV.ts index 4ba155ceb..0dfa05e9b 100644 --- a/packages/transactions/src/clarity/types/booleanCV.ts +++ b/packages/transactions/src/clarity/types/booleanCV.ts @@ -24,7 +24,7 @@ interface FalseCV { * ``` * * @see - * {@link https://github.com/hirosystems/stacks.js/blob/master/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} + * {@link https://github.com/hirosystems/stacks.js/blob/main/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} */ const trueCV = (): BooleanCV => ({ type: ClarityType.BoolTrue }); @@ -42,7 +42,7 @@ const trueCV = (): BooleanCV => ({ type: ClarityType.BoolTrue }); * ``` * * @see - * {@link https://github.com/hirosystems/stacks.js/blob/master/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} + * {@link https://github.com/hirosystems/stacks.js/blob/main/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} */ const falseCV = (): BooleanCV => ({ type: ClarityType.BoolFalse }); @@ -60,7 +60,7 @@ const falseCV = (): BooleanCV => ({ type: ClarityType.BoolFalse }); * ``` * * @see - * {@link https://github.com/hirosystems/stacks.js/blob/master/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} + * {@link https://github.com/hirosystems/stacks.js/blob/main/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} */ const boolCV = (bool: boolean) => (bool ? trueCV() : falseCV()); diff --git a/packages/transactions/src/clarity/types/bufferCV.ts b/packages/transactions/src/clarity/types/bufferCV.ts index a1d2aba50..cccdacdf5 100644 --- a/packages/transactions/src/clarity/types/bufferCV.ts +++ b/packages/transactions/src/clarity/types/bufferCV.ts @@ -25,7 +25,7 @@ interface BufferCV { * ``` * * @see - * {@link https://github.com/hirosystems/stacks.js/blob/master/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} + * {@link https://github.com/hirosystems/stacks.js/blob/main/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} */ const bufferCV = (buffer: Uint8Array): BufferCV => { if (buffer.length > 1_000_000) { @@ -54,7 +54,7 @@ const bufferCV = (buffer: Uint8Array): BufferCV => { *``` * * @see - * {@link https://github.com/hirosystems/stacks.js/blob/master/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} + * {@link https://github.com/hirosystems/stacks.js/blob/main/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} */ const bufferCVFromString = (str: string): BufferCV => bufferCV(utf8ToBytes(str)); diff --git a/packages/transactions/src/clarity/types/intCV.ts b/packages/transactions/src/clarity/types/intCV.ts index 33961576c..529be69e4 100644 --- a/packages/transactions/src/clarity/types/intCV.ts +++ b/packages/transactions/src/clarity/types/intCV.ts @@ -28,7 +28,7 @@ interface IntCV { * ``` * * @see - * {@link https://github.com/hirosystems/stacks.js/blob/master/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} + * {@link https://github.com/hirosystems/stacks.js/blob/main/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} */ const intCV = (value: IntegerType): IntCV => { const bigInt = intToBigInt(value, true); @@ -61,7 +61,7 @@ interface UIntCV { * ``` * * @see - * {@link https://github.com/hirosystems/stacks.js/blob/master/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} + * {@link https://github.com/hirosystems/stacks.js/blob/main/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} */ const uintCV = (value: IntegerType): UIntCV => { const bigInt = intToBigInt(value, false); diff --git a/packages/transactions/src/clarity/types/listCV.ts b/packages/transactions/src/clarity/types/listCV.ts index 68e0e92a1..01aa3bb72 100644 --- a/packages/transactions/src/clarity/types/listCV.ts +++ b/packages/transactions/src/clarity/types/listCV.ts @@ -22,7 +22,7 @@ interface ListCV { * ``` * * @see - * {@link https://github.com/hirosystems/stacks.js/blob/master/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} + * {@link https://github.com/hirosystems/stacks.js/blob/main/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} */ function listCV(values: T[]): ListCV { return { type: ClarityType.List, list: values }; diff --git a/packages/transactions/src/clarity/types/optionalCV.ts b/packages/transactions/src/clarity/types/optionalCV.ts index e8825eb93..63b695b20 100644 --- a/packages/transactions/src/clarity/types/optionalCV.ts +++ b/packages/transactions/src/clarity/types/optionalCV.ts @@ -25,7 +25,7 @@ interface SomeCV { * ``` * * @see - * {@link https://github.com/hirosystems/stacks.js/blob/master/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} + * {@link https://github.com/hirosystems/stacks.js/blob/main/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} */ function noneCV(): NoneCV { return { type: ClarityType.OptionalNone }; @@ -47,7 +47,7 @@ function noneCV(): NoneCV { * ``` * * @see - * {@link https://github.com/hirosystems/stacks.js/blob/master/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} + * {@link https://github.com/hirosystems/stacks.js/blob/main/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} */ function someCV(value: T): OptionalCV { return { type: ClarityType.OptionalSome, value }; diff --git a/packages/transactions/src/clarity/types/principalCV.ts b/packages/transactions/src/clarity/types/principalCV.ts index 199e1ad73..b548658a9 100644 --- a/packages/transactions/src/clarity/types/principalCV.ts +++ b/packages/transactions/src/clarity/types/principalCV.ts @@ -50,7 +50,7 @@ function principalCV(principal: string): PrincipalCV { * ``` * * @see - * {@link https://github.com/hirosystems/stacks.js/blob/master/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} + * {@link https://github.com/hirosystems/stacks.js/blob/main/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} */ function standardPrincipalCV(addressString: string): StandardPrincipalCV { const addr = createAddress(addressString); @@ -77,7 +77,7 @@ function standardPrincipalCV(addressString: string): StandardPrincipalCV { * ``` * * @see - * {@link https://github.com/hirosystems/stacks.js/blob/master/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} + * {@link https://github.com/hirosystems/stacks.js/blob/main/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} */ function standardPrincipalCVFromAddress(address: Address): StandardPrincipalCV { return { type: ClarityType.PrincipalStandard, address }; @@ -98,7 +98,7 @@ function standardPrincipalCVFromAddress(address: Address): StandardPrincipalCV { * ``` * * @see - * {@link https://github.com/hirosystems/stacks.js/blob/master/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} + * {@link https://github.com/hirosystems/stacks.js/blob/main/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} */ function contractPrincipalCV(addressString: string, contractName: string): ContractPrincipalCV { const addr = createAddress(addressString); @@ -122,7 +122,7 @@ function contractPrincipalCV(addressString: string, contractName: string): Contr * ``` * * @see - * {@link https://github.com/hirosystems/stacks.js/blob/master/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} + * {@link https://github.com/hirosystems/stacks.js/blob/main/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} */ function contractPrincipalCVFromAddress( address: Address, diff --git a/packages/transactions/src/clarity/types/responseCV.ts b/packages/transactions/src/clarity/types/responseCV.ts index 629ec8f90..6c92be706 100644 --- a/packages/transactions/src/clarity/types/responseCV.ts +++ b/packages/transactions/src/clarity/types/responseCV.ts @@ -30,7 +30,7 @@ interface ResponseOkCV { * ``` * * @see - * {@link https://github.com/hirosystems/stacks.js/blob/master/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} + * {@link https://github.com/hirosystems/stacks.js/blob/main/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} */ function responseErrorCV(value: T): ResponseErrorCV { return { type: ClarityType.ResponseErr, value }; @@ -53,7 +53,7 @@ function responseErrorCV(value: T): Respo * ``` * * @see - * {@link https://github.com/hirosystems/stacks.js/blob/master/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} + * {@link https://github.com/hirosystems/stacks.js/blob/main/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} */ function responseOkCV(value: T): ResponseOkCV { return { type: ClarityType.ResponseOk, value }; diff --git a/packages/transactions/src/clarity/types/stringCV.ts b/packages/transactions/src/clarity/types/stringCV.ts index 31d4d74ea..6e31a07e0 100644 --- a/packages/transactions/src/clarity/types/stringCV.ts +++ b/packages/transactions/src/clarity/types/stringCV.ts @@ -27,7 +27,7 @@ interface StringUtf8CV { * ``` * * @see - * {@link https://github.com/hirosystems/stacks.js/blob/master/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} + * {@link https://github.com/hirosystems/stacks.js/blob/main/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} */ const stringAsciiCV = (data: string): StringAsciiCV => { return { type: ClarityType.StringASCII, data }; @@ -50,7 +50,7 @@ const stringAsciiCV = (data: string): StringAsciiCV => { * ``` * * @see - * {@link https://github.com/hirosystems/stacks.js/blob/master/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} + * {@link https://github.com/hirosystems/stacks.js/blob/main/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} */ const stringUtf8CV = (data: string): StringUtf8CV => { return { type: ClarityType.StringUTF8, data }; diff --git a/packages/transactions/src/clarity/types/tupleCV.ts b/packages/transactions/src/clarity/types/tupleCV.ts index 5148f0145..515663242 100644 --- a/packages/transactions/src/clarity/types/tupleCV.ts +++ b/packages/transactions/src/clarity/types/tupleCV.ts @@ -29,7 +29,7 @@ interface TupleCV { * ``` * * @see - * {@link https://github.com/hirosystems/stacks.js/blob/master/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} + * {@link https://github.com/hirosystems/stacks.js/blob/main/packages/transactions/tests/clarity.test.ts | clarity test cases for more examples} */ function tupleCV(data: TupleData): TupleCV> { for (const key in data) { diff --git a/packages/wallet-sdk/README.md b/packages/wallet-sdk/README.md index ba40e1c95..153bf78de 100644 --- a/packages/wallet-sdk/README.md +++ b/packages/wallet-sdk/README.md @@ -190,7 +190,7 @@ const authResponse = await makeAuthResponse({ ### Usage with `@stacks/transactions` -This library is meant to be used in conjunction with the [`@stacks/transactions`](https://github.com/blockstack/stacks.js/tree/master/packages/transactions) library for signing transactions. +This library is meant to be used in conjunction with the [`@stacks/transactions`](https://github.com/blockstack/stacks.js/tree/main/packages/transactions) library for signing transactions. #### Getting an account's STX address diff --git a/tsconfig.typedoc.json b/tsconfig.typedoc.json index f4058648b..e95b7e6fb 100644 --- a/tsconfig.typedoc.json +++ b/tsconfig.typedoc.json @@ -19,26 +19,23 @@ "packages/keychain", "packages/profile", "packages/storage", - "packages/wallet-sdk", + "packages/wallet-sdk" ], "json": "docs/docs.json", "out": "docs", "excludePrivate": true, "excludeProtected": true, - "categoryOrder": [ - "*", - "Other" - ], + "categoryOrder": ["*", "Other"], "gaID": "GTM-M8P6G7Z", "theme": "stacks", "replaceText": { "replacements": [ { - "pattern": "https://github.com/hirosystems/stacks.js/tree/master/packages/wallet-sdk", + "pattern": "https://github.com/hirosystems/stacks.js/tree/main/packages/wallet-sdk", "replace": "/modules/_stacks_wallet_sdk" }, { - "pattern": "https://github.com/hirosystems/stacks.js/tree/master/packages/", + "pattern": "https://github.com/hirosystems/stacks.js/tree/main/packages/", "replace": "/modules/_stacks_" } ]