JupSwift

KO | EN

gitlite — search

#python #hacktoberfest #llm #golang #machine-learning #rust #deep-learning #java #windows #awesome #kubernetes #pytorch #ios #open-source

(★ 11)

This project provides a simple and secure Swift toolkit to help developers easily integrate Jupiter and Solana wallet functionalities into their apps.

JupSwift Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# JupSwift

JupSwift is a simple and secure Swift toolkit designed to help developers easily integrate Jupiter and Solana wallet functionalities into their iOS/MacOS applications.

## Features

* **Jupiter Integration:** Seamlessly connect to the Jupiter aggregator for token swaps and other features.
* **Solana Wallet Support:** Interact with Solana wallets to manage assets and sign transactions.
* **Swift Native:** Built with Swift for a modern and efficient development experience on iOS.

## Installation

JupSwift can be integrated into your Xcode project using Swift Package Manager.

1.  In Xcode, open your project and navigate to **File > Add Packages...**.
2.  Enter the repository URL in the search bar: `https://github.com/jauyou/JupSwift.git`
3.  For **Dependency Rule**, select your preferred option (e.g., "Up to Next Major Version").
4.  Click **Add Package**.
5.  Choose the `JupSwift` product and add it to your target.

## Usage

The following is a basic usage example of JupSwift.
At the moment, the wallet module supports a single mnemonic phrase, which can be either generated automatically or imported by the user.
Upon creation of the mnemonic, the first keypair will be derived instantly.

### Initialize Wallet Environment
1.  Prepare Mnemonic

- Generate Mnemonic into wallet

```swift
let manager = WalletManager()
let mnemonic = generateMnemonic() // or let mnemonic = { your own mnemonic }
do {
    let entry = try await manager.addMnemonic(mnemonic)
}  
```

- Import Mnemonic into wallet

```swift
///
/// Adding a mnemonic will automatically generate the first private key
/// Currently, the wallet only supports a single mnemonic
///
let manager = WalletManager()
do {
    let entry = try await manager.addMnemonic(mnemonic)
}   
```

2.  Set current wallet
   
```swift
do {
    try await manager.setCurrentWalletAtIndex(1)
    address = try await manager.getCurrentAddress()
}
```

3.  Sign Transaction using current wallet

```swift
let unsignedTransaction = "Afoj44vDVRXmWN+2b0XJsCMEUgahMabbSNU+vBnJylWI6A2wncgrljIZOZ9sre83TCsurVREk/X5rJSSiq6hxAuAAQAIDC1DU+v8CS6zsH6P1YDxv34gJqfH4duQts70riDegwRWh7Uj+ncbLnnXrncZ0M9fcpfQPh1Y9fJm+wF6ZvdeXAeT62WWp4H7+l5+SX/26TIX4kW9/UIESJwJ9fRHF2a4BeBV0h/1+T5UibrxqsSxFjlJUiOoGJgKrcpTt5U2/pOyAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACMlyWPTiSJ8bs9ECkUjg2DC1oTmdr/EIQEjnvY2+n4Wawfg/25zlUN6V1VjNx5VGHM9DdKxojsE6mEACIKeNoGAwZGb+UhFzL/7K26csOb57yM5bvF9xJrLEObOkAAAAC0P/on9df2SnTAmx8pWHneSwmrNt/J3VFLMhqns4zl6Mb6evO+2606PWXzaqvJdDGxu+TC0vbg5HymAgNFL11hBHnVW/IxwG7udMVuzmgVB/2xst6j9I5RArHNola8E48G3fbh12Whk9nL4UbO63msHLSF7V9bN5E6jPWFfv8AqQctTjnSwEUMprS9ERx1Vf9YfO/78A64br56TcDYlZ4IBwcABQLAXBUABwAJA/ThBQAAAAAABAIAAwwCAAAA8P4UBgAAAAAKBQMAFQsECZPxe2T0hK52/gUGAAIACQQLAQEKGAsAAwIKCQEIChEUDQADAgwODxALExMSBiPlF8uXeuOtKgEAAAAZZAABAOH1BQAAAABm+LQAAAAAADMAAAsDAwAAAQkB1oUQRIHodQ7RqM53G2HBODrXHK0Mt23syD9oedgHJVAFuL2gvqEFOLs1vBY="
let signedTransaction = try await manager.signTransaction(base64Transaction: unsignedTransaction)
```

