https://github.com/miracle2k/ripple-federation-python

ripple/federation-php for Python.
https://github.com/miracle2k/ripple-federation-python

Last synced: 4 days ago
JSON representation

ripple/federation-php for Python.

• Host: GitHub
• URL: https://github.com/miracle2k/ripple-federation-python
• Owner: miracle2k
• Created: 2013-12-08T21:47:01.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2014-06-24T21:28:59.000Z (over 10 years ago)
• Last Synced: 2024-10-03T17:34:55.702Z (about 2 months ago)
• Language: Python
• Size: 212 KB
• Stars: 4
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

• awesome-xrpl - federation-python

README

        
ripple-federation-python

------------------------

What ripple/federation-php does for Python. Provides a very simple

mapping between names an Ripple addresses. Integrate into your site

to receive Ripple payments at ``[email protected]``.

Usage

-----

Using werkzeug, for example, you might do::

    CORS = {"Access-Control-Allow-Origin": "*"}

    from .ripple_federation import Federation, get_ripple_txt

    federation = Federation({

        'elsdoerfer.name': {'michael': 'rpLJBGZRT8D9ktgdsYv5AWYtePdyLPrEHy'},

    })

    @expose('/ripple.txt')

    def ripple_txt(request):

        return Response(get_ripple_txt(

            domain=request.host,

            federation_url='https://{}{}'.format(

                request.host, request.urlmap.build('ripple_federation'))

            ),

            mimetype='text/plain',

            headers=CORS)

    @expose('/ripple/federation')

    def ripple_federation(request):

        return Response(

            json.dumps(federation.endpoint(request.args)),

            mimetype='application/json',

            headers=CORS

        )

To do more than just mapping the name to an address, you can specify

callables::

    def lookup_user(domain, user):

         ripple, destination_tag = findUser(domain, user)

         return {

            'destination_address': app.config['PAYMENT_ADDRESS'],

            'dt': int(user)

         }

    federation = Federation({

        'elsdoerfer.name': lookup_user,

        'elsdoerfer.name': {'michael': callable_allowed_here_as_well},

    })

The callable has to return a dict, which will be inserted into the result record,

and may also overwrite the standard fields. In this way, you may provide any

return values the Federation specification allows.

Other notes

-----------

Test your ripple.txt setup here: https://ripple.com/tools/txt/

Note that HTTPS is needed.