Skip to content

Latest commit

 

History

History
171 lines (132 loc) · 4.66 KB

qr-code_extention.md

File metadata and controls

171 lines (132 loc) · 4.66 KB
Raw

QR code formats

The QR codes contain JSON encoded data structures.

Contact

{
    "stellar": {
        "account": {
            "id":       ACCOUNT_ID,
            "network":  NETWORK_CODE // (*)
        }
    }
}

*) Network is only needed if not stellar.org live network

Payment request

{
    "stellar": {
        "payment": {
            "destination":  ACCOUNT_ID,
            "network":      NETWORK_CODE, // (*)
            "amount":       AMOUNT,
            "asset": {      // (**)
                "code":     ASSET_CODE,
                "issuer":   ASSET_ISSER
            },
            "memo": {       // (***)
                "type":     MEMO_TYPE,
                "value":    MEMO
            }
        }
    }
}

*) Network is only needed if not stellar.org live network

**) Asset is only needed if not XLM

***) Optional

Payment request with escrow

{
    "stellar": {
        "payment": {
            "destination":  ACCOUNT_ID,
            "network":      NETWORK_CODE, // (*)
            "amount":       AMOUNT,
            "asset": {      // (**)
                "code":     ASSET_CODE,
                "issuer":   ASSET_ISSER
            },
            "memo": {       // (***)
                "type":     MEMO_TYPE,
                "value":    MEMO
            },
            "escrow": {     // (****)
                "publicID":   ACCOUNT_ID,
                "email":     EMAIL_ADDRESS,
                "expire_ts": TIMESTAMP_EXPIRE,
                "expire_dt": EXPIRE_DATE,
                "status":    TRANSACTION_STATUS,
                "fee":       ESCROW_FEE,
                "callback":  WEB_HOOK
            }
            
        },
        "version": PROTOCOL_VERSION   // (***)
    }
}

*) Network is only needed if not stellar.org live network

**) Asset is only needed if not XLM

***) Optional

****) Optional see OpenCart plugin for details

Challenge/Response

{
    "stellar": {
        "challenge": {
            "id":       ACCOUNT_ID,		// (*)
            "message":  MESSAGE,
            "url":      WEBHOOK_URL
        }
    }
}

*) If not provided, any account the user controls can be used

Account export/import

{
    "stellar": {
        "account": {
            "network": NETWORK_CODE
        },
        "key": SEED or encrypted seed
    }
}

Here, network is mandatory, since it defines where an account has been registered.

Transaction Envelope

{
    "stellar": {
        "TransactionEnvelope": {          
            "base64":   XDR_blob,          // (*)
            "url_xdr":  URL_TO_XDR_DATA,   // (**)
            "url_sig":  URL_SIGNATURE_RESPONSE,   // (***)
            "tx_hash":  TRANSACTION_HASH,  // (****)
            "network":  NETWORK_CODE       // (*****)
        }
    }
}

*) base64 XDR_blob of the transaction that could signed, partly signed or fully signed with any group of operations

**) url_xdr URL_TO_XDR_DATA is provided that would contain the base64 XDR_blob if base64 was not directly provided in QR-code

***) url_sig URL_SIGNATURE_RESPONSE is optional and is the point to send back the decorated signature with webhook_url_sig.com?sig=dyqGyKpjt6j3NsIot/sw/82rD1KH0eaVYJ/4LO8szjh4rO/CZ24ihx6yRvLaGm64Na1GGy5wbqex3TkZ0v6GCg==&tx_hash=cd08cb01a02ab3a48aa2cb8f985c167c5f8c71b91e3fc9e9b74b687f712e576f note: the sig and added values will require uri encoding and decoding on the other end.

with webhook_url_sig.com?response_status=DECLINE returned (if optionaly supported the transaction will feedback decline to sign transaction.

with optional webhook_url_sig.com?response_status=DECLINE&message="Why I declined to sign"

****) tx_hash optional transaction hash of the XDR_blob sent

*****) Network is only needed if not stellar.org live network

example with direct base64: {"stellar":{"TransactionEnvelope":{"base64": "AAAAAP5saRvcSy2CRQaDS1EnupAyg4GZMSQTstIT8nouoaDbAAAAZADz38cAAAADAAAAAAAAAAEAAAAcKzkwWExNLVBsZWFzZWNsaWNrOmdpZnQ1Lm9yZwAAAAEAAAAAAAAAAQAAAACpgG+RdZDZvmEzTNJPQtZAN5oRURCIMY5TiI00fGtC4QAAAAAAAAAAAAAnEAAAAAAAAAABLqGg2wAAAEBX6WVBqu4Hu3nemplLsHCUOteH6tPqsGfAhuKRAt4uTT2l3pPBTXt6UtbeoeiCAUOZwI8mV4/6cH9m1GHLmOwD", "network":"7ac33997"}}}

example with url_xdr webhook: {"stellar":{"TransactionEnvelope":{"url_xdr":"https://ipfs.io/ipfs/Qmd7WVrmnzbtXVFy3pkiF451edGXZx3tPWZbuJgPLeZr4D","network":"cee0302d"}}}

Specifying a Network

NETWORK_CODE is the first eight hex characters of the SHA-256 hash of the network passphrase,

function getHash(passphrase) {
    return new StellarSdk.Network(passphrase)
    .networkId().toString('hex').slice(0, 8);
}

Examples:

  • Live net - "7ac33997"
  • Test net - "cee0302d"