Kin SDK Docs

Kin SDK Docs

  • Developers
  • Build

›Python

Overview

  • Getting Started
  • Kin Architecture Overview
  • How It Works
  • App Registration
  • Migration to New SDKs
  • Solana
  • Terms & Concepts

Agora

  • Agora API Reference
  • Agora Webhook Reference

Android

  • Android SDK

iOS

  • iOS SDK

Go

  • Go SDK

Python

  • Python SDK
  • Python API reference

Node.js

  • Node.js SDK

Deprecated

    Android

    • Hello World Android
    • Kin SDK for Android
    • Android API reference
    • Backup/Restore Module for Android
    • Discovery Module for Android
    • Send Kin Module for Android

    iOS

    • Hello World iOS
    • Kin SDK for iOS
    • iOS API reference
    • Backup/Restore Module for iOS
    • Appreciation Module 'Options Menu' for iOS

    Unity

    • Hello World Unity
    • Kin SDK for Unity

    Python

    • Hello World Python
    • Kin SDK for Python
    • Kin Python Bootstrap
    • Python API reference

    Node.js

    • Hello World Node.js
    • Kin SDK for Node.js
Edit

Kin Python Bootstrap

A ready-to-use server using the Kin Python SDK

Prerequisites

Docker software installed:

  • Docker
  • docker-compose

Configuration

The server can be configured from the docker-compose.yml file. If no values are entered, the server will use a default configuration for testing.

VariableDescription
SEEDThe seed of your Kin account
HORIZON_ENDPOINTThe URL for the Kin blockchain
NETWORK_PASSPHRASEThe passphrase for the Kin blockchain
APP_IDThe app ID (used to identify transactions)
CHANNEL_COUNTHow many channels to use. See more in the Channels section
CHANNEL_STARTING_BALANCEInitial Kin balance of each channel
CHANNEL_SALTA string to be used when creating the channels
PORTPort to serve the app on
LOG_LEVELLog level, either "INFO" or "ERROR"

Running the Server

$ docker-compose up -d

Logs can be accessed with

$ docker-compose logs

External API

The API for the server can be viewed here: https://editor.swagger.io?url=https://raw.githubusercontent.com/kinecosystem/kin-python-bootstrap/master/api.yaml

Channels

Channels are additional accounts that are used internally in the Kin SDK to increase the performance of the server. Simply put, if you have X channels, you will be able to perform X transactions at the same time.

CHANNEL_COUNT When configuring the number of channels, we recommend to just leave it at 100. Otherwise, the acceptable values are 0<=X<=100 (0 channels will still allow for processing one transaction at a time).

CHANNEL_STARTING_BALANCE When the server starts for the first time, it will create the channels for you. The channels need to have a small amount of Kin in them to pay for fees. This is a one-time operation, so turning the server off/on again will will not cost you more Kin. If you are whitelisted, you may leave this value at 0, otherwise, we recommend 1.

CHANNEL_SALT This is a string that the server uses to generate your channels. If you are only setting up one instance of the server, you may leave this value empty. If you are setting up multiple instances of the server, make sure to input a different string in the configuration of each one.

Last updated on 2019-8-21
← Kin SDK for PythonPython API reference →
  • Prerequisites
  • Configuration
  • Running the Server
  • External API
  • Channels
Kin SDK Docs

Docs

IntroductionAndroidiOSGoPythonNode.js

Resources

GithubGuidelines
LinkedInRedditMedium
Privacy policyTerms and conditions
© 2021 Kin Foundation