Installation

• How to install Beacon iOS SDK
• Packages Overview
  • Core
  • Client
  • Blockchain
  • Transport

How to install Beacon iOS SDK

To add Beacon iOS SDK into your project add the dependencies:

SPM

Package.swift

dependencies: [
    .package(url: "https://github.com/airgap-it/beacon-ios-sdk", from: "x.y.z")
],

Or in Xcode open the Add Package Dependency window (as described in the official guide) and enter the Beacon iOS SDK GitHub repository URL

https://github.com/airgap-it/beacon-ios-sdk

CocoaPods

Podfile

target 'MyTarget' do
    use_frameworks!

    pod 'BeaconCore', :git => 'https://github.com/airgap-it/beacon-ios-sdk', :tag => 'x.y.z'

    // optional
    pod 'BeaconClientWallet', :git => 'https://github.com/airgap-it/beacon-ios-sdk', :tag => 'x.y.z'

    // optional
    pod 'BeaconBlockchainSubstrate', :git => 'https://github.com/airgap-it/beacon-ios-sdk', :tag => 'x.y.z'
    // optional
    pod 'BeaconBlockchainTezos', :git => 'https://github.com/airgap-it/beacon-ios-sdk', :tag => 'x.y.z'

    // optional
    pod 'BeaconTransportP2PMatrix', :git => 'https://github.com/airgap-it/beacon-ios-sdk', :tag => 'x.y.z'
end

Packages Overview

The library packages and their relations are described below.

Core

Core packages are the basis for other packages. They are required for the SDK to work as expected.

Module	Description	Dependencies	Required by
BeaconCore	Base for other modules	✖️	BeaconClientWallet BeaconBlockchainSubstrate BeaconBlockchainTezos BeaconTransportP2PMatrix

Client

Client packages ship with Beacon implementations for different parts of the network.

Module	Description	Dependencies	Required by
BeaconClientWallet	Beacon implementation for wallets	BeaconCore	✖️

Blockchain

Blockchain packages provide support for different blockchains.

Module	Description	Dependencies	Required by
BeaconBlockchainSubstrate	Substrate specific components	BeaconCore	✖️
BeaconBlockchainTezos	Tezos specific components	BeaconCore	✖️

Transport

Transport packages provide various interfaces used to establish connection between Beacon clients.

Module	Description	Dependencies	Required by
BeaconTransportP2PMatrix	Beacon P2P implementation which uses Matrix for the communication	BeaconCore	✖️