diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index b9981a2..381ef9b 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -5,9 +5,18 @@ on: branches: - main # or your default branch name +# Add this permissions block +permissions: + contents: read + pages: write + id-token: write + jobs: build-and-deploy: runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} steps: - name: Checkout repository @@ -27,7 +36,7 @@ jobs: run: pnpm install - name: Build docs - run: pnpm docs + run: pnpm run docs - name: Setup Pages uses: actions/configure-pages@v4 diff --git a/src/alexSDK.ts b/src/alexSDK.ts index 66c72e4..d5f943f 100644 --- a/src/alexSDK.ts +++ b/src/alexSDK.ts @@ -48,7 +48,7 @@ export class AlexSDK { * This function returns an array of TokenInfo objects, each containing detailed * information about a supported swappable currency. * - * @returns {Promise} - A promise that resolves to an array of + * @returns {Promise} - A promise that resolves to an array of * `TokenInfo` objects representing the currencies available for swaps. */ fetchSwappableCurrency(): Promise { @@ -60,7 +60,7 @@ export class AlexSDK { } /** - * This function returns all possible routes for swapping between two specified currencies. + * This function returns all possible routes for swapping between two specified currencies. * It returns an array of AMMRoute, representing possible swap routes. * * @param {Currency} from - The currency to swap from. @@ -197,8 +197,8 @@ export class AlexSDK { } /** - * This function fetches the current balances of all supported tokens for a specified STX address. - * It returns an object where the keys are the currency identifiers (as defined in the Currency enum) + * This function fetches the current balances of all supported tokens for a specified STX address. + * It returns an object where the keys are the currency identifiers (as defined in the Currency enum) * and the values are the corresponding balances as bigint values. * * @param {string} stxAddress - The Stacks (STX) address to retrieve the balances for.