4.  Retrieve the first private key
```swift
do {
    var privateKeyEntry = try await manager.deriveAndAddPrivateKeyAt(index: 0)
    let walletAddress = privateKeyEntry.address
    let privateKetBase58 = try await manager.getPrivateKeyBase58(id: privateKeyEntry.id)
}
```

### Use Jupiter API
1.  get account balance
```swift
let account = { target address }
let result = try await JupiterApi.balances(account: account)
```

2.  get an order
```swift
let inputMint = "So11111111111111111111111111111111111111112"    // SOL
let outputMint = "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v"  // USDC
let amount = "1000000"                                           
let taker = { your address }
        
let result = try await JupiterApi.order(inputMint: inputMint, outputMint: outputMint, amount: amount, taker: taker)
```

3.  get shieldMints
```swift
let mints = [
    "So11111111111111111111111111111111111111112", // Wrapped SOL
    "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v"  // USDC
]

do {
    let result = try await JupiterApi.shield(mints: mints)
}
```

4.  get route
```swift
let routers = try await JupiterApi.routers()
```

5.  execute order
```swift
let orderResponse = // from responese of order api
let signedTransactionBase64 = signTransaction(base64Transaction: transaction, privateKey: privateKey)
JupiterApi.execute(signedTransaction: signedTransactionBase64, requestId: orderResponse.requestId) { result in
    switch result {
        case .success(let executeResponse):
            onComplete(.success(executeResponse))
        case .failure(let error):
            onComplete(.failure(error))
    }
}
```

6.  The easier way to get order and execute order

- using wallet

```swift
let manager = WalletManager()
        try await manager.resetWallet()
        _ = try await manager.addMnemonic("YOUR_MNEMONIC_HERE")
        let inputMint = "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v" // USDC
        let outputMint = "JUPyiwrYJFskUPiHa7hkeR8VUtAeFoSYbKedZNsDvCN" // JUP
        let amount = "22763399" // minimal（lamports）

do {
            _ = try await JupiterApi.ultraSwap(
                inputMint: inputMint,
                outputMint: outputMint,
                amount: amount
            )
        } catch {
            print("❌ UltraSwap failed with error: \(error)")
            throw error
        }
```

- using private key

```swift
JupiterApi.ultraSwap(inputMint: "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v", outputMint: "JUPyiwrYJFskUPiHa7hkeR8VUtAeFoSYbKedZNsDvCN", amoumt: "22763399", taker: "YOUR_SOLANA_ADDRESS_HERE", privateKey: "YOUR_PRIVATE_KEY_HERE") { result in
    switch result {
        case .success(let executeResponse):
            print("✅ execute Order success")
            print(executeResponse)
        case .failure(let error):
            print("❌ API error: \(error.localizedDescription)")
    }
}
```

Check out the test cases for more example usages.

## Full Documentation

https://jauyou.github.io/JupSwift/documentation/jupswift/

## Dependencies
```
dependencies: [
            .package(url: "https://github.com/attaswift/BigInt.git", from: "5.3.0"),
            .package(url: "https://github.com/jauyou/Clibsodium.git", from: "1.0.0"),
            .package(url: "https://github.com/Alamofire/Alamofire.git", from: "5.10.2")
]
```

## Support
If you appreciate the work put into this open-source project and find JupSwift useful, please consider supporting its development. Your contributions help maintain and improve the toolkit. 🚀

You can show your support by sending a donation to one of the following wallet addresses:

EVM (Ethereum, BSC, Polygon, etc.) : 
```
0xC298710c19A8fE46d4f7FEbC88b35518E610dDf4
```

SOL (Solana) : 
```
ULNw3m7kxvPP8RHXAwYRTW5yQos7RWB4nmVBsiCix6V
```

Thank you for your support! ✨

## Contributing
Contributions to JupSwift are welcome! If you would like to contribute, please follow these steps:

1.  Fork the repository on GitHub.
2.  Create a new branch for your feature or bug fix: git checkout -b feature/your-feature-name or git checkout -b fix/your-bug-fix.
3.  Make your changes and commit them with descriptive messages: git commit -m "Add some amazing feature".
4.  Push your changes to your forked repository: git push origin feature/your-feature-name.
5.  Submit a pull request to the main branch of the original jauyou/JupSwift repository.

Please ensure your code adheres to the existing style and includes relevant tests if applicable.

## License
JupSwift is released under the MIT license. See [LICENSE](https://github.com/jauyou/JupSwift/blob/main/LICENSE) for details.

JupSwift

JupSwift Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

JupSwift

JupSwift Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README