SUMMARY.md

Table of contents

• Build on Xaman

Concepts

• Getting started
  • Terminology
  • Developer Education
• 🔐 Authorization & Credentials
• Payloads (sign requests)
  • 🚨 Secure Payment Verification
  • Workflow
  • Lifecycle
    • Sample POS lifecycle
  • Payload Delivery
    • Deep Linking
    • QR Scanning
    • Push
    • xApps
    • Mobile (iOS/Android)
    • Desktop browser
  • Status updates
    • Websocket
    • Webhooks
      • Signature verification
    • API Call (polling)
  • Networks
  • Payload Return URL
  • Tx Explorer(s)
• Special Transaction Types
• Limitations
  • Rate limits
  • Transaction types
  • Push permission
• Implementation checklist
  • Protocol specific checks

Environments

• 🌎 Browser ("Web3")
  • CORS (Browser)
• 📱 xApps ("dApps")
  • Requirements
  • Develop & Test
  • CORS (xApp)
  • Xumm UI interaction
  • Your own backend (Auth)
  • Style guide
  • Development & Debugging
  • xAppBuilder 🏗️
    • Connecting localhost to xAppBuilder
    • xAppBuilder FAQ
• 📂 Backend (SDK / API)
  • User identification payloads
• 🎛️ Native Apps
• 🙇 Identity (OAuth2, OpenID)
  • Test Tools

JS/TS SDK

• Xaman SDK (Intro)
• Examples / User stories
  • Sign Requests (payloads)
    • Browser
    • xApp
    • Backend
  • Verify Payload signature
  • Simple Sign Request
• 📦 SDK (syntax)
  • Xumm.ping()
  • Xumm.on(event, fn)
  • Xumm.off(event, fn)
  • Xumm.helpers { … }
    • ping()
    • getRates( … )
    • getRails()
    • getHookHash( … )
    • getHookHashes()
    • getCuratedAssets()
    • getNftokenDetail( … )
    • getKycStatus( … )
    • verifyUserTokens([ … ])
    • getTransaction( … )
  • Xumm.user { … }
  • Xumm.environment { … }
  • Xumm.payload { … }
    • create( … )
    • createAndSubscribe( … )
    • cancel( … )
    • subscribe( … )
    • get( … )
  • Xumm.xapp { … }
    • ready()
    • openSignRequest({ … })
    • selectDestination({ … })
    • scanQr()
    • tx({ … })
    • close({ … })
    • share({ … })
    • navigate({ … })
    • openBrowser({ … })
    • on(xAppEvent, fn)
    • off(xAppEvent, fn)
  • Xumm.userstore { … }
    • list()
    • get( … )
    • delete( … )
    • set( … , { … } )
  • Xumm.backendstore { … }
    • get()
    • set({ … })
    • delete()
  • Xumm.push { … }
    • event( … )
    • notification( … )
  • Xumm.runtime { … }
  • Xumm.authorize()
  • Xumm.logout()