Refer the sample.env for env sample and update key values and rename sample.env to .env
There are three ways to integrate with our platform/app and easily interact with end users for sign in & transaction signing (basically the MetaMask experience, except not based on a browser plugin but on a mobile app).
- Backend integration: you call our API (with our SDK or directly on our API), generate a sign in or sign request, get a paylaod ID, redirect URL (which is also the content for the QR code) and websocket URL for live status updates. Your backend communicates this to your frontend.
- Frontend-only integration through OAuth2 (PKCE) & JWT in return, then to be used @ frontend with our Javsacript/Typescript SDK or directly to our API
- Embedded (‘dApp like’) as a webapp inside Xumm, we call this ‘xApps’. JWT and API calls are easy, through our Javsacript/Typescript SDK in your xApp frontend.
In this Repo, We are covering approach1 If you want to identify a user based on a signed transaction (without asking the user for a payment) you can send a payload with a false TransactionType ie Sign In User.We are connecting our network on devnet network
Learning Material
- XUMM SDK
- Xumm Integration
- Payload
- Payload-transaction
- Register App for xumm credentials
- To Create new funded account
- Different Networks
- Reserves
- QR codes
- Accept Offer
- Transaction Errors
Extra resources
Must know things
- Signing payload from specific address and towards a specific network
- How do we detect if the account was signed through a test/dev/main net? (https://xumm.readme.io/discuss/62a185c8a51f14003091f913)
There is no USDC on the XRPL.There is USD issued by Gatehub and by Bitstamp, but that's not USDC.There is no public Faucet in devnet for usd In that case the parties to talk to are Gatehub and Bitstamp, and ask them to issue on testnet and provide a faucet there.