Skip to content

Latest commit

 

History

History
154 lines (122 loc) · 3.49 KB

README.md

File metadata and controls

154 lines (122 loc) · 3.49 KB

Kinetic Python SDK Demo

This app demonstrates how to integrate with Kin via the Python SDK

Front End

This Kin BE Demo Server is compatible with our Kin DApp Playground

Prep

  • Your App is registered on the Kin Developer Portal so you can take advantage of the Kin Rewards Engine and get your App Index.
  • Environment variable for your App Index. Use APP_INDEX=1 to get started before your own App Index is confirmed.
  • Environment variable for your Keypair. Can be either MNEMONIC or BYTE_ARRAY.
  • Don't have a Keypair?
    • For mainnet and devnet Keypairs, use a Solana wallet like Phantom or Solflare to create one.
    • Use the Kinetic DApp Demo to quickly generate a devnet Keypair and get your mnemonic phrase.
    • Log in to the Kinetic Sandbox and create a keypair in your app's 'Toolbox' section.

.env

PORT=3001
APP_INDEX=1
KINETIC_ENDPOINT='https://your_kinetic_endpoint'
BYTE_ARRAY=[24,20,238,188,26,234,120,209,88,63,170,46,66,98,21,113,194,120,143,228,231,37,91,0,242,32,180,99,243,179,57,144,11,233,235,235,203,20,105,33,47,140,152,253,12,148,72,175,141,253,242,110,225,110,21,211,118,87,99,99,99,99,99,99]
MNEMONIC="cat dog elephant lion tiger shark whale diplodocus dragon pokemon transformer turtle"

Python

Python Version

3.10.7

Python Installations

pip install -r requirements.txt

Start

python api.py

Endpoints

Status

GET /status

Response:
200 {
    "appIndex": 360,
    "env": 1,
    "transactions": [],
    "users": [
        {
            "name": "App",
            "publicKey": "BsiFeVHeyYv56rBfmotqbeDU7Q9rs8SYkXRsm3umsYvV"
        }
    ]
}

Setup

POST /setup?env=Test or setup?env=Prod

Response
200 or 400

Create Account

POST /account?name=Test%20User

Response
201 or 400

Balance

GET /balance?user=Test%20User

Response
'999' or 400

Airdrop

POST /airdrop?to=Test%20User&amount=2000

Response
200 or 400

Transfer Kin

POST /send

Request Body
{
   "from": "App",
   "to": "Test User",
   "amount": "2000",
   "type": "Earn"
}

Response
200 or 400

Transfer Kin in Batch of Earn Transactions

POST /earn_batch

Request Body
{
   "from": "App",
   "batch": [
       {to: "User1", amount: "111"}, 
       {to: "User2", amount: "333"}
   ]
}

Response
200 or 400

Transaction Info

GET /transaction?transaction_id=uxMepF4pYrexvFKJEsU2ATzxU1MSJkqx51DCEek5SszAPygRUgsFYT8Ai6yJYLyKBJuqTd4sBnsC9wDWpCFWXi4


Response
200 {
   "payments": [
       {
           "destination": "GTpeCtraqEzkbSChQCmakFqyHpNU3iensTWnX58yQrk6",
           "quarks": 100000000,
           "sender": "89CLzhYJzZKs8mZ3GkwPeJfb3wHVJqGunyryBNjJhiDH",
           "type": 1
       }
   ],
   "txState": 3
} 
or 400

If you're just getting started, you might want to look at this first...

Dev Community

Join us on Discord if you're looking for support with your App or to connect with other active Kin developers.

If you're stuck or have any questions you'd like answering, get in touch on our kin-python channel.