Skip to content

SDK for communicating with the MobileCoin network in Swift

License

Apache-2.0, Unknown licenses found

Licenses found

Apache-2.0
LICENSE
Unknown
LICENSE.md
Notifications You must be signed in to change notification settings

mobilecoinofficial/MobileCoin-Swift

Repository files navigation

MobileCoin logo

CircleCI Documentation

MobileCoin Swift

MobileCoin is a privacy-preserving payments network designed for use on mobile devices.

Sending your First Payment

Note to Developers

  • MobileCoin is a prototype. Expect substantial changes before the release.
  • Please see CONTRIBUTING.md for notes on contributing bug reports and code.

libmobilecoin history rewrite

We migrated libmobilecoin, our static library submodule, with git lfs migrate. It rewrites the commit history so older submodule commit hashes will be broken. We archived all those commits here:

libmobilecoin-archive

which can be used in place of libmobilecoin for older commits.

Table of Contents

License

MobileCoin is available under open-source licenses. Please read the LICENSE.md and corresponding LICENSE.

Cryptography Notice

This distribution includes cryptographic software. Your country may have restrictions on the use of encryption software. Please check your country's laws before downloading or using this software.

Repository Structure

Directory Description
Docs Integration Guide.
Example Example application.
ExampleHTTP Example "HTTP Only" application.
scripts Scripts used by this repo.
secrets Secrets file for contributors, and their public keys.
Sources Sources for the MobileCoin Swift SDK.
Tests Tests.
Vendor iOS Artifacts.

Build Instructions

The workspace can be built with make.

  1. Initialize or update submodules

    git submodule update --init --recursive
    
  2. Install Ruby 2.7.x

  3. Install the gem bundler

    gem install bundler
    
  4. Install pre-commit

    brew install pre-commit
    pre-commit install
    
  5. Build the MobileCoin Swift SDK

    make
    

Note: To build libmobilecoin, run make in libmobilecoin-ios-artifacts.

Secrets

New contributors should follow the directions in the Secrets' README.md to get access to the keys used in internal testing.

Overview

MobileCoin is a payment network with no central authority. The fundamental goal of the network is to safely and efficiently enable the exchange of value, represented as fractional ownership of the total value of the network. Like most cryptocurrencies, MobileCoin maintains a permanent and immutable record of all successfully completed payments in a blockchain data structure. Cryptography is used extensively to establish ownership, control transfers, and to preserve cash-like privacy for users.

For more information about the cryptocurrency, see MobileCoinFoundation/MobileCoin.

Important Technical Documentation

A list of documents and resources that are useful for understanding how MobileCoin works.

Pay particular attention to the discussion of Fog, as it is key mobilecoin’s ability to function well on mobile devices.

Support

For troubleshooting help and other questions, please visit our community forum.

You can also open a technical support ticket via email.

Trademarks

MobileCoin is a registered trademark of MobileCoin Inc.