Skip to content

Commit

Permalink
Fix SDK docs (MystenLabs#13407)
Browse files Browse the repository at this point in the history
## Description 

Describe the changes or additions included in this PR.

## Test Plan 

How did you test the new or updated feature?

---
If your changes are not user-facing and not a breaking change, you can
skip the following section. Otherwise, please indicate what changed, and
then add to the Release Notes section as highlighted during the release
process.

### Type of Change (Check all that apply)

- [ ] protocol change
- [ ] user-visible impact
- [ ] breaking change for a client SDKs
- [ ] breaking change for FNs (FN binary must upgrade)
- [ ] breaking change for validators or node operators (must upgrade
binaries)
- [ ] breaking change for on-chain data layout
- [ ] necessitate either a data wipe or data migration

### Release notes
  • Loading branch information
Jordan-Mysten authored Aug 15, 2023
1 parent 13e05c6 commit 343bfaa
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
16 changes: 8 additions & 8 deletions sdk/docs/pages/typescript/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -78,15 +78,15 @@ await requestSuiFromFaucetV0({
The SDK contains a set of modular packages that you can use independently or together. Import just
what you need to keep your code light and compact.

- [`@mysten/sui.js/client`](/sui-client) - A client for interacting with Sui RPC nodes.
- [`@mysten/sui.js/client`](/typescript/sui-client) - A client for interacting with Sui RPC nodes.
- `@mysten/sui.js/bcs` - A BCS builder with pre-defined types for Sui.
- [`@mysten/sui.js/transaction`](/transaction-building/basics) - Utilities for building and
interacting with transactions.
- [`@mysten/sui.js/keypairs/*`](/cryptography/keypairs) - Modular exports for specific KeyPair
implementations.
- [`@mysten/sui.js/transaction`](/typescript/transaction-building/basics) - Utilities for building
and interacting with transactions.
- [`@mysten/sui.js/keypairs/*`](/typescript/cryptography/keypairs) - Modular exports for specific
KeyPair implementations.
- `@mysten/sui.js/verify` - Methods for verifying transactions and messages.
- `@mysten/sui.js/cryptography` - Shared types and classes for cryptography.
- [`@mysten/sui.js/multisig`](/cryptography/multisig) - Utilities for working with multisig
signatures.
- [`@mysten/sui.js/multisig`](/typescript/cryptography/multisig) - Utilities for working with
multisig signatures.
- `@mysten/sui.js/utils` - Utilities for formatting and parsing various Sui types.
- [`@mysten/sui.js/faucet`](/faucet) - Methods for requesting sui from a faucet.
- [`@mysten/sui.js/faucet`](/typescript/faucet) - Methods for requesting sui from a faucet.
2 changes: 1 addition & 1 deletion sdk/docs/pages/typescript/sui-client.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ await client.getCoins({

The `getFullnodeUrl` helper in the previous code provides the URL for the specified network, useful
during development. In a production application, however, you should use the
[Mainnet RPC address](../index#network-locations). The function supports the following values:
[Mainnet RPC address](../typescript#network-locations). The function supports the following values:

- `localnet`
- `devnet`
Expand Down
2 changes: 1 addition & 1 deletion sdk/docs/pages/typescript/transaction-building/gas.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ With Programmable Transaction blocks, you can use the gas payment coin to constr
balance using `splitCoin`. This is useful for Sui payments, and avoids the need for up-front coin
selection. You can use `txb.gas` to access the gas coin in a transaction block, and it is valid as
input for any arguments, as long as it is used
[by-reference](../build/programming-with-objects/ch2-using-objects.md#pass-objects-by-reference).
[by-reference](https://docs.sui.io/build/programming-with-objects/ch2-using-objects#pass-objects-by-reference).
Practically speaking, this means you can also add to the gas coin with `mergeCoins` and borrow it
for Move functions with `moveCall`.

Expand Down

0 comments on commit 343bfaa

Please sign in to comment.