Skip to content

Commit

Permalink
docs: v2 migration guide
Browse files Browse the repository at this point in the history
  • Loading branch information
xstelea committed Jun 28, 2024
1 parent 92ca93d commit 267973d
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 2 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ Look for dApp toolkit and related packages under the [/packages](/packages/) dir

This is merging [Radix dApp Toolkit](https://github.com/radixdlt/radix-dapp-toolkit), [√ Connect Button](https://github.com/radixdlt/connect-button), [Wallet Request SDK](https://github.com/radixdlt/wallet-sdk), [Radix Connect Schemas](https://github.com/radixdlt/radix-connect-schemas) into one mono-repository.

## Migration guide

- [v1 -> v2 migration guide](docs/v2.md)

## Versions In This Repository

- [main](https://github.com/radixdlt/radix-dapp-toolkit/commits/main) - This is all of the current work, which is against v2 of RDT right now
Expand Down
43 changes: 43 additions & 0 deletions docs/v2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Upgrading to 2.0

## Breaking Changes

### Babylon Gateway SDK

The Gateway SDK is no longer exposed by dApp toolkit.

```
import { GatewayApiClient } from '@radixdlt/babylon-gateway-api-sdk'
const dAppToolkit = RadixDappToolkit({
dAppDefinitionAddress:
'account_rdx12y7md4spfq5qy7e3mfjpa52937uvkxf0nmydsu5wydkkxw3qx6nghn',
networkId: RadixNetwork.Mainnet,
applicationName: 'Radix Web3 dApp',
applicationVersion: '1.0.0',
})
const gatewayApi = GatewayApiClient.initialize(
dAppToolkit.gatewayApi.clientConfig,
)
```

Detailed installation guide can be found in [@radixdlt/babylon-gateway-api-sdk](https://github.com/radixdlt/babylon-gateway/tree/main/sdk/typescript/#initialization)

### Logger

`createLogger` has been renamed to `Logger`

```
import { Logger } from '@radixdlt/radix-dapp-toolkit'
```

### Monorepo

Following npm packages are no longer released independently

- [√ Connect Button](https://www.npmjs.com/package/@radixdlt/connect-button)
- [Wallet SDK](https://www.npmjs.com/package/@radixdlt/wallet-sdk)
- [Radix Connect Schemas](https://www.npmjs.com/package/@radixdlt/radix-connect-schemas)

All future development will proceed in the [Radix dApp Toolkit](https://www.npmjs.com/package/@radixdlt/radix-dapp-toolkit).
4 changes: 2 additions & 2 deletions packages/dapp-toolkit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,8 @@ import { RadixDappToolkit, RadixNetwork } from '@radixdlt/radix-dapp-toolkit'

const rdt = RadixDappToolkit({
dAppDefinitionAddress:
'account_tdx_e_128uml7z6mqqqtm035t83alawc3jkvap9sxavecs35ud3ct20jxxuhl',
networkId: RadixNetwork.RCnetV3,
'account_rdx12y7md4spfq5qy7e3mfjpa52937uvkxf0nmydsu5wydkkxw3qx6nghn',
networkId: RadixNetwork.Mainnet,
applicationName: 'Radix Web3 dApp',
applicationVersion: '1.0.0',
})
Expand Down

0 comments on commit 267973d

Please sign in to comment.