/ramp-instant-sdk-android

Android SDK

Primary LanguageKotlin

ramp-instant-sdk-android

platform API

Ramp Instant is a library to integrate easy cryptocurrency buy with Ramp.

Prerequisites

Add this in your root build.gradle file (not your module build.gradle file):

allprojects {
	repositories {
		...
		maven { url "https://jitpack.io" }
	}
}

Add this in your AndroidManifest.xml file:

    <uses-permission android:name="android.permission.INTERNET" />
    
    <application
	...
 	>
	    ...
        <activity
            android:name="network.ramp.instantsdk.ui.bank.BankActivity"
            android:configChanges="keyboard|keyboardHidden|orientation|screenLayout|uiMode|screenSize|smallestScreenSize"
            android:launchMode="singleTask"
            android:windowSoftInputMode="adjustResize"
            android:theme="@style/RampInstant.NoActionBar">
            <intent-filter>
                <action android:name="android.intent.action.VIEW" />

                <category android:name="android.intent.category.DEFAULT" />
                <category android:name="android.intent.category.BROWSABLE" />

                <data
                    android:host="-> your appId <-"
                    android:scheme="rampnetwork" />
            </intent-filter>
        </activity>
        <activity
            android:name="network.ramp.instantsdk.ui.rampinstant.RampInstantActivity"
            android:configChanges="keyboard|keyboardHidden|orientation|screenLayout|uiMode|screenSize|smallestScreenSize"
            android:launchMode="singleTask"
            android:windowSoftInputMode="adjustResize"
            android:theme="@style/RampInstant.NoActionBar">

        </activity>
	    ...
     </application>

Dependency

Add this to your module's build.gradle file (make sure the version matches the JitPack badge above):

dependencies {
	...
	    implementation 'com.github.RampNetwork:ramp-instant-sdk-android:v0.4.3'
}

Usage

RampInstantSDK class needs to be fiiled with all the information necessary for Ramp to initialize. Its parameters are as follows:

hostLogoUrl: URL to your app's logo

hostAppName: your app's name

userAddress: 0x-prefixed ETH address of the buyer

swapAsset: 'ETH' or 'DAI' (optional)

swapAmount: int string - wei or token units (optional)

appID: id of your app

webhookStatusUrl: your URL for webhook updates (optional)

url: allows to provide an alternative URL to load a non-production version of the widget (optional)

RampInstantSDK is facade for the sdk. It starts Ramp widget, which allows to buy crypto. To start using RampInstant in your app, simply create RampInstantSDK instance with parameters of your choice, call 'show' method. If you want to subscribe on widget events simply call 'on' method.

// initialize RampInstantSDK
 val rampInstantSDK = RampInstantSDK(
                context,
                swapAsset,
                swapAmount,
                userAddress,
		appId,
                hostLogoUrl,
                hostAppName,
                webhookStatusUrl,
		url
          	)
		
		
 //subscribe for events
 rampInstantSDK.on { event ->
                    // do sth with event
                }
		
// start widget		
 rampInstantSDK.show()

License

TODO()