Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sjors/libwally-swift
Swift wrapper for LibWally, a collection of useful primitives for cryptocurrency wallets
https://github.com/sjors/libwally-swift
Last synced: about 1 month ago
JSON representation
Swift wrapper for LibWally, a collection of useful primitives for cryptocurrency wallets
- Host: GitHub
- URL: https://github.com/sjors/libwally-swift
- Owner: Sjors
- License: mit
- Created: 2019-05-28T10:35:33.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-16T14:38:09.000Z (over 1 year ago)
- Last Synced: 2024-08-05T23:26:44.221Z (3 months ago)
- Language: Swift
- Homepage:
- Size: 340 KB
- Stars: 39
- Watchers: 13
- Forks: 17
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Funding: FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# LibWally Swift [](https://travis-ci.com/Sjors/libwally-swift)
Opinionated Swift wrapper around [LibWally](https://github.com/ElementsProject/libwally-core),
a collection of useful primitives for cryptocurrency wallets.
Supports a minimal set of features based on v0.8.8. See also [original docs](https://wally.readthedocs.io/en/release_0.8.8).
- [ ] Core Functions
- [x] base58 encode / decode
- [ ] Crypto Functions
- [x] sign ECDSA, convert to DER
- [ ] Address Functions
- [x] Parse to scriptPubKey
- [ ] Generate from scriptPubKey #7 (wishlist, done for SegWit)
- [x] Derive
- [x] WIF
- [ ] Detect bech32 typos #4 (wishlist)
- [x] bech32 and bech32m
- [x] BIP32 Functions
- [ ] Derive scriptPubKey #6 (wishlist)
- [ ] BIP38 Functions
- [x] BIP39 Functions
- [ ] Descriptor functions
- [x] Parse and canonicalize
- [x] Convert to address
- [ ] Convert to scriptPubKey
- [ ] Script Functions
- [x] Serialize scriptPubKey
- [x] Determine scriptPubkey type
- [ ] PSBT functions
- [x] Parse and serialize (base64 / binary)
- [x] Check completeness and extract transaction
- [ ] Transaction Functions
- [x] Compose and sign transaction
- [x] Calculate fee
Items marked with wishlist are not (yet) available upstream.
Multisig as well as [Elements](https://blockstream.com/elements/) specific functions such as confidential addresses are not implemented.
Works with iOs 11+ on 64-bit devices and the simulator.
## Usage
Derive address from a seed:
```swift
let mnemonic = BIP39Mnemonic("abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about")
let masterKey = HDKey(mnemonic.seedHex("bip39 passphrase"))!
masterKey.fingerprint.hexString
let path = "m/44'/0'/0'"
let account = try! masterKey.derive(path)
account.xpub
account.address(.payToWitnessPubKeyHash)
```
Derive address from an xpub:
```swift
let account = HDKey("xpub6ASuArnXKPbfEwhqN6e3mwBcDTgzisQN1wXN9BJcM47sSikHjJf3UFHKkNAWbWMiGj7Wf5uMash7SyYq527Hqck2AxYysAA7xmALppuCkwQ")
let receivePath = "0/0"
key = account.derive(receivePath)
key.address(.payToPubKeyHash) # => 1JQheacLPdM5ySCkrZkV66G2ApAXe1mqLj
```
Parse an address:
```swift
var address = Address("bc1q6zwjfmhdl4pvhvfpv8pchvtanlar8hrhqdyv0t")
address?.scriptPubKey # => 0014d09d24eeedfd42cbb12161c38bb17d9ffa33dc77
address?.scriptPubKey.type # => .payToWitnessPubKeyHash
```
Create and sign a transaction:
```swift
let txId = "400b52dab0a2bb5ce5fdf5405a965394b43a171828cd65d35ffe1eaa0a79a5c4"
let vout: UInt32 = 1
let amount: Satoshi = 10000
let witness = Witness(.payToWitnessPubKeyHash(key.pubKey))
let input = TxInput(Transaction(txId)!, vout, amount, nil, witness, scriptPubKey)!
transaction = Transaction([input], [TxOutput(destinationAddress.scriptPubKey, amount - 110)])
transaction.feeRate // Satoshi per byte
let accountPriv = HDKey("xpriv...")
let privKey = try! accountPriv.derive("0/0")
transaction.sign([privKey])
transaction.description # transaction hex
```
See also the included [Playground](/DemoPlayground.playground/Contents.swift) and [tests](/LibWallyTests).
## Install
As part of a project.
### CocoaPods
Add to your Podfile:
```
pod 'LibWally', :git => 'https://github.com/Sjors/LibWally-Swift.git', :tag => 'v0.0.3', :submodules => true
```
and then run:
```
pod install --verbose
```
## Build
For development.
Install dependencies:
```sh
brew install gnu-sed automake libtool
```
Clone the repository, including submodules:
```sh
git clone https://github.com/Sjors/libwally-swift.git --recurse-submodules
```
Xcode will build libwally-core for you, which may take a few minutes.
When making changes to libwally-core, keep in mind that cleaning the build folder
in Xcode [will not trigger a recompile](https://github.com/Sjors/libwally-swift/pull/82#issuecomment-1327837562). You need to call `git clean -dfx` inside `CLibWally/libwally-core`.