diff --git a/README.md b/README.md index e387c9c5..cb4a3b17 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/v2.md b/docs/v2.md new file mode 100644 index 00000000..9ef45b65 --- /dev/null +++ b/docs/v2.md @@ -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). diff --git a/packages/dapp-toolkit/README.md b/packages/dapp-toolkit/README.md index 5c85cd3e..8f946156 100644 --- a/packages/dapp-toolkit/README.md +++ b/packages/dapp-toolkit/README.md @@ -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', })