Python SDK

Currently built for python 2.7

Requires an environment variable setup file. Example is in .env_example

Install

Requirements

Requests:

pip install requests

Clone the repo

git clone https://github.com/metacoin/flo-python-sdk.git flosdk

Create main.py:

touch main.py

Move the environment variable file to your root directory:

mv flosdk/.env_example .env

Now the directory structure should look like this:

📂root directory/
 └ main.py
 └ .env
 └📂flosdk/
   └ flosdk.py
   └ __init__.py

Running

Start by editing the .env_example file and adding your local FLO node configuration there. It should look something like this:

export FLO_RPCUSER=flo
export FLO_PASSWORD=flopass999999999222
export FLO_RPCPORT=7313

The variables should match your local FLO configuration file. On a Linux system the FLO configuration file is set-up by default in the home directory under ~/.florincoin/florincoin.conf. If it doesn't exist, create it, and add the following:

rpcserver=1
rpcuser=flo
rpcpassword=flopass999999999222
rpcallowip=192.168.0.0/16
rpcallowip=127.0.0.1
rpcport=7313
port=7312
server=1
listen=1
addnode=188.166.6.99
addnode=176.9.59.110
addnode=193.70.122.58
addnode=nyc2.entertheblockchain.com
addnode=sf1.entertheblockchain.com
addnode=am2.entertheblockchain.com
addnode=sgp.entertheblockchain.com
addnode=ind.entertheblockchain.com
addnode=de.entertheblockchain.com

After matching-up the .env_example file with the values from florincoin.conf rename the .env_example file to .env:

mv .env_example .env

Add each environment variable to your shell by sourcing the .env file:

source .env

Implement flosdk in your python project and test it:

# main.py

from flosdk import flosdk
print flosdk.get_info()

Run main.py:

python main.py

Structure

The FLO SDK should include all of the following:

1. RPC interface connecting to a local or remote FLO RPC daemon.
2. Cross-platform (sqlite3 or NoSQL) database to store transaction data.
3. Web-facing API for database.
4. Client interface connecting to web-facing database APIs.

Nice to have:

1. Alexandria / OIP API functions.
2. Flotorizer / SharedSecret functions.
3. Ability to connect to a pre-funded remote RPC.
4. SSL connection between the local client and server.

RPC interface connecting to a local or remote FLO RPC daemon

This should include every RPC call available in the FLO RPC list. It should also handle all errors that could be returned by the FLO RPC.

Cross-platform sqlite3 or NoSQL database to store transaction data

The SDK should have an option to store transaction data in a local database. Optionally, it should have "plugins" to recognize different protocols popular on the network.

Web-facing API for database

The database should be accessible via a web-facing API. This API, if on a web-facing server, should host data for remote nodes connecting to it. Otherwise it will have its own local API over the local network as usual.

Client SDK for connecting to web-facing database APIs

The client should be able to connect to a web-facing API to receive database information. This would be considered a "light" client -- one that doesn't have the blockchain or any database information -- it relies on an external (trusted 3rd party or self-hosted) server for data.

Alexandria / OIP API functions

Alexandria and OIP functions should be exposed in the library to make it easy to build into the Alexandria platform.

Flotorizer / SharedSecret functions

Same as above.

Ability to connect to a pre-funded remote RPC

Some clients won't have funds or any way to get funds, but will still want to post things on the blockchain. There should be some process of acquiring a funded key from a web-facing server that allows authorized clients to post to the blockchain after authenticating with their funded key.

SSL connection between the local client and server

The local client and server should have a secure tunnel to communicate with.

Debugging

For now we haven't added a --verbose option yet, every error is printed with a stack trace in full, below is a list of common errors.

Exception: HTTPConnectionPool Max retries exceeded

This error, alongside Failed to establish a new connection: [Errno 111] Connection refused, usually means the FLO RPC cannot be found. Make sure the FLO RPC is still running.

Exception: HTTPConnectionPool(host='localhost', port=7313): Max retries exceeded with url: / (Caused by NewConnectionError('<urllib3.connection.HTTPConnection object at 0x7f6c029f2310>: Failed to establish a new connection: [Errno 111] Connection refused',))

TODO:

1. Add --verbose option.
2. Standardize errors.
3. Decide on class/module structure.
4. Use proxy instead of requests for RPC connection (like in python-bitcoinlib)

LICENSE

Copyright 2018 FLO developers

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.