This is a Python library to help you build servers/services within Sygna Bridge Ecosystem.
Project description
Python Sygna Bridge Util
This is a Python library to help you build servers/servies within Sygna Bridge Ecosystem. For more detail information, please see Sygna Bridge.
Installation
pip install sygna-bridge-util
Crypto
Dealing with encoding, decoding, signing and verifying in Sygna Bridge.
ECIES Encoding an Decoding
During the communication of VASPs, there are some private information that must be encrypted. We use ECIES(Elliptic Curve Integrated Encryption Scheme) to securely encrypt these private data so that they can only be accessed by the recipient.
sensitive_data = {
"originator": {
"name": "Antoine Griezmann",# required and must be in English
"date_of_birth":"1991-03-21"
},
"beneficiary":{
"name": "Leo Messi"
}
}
private_info = sygna_bridge_util.crypto.encrypt_private_data(
sensitive_data,
recipient_public_key
)
decoded_priv_info = sygna_bridge_util.crypto.decrypt_private_data(
private_info,
recipient_privte_key
)
Sign and Verify
In Sygna Bridge, we use secp256k1 ECDSA over sha256 of utf-8 json string to create signature on every API call. Since you need to provide the identical utf-8 string during verfication, the order of key-value pair you put into the object is important.
The following example is the snippet of originator's signing process of premissionRequest
API call. If you put the key transaction
before private_info
in the object, the verification will fail in the central server.
transaction = {
"originator_vasp": {
"vasp_code": "VASPUSNY1",
"addrs": [
{
"address": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV",
"addr_extra_info": []
}
]
},
"beneficiary_vasp": {
"vasp_code": "VASPUSNY2",
"addrs": [
{
"address": "rAPERVgXZavGgiGv6xBgtiZurirW2yAmY",
"addr_extra_info": [
{
"tag": "abc"
}
]
}
]
},
"currency_id": "sygna:0x80000090",
"amount": "4.51120135938784"
}
data_dt = "2019-07-29T06:28:00Z"
# using sign_data to get a valid signed object (with signature attached)
data_to_sign = {
"private_info":private_info,
"transaction":transaction,
"data_dt":data_dt
}
sygna_bridge_util.crypto.sign_data(data_to_sign, originator_private_key)
valid = sygna_bridge_util.crypto.verify_data(obj, originator_public_Key)
# or you can use the method that's built for `transfer` request:
signed_data = sygna_bridge_util.crypto.sign_permission_request(
data_to_sign,
originator_private_key
)
valid = sygna_bridge_util.crypto.verify_data(
signed_data,
originator_public_Key
)
We provide different methods like sign_permission_request
, sign_callback()
to sign different objects(or parameters) we specified in our api doc. You can also find more examples in the following section.
API
API calls to communicate with Sygna Bridge server.
We use baisc auth with all the API calls. To simplify the process, we provide a API class to deal with authentication and post/ get request format.
sb_server = "https://api.sygna.io/"
sb_api_instance = sygna_bridge_util.API("api-key", sb_server)
After you create the API
instance, you can use it to make any API call to communicate with Sygna Bridge central server.
Get VASP Information
# Get List of VASPs associated with public keys.
verify = True # set verify to true to verify the signature attached with api response automatically.
vasps = sb_api_instance.get_vasp_list(verify)
# Or call use get_vasp_public_key() to directly get public key for a specific VASP.
public_key = sb_api_instance.get_vasp_public_key("10298", verify)
For Originator
There are two API calls from transaction originator to Sygna Bridge Server defined in the protocol, which are post_permission_request
and post_transaction_id
.
The full logic of originator would be like the following:
# originator.py
private_sender_info = {
"originator": {
"name": "Antoine Griezmann",
"date_of_birth":"1991-03-21"
},
"beneficiary":{
"name":"Leo Messi"
}
}
recipient_public_key = sb_api_instance.get_vasp_public_key("10298")
private_info = sygna_bridge_util.crypto.sygna_encrypt_private_data(
private_sender_info,
recipient_public_key
)
transaction = {
"originator_vasp": {
"vasp_code": "VASPUSNY1",
"addrs": [
{
"address": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV",
"addr_extra_info": []
}
]
},
"beneficiary_vasp": {
"vasp_code": "VASPUSNY2",
"addrs": [
{
"address": "rAPERVgXZavGgiGv6xBgtiZurirW2yAmY",
"addr_extra_info": [
{
"tag": "abc"
}
]
}
]
},
"currency_id": "sygna:0x80000090",
"amount": "4.51120135938784"
}
data_dt = "2019-07-29T07:29:80Z"
data_to_sign = {
"private_info":private_info,
"transaction":transaction,
"data_dt":data_dt
}
transfer_data = sygna_bridge_util.crypto.sign_permission_request(
data_to_sign,
sender_privKey
)
callback_url = "https://81f7d956.ngrok.io/v2/originator/transaction/premission"
callback_data = sygna_bridge_util.crypto.sign_callback(
{
"callback_url":callback_url
},
sender_privKey
)
response = sb_api_instance.post_permission_request(
{
"data":transfer_data,
"callback":callback_data
}
)
# Boradcast your transaction to blockchain after got and api reponse at your api server.
txid = "1a0c9bef489a136f7e05671f7f7fada2b9d96ac9f44598e1bcaa4779ac564dcd"
# Inform Sygna Bridge that a specific transfer is successfully broadcasted to the blockchain.
send_tx_id_data = sygna_bridge_util.crypto.sign_transaction_id(
{
"transfer_id":response["transfer_id"],
"txid":txid
},
sender_privKey
)
post_tx_id_response = sb_api_instance.post_transaction_id(send_tx_id_data)
For Beneficiary
There is only one api for Beneficiary VASP to call, which is post_permission
. After the beneficiary server confirm thet legitemacy of a transfer request, they will sign { transfer_id, permission_status }
using sign_permission()
function, and send the result with signature to Sygna Bridge Central Server.
permission_status = "ACCEPTED" # or "REJECTED"
permission_data = sygna_bridge_util.crypto.sign_permission(
{
"transfer_id":response["transfer_id"],
"permission_status":permission_status
},
beneficiary_private_key
)
finalresult = sb_api_instance.post_permission(permission_data)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sygna_bridge_util-2.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 612d4aeaf99320c10d7fc80049fcea2764e9097249e6740fadea844af250179b |
|
MD5 | 6fcccbaae08be5e7dffd539e78b1f09b |
|
BLAKE2b-256 | 65bf054852fff68aee2b5659b52e37eec2728ba7a7bf7e89a806849b32446fcc |