0.2.60 • Published 2 years ago

sphinx-bridge-kevkevinpal v0.2.60

Weekly downloads
-
License
ISC
Repository
-
Last release
2 years ago

sphinx-bridge

library for applications embedded within Sphinx apps

Load into your app

npm install --save sphinx-bridge

import * as sphinx from 'sphinx-bridge'

or

<script src="https://unpkg.com/sphinx-bridge@0.2.4/sphinx/sphinx.min.js"></script>

API

All functions return a Promise, that resolves when the action has been completed in the Sphinx App

  • sphinx.enable(): Enable the sphinx library. This function will postMessage to the Sphinx app, requesting authorization, a budget to spend, and the user's pubkey (hex encoded)
  • sphinx.keysend(pubkey, amount): Initiate a keysend (pubkey is hex encoded)
  • sphinx.sendPayment(paymentRequest): Pay a Lightning invoice
  • sphinx.makeInvoice(amount, memo): Create a Lightning invoice
  • sphinx.signMessage(message): Request that the Sphinx app signs a message with Lightning private key
  • sphinx.verifyMessage(signature, message): Verify a signed message
  • sphinx.topup(): Show the authorization modal again, so the user can top up their budget for the app
  • sphinx.authorize(challenge, noBudget): Request the Sphinx app to sign a challenge with their Lightning private key. "noBudget" boolean set to true will prevent the app from showing the budget input.
  • sphinx.updated(): Utility function to let Sphinx app know that something has happened out of band (like a payment has been received), so satoshi balance should be refreshed in app.
0.2.60

2 years ago

0.2.59

2 years ago

0.2.58

2 years ago

0.2.57

2 years ago

0.2.56

2 years ago

0.2.55

2 years ago

0.2.52

3 years ago

0.2.54

3 years ago

0.2.49

3 years ago

0.2.48

3 years ago

0.2.47

3 years ago

0.2.46

3 years ago

0.2.45

3 years ago

0.2.43

3 years ago

0.2.42

3 years ago

0.2.51

3 years ago

0.2.41

3 years ago

0.2.40

3 years ago

0.2.39

3 years ago

0.2.38

3 years ago

0.2.37

3 years ago

0.2.36

3 years ago

0.2.35

3 years ago

0.2.34

3 years ago

0.2.33

3 years ago

0.2.32

3 years ago

0.2.31

3 years ago

0.2.30

3 years ago

0.2.29

3 years ago

0.2.28

3 years ago

0.2.27

3 years ago

0.2.26

3 years ago

0.2.25

3 years ago

0.2.24

3 years ago

0.2.23

3 years ago

0.2.22

3 years ago

0.2.21

3 years ago

0.2.20

3 years ago

0.2.19

3 years ago

0.2.18

3 years ago

0.2.17

3 years ago

0.2.16

3 years ago

0.2.15

3 years ago

0.2.14

3 years ago

0.2.13

3 years ago

0.2.12

3 years ago

0.2.11

3 years ago

0.2.10

3 years ago

0.2.9

3 years ago