Skip to content

Commit

Permalink
Merge pull request #1418 from WalletConnect/w3w-warnings
Browse files Browse the repository at this point in the history
W3w warnings
  • Loading branch information
llbartekll authored Sep 17, 2024
2 parents 96ff7b0 + d35a1f5 commit f707551
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 70 deletions.
Original file line number Diff line number Diff line change
@@ -1,15 +1,6 @@
{
"object": {
"pins": [
{
"package": "Atlantis",
"repositoryURL": "https://github.com/ProxymanApp/atlantis",
"state": {
"branch": null,
"revision": "5145a7041ec71421d09653db87dcc80c81792004",
"version": "1.24.0"
}
},
{
"package": "BigInt",
"repositoryURL": "https://github.com/attaswift/BigInt.git",
Expand Down Expand Up @@ -73,6 +64,15 @@
"version": "0.1.7"
}
},
{
"package": "Sentry",
"repositoryURL": "https://github.com/getsentry/sentry-cocoa.git",
"state": {
"branch": null,
"revision": "5575af93efb776414f243e93d6af9f6258dc539a",
"version": "8.36.0"
}
},
{
"package": "SolanaSwift",
"repositoryURL": "https://github.com/flypaper0/solana-swift",
Expand Down Expand Up @@ -163,6 +163,15 @@
"version": "1.1.0"
}
},
{
"package": "CoinbaseWalletSDK",
"repositoryURL": "https://github.com/WalletConnect/wallet-mobile-sdk",
"state": {
"branch": null,
"revision": "b6dfb7d6b8447c7c5b238a10443a1ac28223f38f",
"version": "1.0.0"
}
},
{
"package": "Web3",
"repositoryURL": "https://github.com/WalletConnect/Web3.swift",
Expand All @@ -171,6 +180,15 @@
"revision": "569255adcfff0b37e4cb8004aea29d0e2d6266df",
"version": "1.0.2"
}
},
{
"package": "swift-web3modal",
"repositoryURL": "https://github.com/WalletConnect/web3modal-swift",
"state": {
"branch": "pairing-expiry",
"revision": "3088a08a43c490c24f1dfb1b858a67de089feef6",
"version": null
}
}
]
},
Expand Down
62 changes: 3 additions & 59 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,61 +1,5 @@
# WalletConnect v.2 - Swift
# Deprecated - WalletConnect v.2 - Swift

![CI main](https://github.com/WalletConnect/WalletConnectSwiftV2/actions/workflows/ci.yml/badge.svg?branch=main)
![CI develop](https://github.com/WalletConnect/WalletConnectSwiftV2/actions/workflows/ci.yml/badge.svg?branch=develop)
WalletConnect Inc is now Reown. As part of this transition, we are deprecating a number of repositories/packages across our supported platforms, and transitioning to their equivalents published under the Reown organization.

Swift implementation of WalletConnect v.2 protocol for native iOS applications.
## Requirements
- iOS 13
- XCode 13
- Swift 5

## Documentation & Usage
- In order to build API documentation in XCode go to Product -> Build Documentation
- [Getting started with wallet integration](https://docs.walletconnect.com/2.0/swift/sign/installation)
- [Beginner guide to WalletConnect v2.0 for iOS Developers](https://medium.com/walletconnect/beginner-guide-to-walletconnect-v2-0-for-swift-developers-4534b0975218)
- [Protocol Documentation](https://github.com/WalletConnect/walletconnect-specs)
- [Glossary](https://docs.walletconnect.com/2.0/introduction/glossary)
- [Migration guide from Sign and Auth to Web3Wallet](https://github.com/WalletConnect/walletconnect-docs/blob/main/docs/swift/guides/web3wallet-migration.md)


## Installation
### Swift Package Manager
Add .package(url:_:) to your Package.swift:
```Swift
dependencies: [
.package(url: "https://github.com/WalletConnect/WalletConnectSwiftV2", .branch("main")),
],
```
### Cocoapods
Add pod to your Podfile:

```Ruby
pod 'WalletConnectSwiftV2'
```
If you encounter any problems during package installation, you can specify the exact path to the repository
```Ruby
pod 'WalletConnectSwiftV2', :git => 'https://github.com/WalletConnect/WalletConnectSwiftV2.git', :tag => '1.0.5'
```
## Setting Project ID
Follow instructions from *Configuration.xcconfig* and configure PROJECT_ID with your ID from WalletConnect Dashboard
```
// Uncomment next line and paste your project id. Get this on: https://cloud.walletconnect.com/sign-in
// PROJECT_ID = YOUR_PROJECT_ID
// To use Push Notifications on the Simulator you need to grab the simulator identifier
// from Window->Devices and Simulators->Simulator you're using->Identifier
SIMULATOR_IDENTIFIER = YOUR_SIMULATOR_IDENTIFIER
```
## Example App
open `Example/ExampleApp.xcodeproj`

## Web3Wallet
Web3Wallet SDK introduces a new interface for all wallets that wraps the Sign and Auth clients internally.
- [Migration guide from Sign and Auth to Web3Wallet](https://github.com/WalletConnect/walletconnect-docs/blob/main/docs/swift/web3wallet/upgrade-guide.md)

## License

Apache 2.0

## Guides

- [Artifacts sometimes not available in Actions -> Build name -> Artifacts?](./docs/guides/downloading_artifacts.md)
This repository is now considered deprecated and will reach End-of-Life on February 17th 2025. For more details, including migration guides please see: https://docs.reown.com/advanced/walletconnect-deprecations
9 changes: 7 additions & 2 deletions Sources/Web3Wallet/Web3Wallet.swift
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,12 @@ public typealias VerifyContext = WalletConnectVerify.VerifyContext
/// Web3Wallet.configure(metadata: metadata, account: account)
/// Web3Wallet.instance.getSessions()
/// ```
///
/// - Warning: `Web3Wallet` has been deprecated. Please migrate to `WalletKit` which can be found at [https://github.com/reown-com/reown-swift](https://github.com/reown-com/reown-swift).
@available(*, deprecated, message: "WalletConnect Inc is now Reown. As part of this transition, we are deprecating a number of repositories/packages across our supported platforms, and transitioning to their equivalents published under the Reown organization. This repository is now considered deprecated and will reach End-of-Life on February 17th 2025. For more details, including migration guides please see: https://docs.reown.com/advanced/walletconnect-deprecations")
public class Web3Wallet {
/// Web3Wallett client instance

/// Web3Wallet client instance
public static var instance: Web3WalletClient = {
guard let config = Web3Wallet.config else {
fatalError("Error - you must call Web3Wallet.configure(_:) before accessing the shared instance.")
Expand All @@ -29,7 +33,7 @@ public class Web3Wallet {
pushClient: Push.instance
)
}()

private static var config: Config?

private init() { }
Expand All @@ -38,6 +42,7 @@ public class Web3Wallet {
/// - Parameters:
/// - metadata: App metadata
/// - crypto: Auth crypto utils
@available(*, deprecated, message: "Web3Wallet.configure has been deprecated. Please migrate to WalletKit.configure.")
static public func configure(
metadata: AppMetadata,
crypto: CryptoProvider,
Expand Down

0 comments on commit f707551

Please sign in to comment.