Symbiosis Sdk

This is a library using Kotlin Multiplatform technology, which allows for convenient handling of cross-chain swaps

Table of Contents

• Features
• Installation
• Contributing
• License

Features

We maintain this section separately on the website, see full documentation here.

Installation

1. Add the following snippet to your repositories

repositories {
    maven {
        url = uri("https://maven.pkg.github.com/symbiosis-finance/mobile-sdk")
        credentials {
            username = System.getenv("GITHUB_USERNAME")
            password = System.getenv("TOKEN")
        }
    }
}

where GITHUB_USERNAME - your github username, that has access to the repository, TOKEN - your github's personal access token, there is a guide of how to get it, you need the following scopes: repo, workflow, read:packages.

2. Add the following code to the module where you want to use sdk:

dependencies {
    commonMainApi("com.symbiosis.sdk:sdk:2.0.9")
}

Contributing

All development (both new features and bug fixes) is performed in develop branch. This way master sources always contain sources of the most recently released version. Please send PRs with bug fixes to develop branch. Fixes to documentation in markdown files are an exception to this rule. They are updated directly in master.

The develop branch is pushed to master during release.

More detailed guide for contributors see in contributing guide.

License

Copyright 2021 Symbiosis Labs Ltd

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.