Skip to content

About

Magic IOS Extension libraries

Resources

Stars

2 stars

Watchers

6 watching

Forks

Latest commit

 

History

42 Commits

Folders and files

Repository files navigation

MagicExt

Official extensions for the Magic iOS SDK, shipped as Swift Package Manager products:

  • MagicExt-Solana
  • MagicExt-Bitcoin
  • MagicExt-OAuth

Requires iOS 13 or later. CocoaPods is not supported.

Solana and Bitcoin

Solana and Bitcoin work like the @magic-ext/solana and @magic-ext/bitcoin packages in magic-js. They need magic-ios 10.4.0 or later, which has Magic(apiKey:extensions:).

Add the package with Swift Package Manager, then add the products you need to your target: MagicExt-Solana, MagicExt-Bitcoin, or both.

.package(url: "https://github.com/magiclabs/magic-ios-ext.git", from: "X.Y.Z") // the first release with MagicExt-Solana and MagicExt-Bitcoin

Turn them on by passing a configuration when you create Magic:

import MagicSDK
import MagicExt_Solana
import MagicExt_Bitcoin

Magic.shared = Magic(
    apiKey: "YOUR_PUBLISHABLE_API_KEY",
    extensions: [
        SolanaConfiguration(rpcUrl: "https://api.devnet.solana.com"),
        BitcoinConfiguration(rpcUrl: "https://blockstream.info/testnet/api", network: "testnet")
    ]
)

Magic.shared.solana and Magic.shared.bitcoin are nil until you pass the matching configuration. The user must be logged in first.

Both extensions have these methods. Each one has a completion-handler version and a PromiseKit version.

  • getPublicAddress returns the user's address on that chain.
  • revealPrivateKey shows Magic's UI for exporting the key. The key never reaches your app.
Magic.shared.solana?.getPublicAddress { response in
    print(response.result ?? response.error?.localizedDescription ?? "")
}

Sign a Solana message

// A String is signed as UTF-8. You can also pass Data.
Magic.shared.solana?.signMessage("Sign in to Example") { response in
    // response.result is the 64-byte ed25519 signature, as Data
}

Sign a Solana transaction

The SDK has no Solana dependency, so you give it the serialized transaction bytes and say which kind it is. Build the bytes with a Solana library or by hand. In @solana/web3.js this is Transaction.serialize({ requireAllSignatures: false }) for a legacy transaction, or VersionedTransaction.serialize() for a version 0 transaction.

  • .legacy is for a legacy Transaction.
  • .v0 is for a VersionedTransaction.
let serialized: Data = ... // the serialized, unsigned transaction

Magic.shared.solana?.signTransaction(serialized, type: .legacy) { response in
    if let signed = response.result {
        let rawTransaction: Data = signed.rawTransaction
        // Send rawTransaction to a Solana node, for example with sendRawTransaction.
    } else if let error = response.error {
        print(error.localizedDescription)
    }
}

Use type: .v0 for a version 0 transaction.

Partly sign a Solana transaction

Use partialSignTransaction when other people also have to sign, such as a fee payer. It adds the user's signature and leaves the other slots empty.

// serializeConfig only applies to legacy transactions, as in magic-js.
let config = SolanaSerializeConfig(requireAllSignatures: false, verifySignatures: false)

Magic.shared.solana?.partialSignTransaction(serialized, type: .legacy, serializeConfig: config) { response in
    let partlySigned = response.result?.rawTransaction
    // Pass it on to the next signer.
}

Sign a Bitcoin transaction

You choose the inputs (the UTXOs to spend), the outputs and the change. Magic signs the result and returns a transaction that is ready to broadcast.

  • Amounts are in BTC, not satoshis, with at most eight decimal places.
  • txNum is the output index (vout) of the UTXO in its source transaction.
  • Each input needs its value, because the signature covers the amount being spent.
  • The fee is whatever is left after the outputs. Total outputs must not be more than total inputs. There is no minimum or maximum fee, so check it yourself.
let inputs = [
    BitcoinTransactionInput(txid: "<txid of the UTXO>", txNum: 0, value: 0.001)
]
let outputs = [
    BitcoinTransactionOutput(address: "<destination address>", value: 0.0009) // 0.0001 BTC fee
]

Magic.shared.bitcoin?.signTransaction(inputs: inputs, outputs: outputs) { response in
    if let signed = response.result {
        print(signed.signedTransaction) // hex, ready to broadcast
        print(signed.transactionHash)   // txid
    } else if let error = response.error {
        print(error.localizedDescription)
    }
}

Work out fees and change in whole satoshis, then convert to BTC for the call. Signing does not mean the network will accept the transaction.

Before you broadcast

The signed result comes back through Magic's relayer. Decode rawTransaction or signedTransaction and check the amounts and addresses before you send it.


Develop locally

Clone the SDK, this repo and the demo app side by side:

git clone https://github.com/magiclabs/magic-ios
git clone https://github.com/magiclabs/magic-ios-ext
git clone https://github.com/magiclabs/magic-ios-demo

Open magic-ios-demo/magic-ios-spm-demo.xcodeproj. It uses the local magic-ios and magic-ios-ext folders, so your changes show up in the demo. If Xcode says a package product is missing, run File > Packages > Resolve Package Versions.

About

Magic IOS Extension libraries

Resources

Stars

2 stars

Watchers

6 watching

Forks

Releases

Packages

Contributors

Languages