Skip to content

Commit

Permalink
chore: update docs TS SDK docs to 0.99.0 (#72)
Browse files Browse the repository at this point in the history
* chore: update docs

* fix: spelling

* chore: lint fix

* spelling

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
  • Loading branch information
petertonysmith94 and github-actions[bot] authored Feb 5, 2025
1 parent bf130c4 commit bca93c0
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/spell-check-custom-words.txt
Original file line number Diff line number Diff line change
Expand Up @@ -88,3 +88,5 @@ graphql
gql
Instantiation
enum
pageInfo
namespaced
45 changes: 45 additions & 0 deletions docs/src/migrations/typescript-sdk.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,50 @@
# TypeScript SDK Migrations Guide

## February 4, 2025

[Release v0.99.0](https://github.com/FuelLabs/fuels-ts/releases/tag/v0.99.0)

### Remove `pageInfo` from `getBalances` GraphQL operations - [#3652](https://github.com/FuelLabs/fuels-ts/pull/3652)

- The `pageInfo` field has been removed from the response of the `provider.operations.getBalances` query.

```ts
// before
const { balances, pageInfo } = await provider.operations.getBalances({
first: 100,
filter: { owner: wallet.address.toB256() },
});
```

```ts
// after
const { balances } = await provider.operations.getBalances({
first: 100,
filter: { owner: wallet.address.toB256() },
});
```

The `getBalances` method of the Provider class remains unchanged, as it never returned pageInfo:

```ts
// not affected
const { balances } = await provider.getBalances();
```

### Remove `ContractUtils` namespaced export - [#3570](https://github.com/FuelLabs/fuels-ts/pull/3570)

- `ContractUtils` was removed and the underlying functions `getContractRoot()`, `getContractStorageRoot()`, `getContractId()`, `hexlifyWithPrefix()` are now exported directly from `fuels`.

```ts
// before
import { ContractUtils } from 'fuels';
```

```ts
// after
import { getContractRoot, getContractStorageRoot, getContractId, hexlifyWithPrefix } from 'fuels';
```

## January 10, 2025

[Release v0.98.0](https://github.com/FuelLabs/fuels-ts/releases/tag/v0.98.0)
Expand Down
2 changes: 1 addition & 1 deletion src/versions.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
"default": {
"sway": "v0.63.0",
"rust": "v0.66.0",
"ts": "v0.98.0"
"ts": "v0.99.0"
}
}

0 comments on commit bca93c0

Please sign in to comment.