Quickstart for Android

📘
Android OS 최소 요구사항
LunieWallet SDK는 안드로이드 API Level 23 이상을 지원하는 안드로이드 OS 버전을 지원합니다. 23 미만의 API Level을 사용하는 OS 버전에서는 SDK를 포함한 어플리케이션이 런타임에 정상적으로 구동되지 않을 수 있습니다. 각 OS 버전 별 지원 API Level을 확인하려면 안드로이드 Release Note 페이지를 참고하세요.

안드로이드 프로젝트에 Wallet SDK 연동하기

Wallet SDK를 다운로드 받은 뒤 lib 폴더 하위에 저장합니다.
app/build.gradle 파일에 아래와 같이 의존성을 추가합니다.

...
dependencies {
  	implementation files('../lib/LunieWalletSDK.aar')
  	implementation "org.web3j:core:4.8.8-android"
  	implementation "com.squareup.retrofit2:retrofit:2.9.0"
  	implementation "com.squareup.retrofit2:converter-gson:2.9.0"
  	implementation "androidx.security:security-crypto:1.0.0"
  	implementation 'com.google.zxing:core:3.2.1'
}

Nodit 콘솔 에 접속하여 가입한 뒤, Wallet SDK Guide 페이지를 참고하여 Environment API Key를 발급합니다.
3에서 발급받은 API Key 사용을 위해 config파일을 생성한 후 Wallet API Key를 입력합니다. config 파일의 경로는 다음과 같습니다. server를 입력하지 않는 경우, default로 Nodit의 서버를 이용하게 됩니다.

projectFilePath/app/src/assets/lunie_wallet_configuration.json

{ 
  "webview_server_url": "${WALLET_WEBVIEW_URL}", // If not entered, the Nodit server will be used as the default.
  "api_server_url": "${WALLET_API_URL}", // If not entered, the Nodit server will be used as the default.
  "wallet_api_key":"${WALLET_API_KEY}" // required field
}

SDK 초기화 및 지갑 생성/로드하기

LunieWallet SDK를 import한 후 아래와 같이 선언하여 SDK를 초기화할 수 있습니다.

Lunie.init(applicationContext)

안드로이드 Keystore에 저장된 지갑 생성 이력을 조회한 후, 이력이 있을 경우 저장된 mnemonic 통해 지갑을 로드하고 이력이 없는 경우 신규 지갑 Instance를 생성할 수 있습니다.

//1. Check Wallet exist
val isAlreadySet = when (val result = LunieWallet.isAlreadySetWallet()) {
    is LunieWalletResult.Success -> result.data
    is LunieWalletResult.Fail -> {
       Log.e("LunieWallet", result.error.message ?: "Unknown Error")
       return
    }
}

// Option 2-1. Load wallet from stored mnemonic in SecureLocalStorage if isAlreadySet ==1
val wallet = when (val result = LunieWallet.getInstanceSavedWallet()) {
    is LunieWalletResult.Success -> result.data
    is LunieWalletResult.Fail -> {
        Log.e("LunieWallet", result.error.message ?: "Unknown Error")
        return
    }
}

// Option 2-2. Create new wallet if isAlreadySet == 0
val wallet = when (val result = LunieWallet.getInstanceNewWallet()) {
    is LunieWalletResult.Success -> result.data
    is LunieWalletResult.Fail -> {
        Log.e("LunieWallet", result.error.message ?: "Unknown Error")
        return
    }
}

Wallet SDK API

Init For Use

라이브러리 초기화 함수로 LunieWallet SDK 사용 전 필수로 가장 먼저 호출되어야 합니다.

Lunie.init(applicationContext)

Create New Wallet

새로운 mnemonic key를 생성한 후 이를 이용하여 Wallet Instance를 생성합니다.

val wallet = when (val result = LunieWallet.getInstanceNewWallet()) {
    is LunieWalletResult.Success -> result.data
    is LunieWalletResult.Fail -> {
        Log.e("LunieWallet", result.error.message ?: "Unknown Error")
        return
    }
}

Check Wallet Existence

현재 디바이스에 저장된 Wallet Instance가 있는지 확인합니다.

val isAlreadySet = when (val result = LunieWallet.isAlreadySetWallet()) {
    is LunieWalletResult.Success -> result.data
    is LunieWalletResult.Fail -> {
        Log.e("LunieWallet", result.error.message ?: "Unknown Error")
        return
    }
}

Load Wallet

현재 디바이스에 저장된 Wallet Instance를 확인한 후, Instance가 존재할 경우, 이를 Load 합니다.

//1. Check Wallet existence
val isAlreadySet = when (val result = LunieWallet.isAlreadySetWallet()) {
    is LunieWalletResult.Success -> result.data
    is LunieWalletResult.Fail -> {
        Log.e("LunieWallet", result.error.message ?: "Unknown Error")
        return
    }
}

if(isAlreadySet) {
    // 2. Load saved wallet from SecureLocalStorage
    val wallet = when (val result = LunieWallet.getInstanceSavedWallet()) {
        is LunieWalletResult.Success -> result.data
        is LunieWalletResult.Fail -> {
            Log.e("LunieWallet", result.error.message ?: "Unknown Error")
            return
        }
    }
} else {
    // create new one
}

Recovery Wallet(MPC)

지갑을 복구하는 방법으로 백업해 둔 SecretShares를 이용하여 mnemonic을 복구합니다. 그리고 복구한 mnemonic을 이용하여 Wallet을 복구합니다.

// 1. Get secretShares for backup
val secretShares = when (val result = wallet.getSecretShares()) {
    is LunieWalletResult.Success -> result.data
    is LunieWalletResult.Fail -> {
        Log.e("LunieWallet", result.error.message ?: "Unknown Error")
        return
    }
}

// 2. Recovery wallet from secretShares
val wallet = when (val result = LunieWallet.recoveryWalletFromSecretKeys(secretShares)) {
    is LunieWalletResult.Success -> result.data
    is LunieWalletResult.Fail -> {
        Log.e("LunieWallet", result.error.message ?: "Unknown Error")
        return
    }
}

// 3. Recovery wallet from mnemonic
val wallet = when (val result = LunieWallet.recoveryWalletFromMnemonic(mnemonic)) {
    is LunieWalletResult.Success -> result.data
    is LunieWalletResult.Fail -> {
        Log.e("LunieWallet", result.error.message ?: "Unknown Error")
        return
    }
}

Get Address

특정 주소와 네트워크를 지정하여 해당 지갑이 해당 네트워크에 보유한 자산을 조회합니다.

val network = NETWORK_THE_BALANCE
val address = when (val result = network.getAddress(wallet)) {
    is LunieWalletResult.Success -> result.data
    is LunieWalletResult.Fail -> {
        Log.e("LunieWallet", result.error.message ?: "Unknown Error")
        return
    }
}

Get NFTs

특정 주소와 네트워크를 지정하여 해당 지갑이 해당 네트워크에 보유한 NFT를 조회합니다.

val network = NETWORK_THE_BALANCE
val address = "0x9baCE0756260de6d28A89AcfcBf37BC512ff2333"
val (page, itemCount) = 1 to 10
val nftCollections = when (val result = network.getNFTs(address, page, itemCount)) {
    is LunieWalletResult.Success -> result.data
    is LunieWalletResult.Fail -> {
        Log.e("LunieWallet", result.error.message ?: "Unknown Error")
        return
    }
}

Get Native Token

특정 주소와 네트워크를 지정하여 해당 지갑이 해당 네트워크에 보유한 Native Token을 조회합니다.

val network = NETWORK_THE_BALANCE
val address = "0x9baCE0756260de6d28A89AcfcBf37BC512ff2333"
val nativeTokenBalance = when (val result = network.getNativeToken(address)) {
    is LunieWalletResult.Success -> result.data
    is LunieWalletResult.Fail -> {
        Log.e("LunieWallet", result.error.message ?: "Unknown Error")
        return
    }
}

Get Tokens

특정 주소와 네트워크를 지정하여 해당 지갑이 해당 네트워크에 보유한 ERC20을 조회합니다.

val network = NETWORK_THE_BALANCE
val address = "0x9baCE0756260de6d28A89AcfcBf37BC512ff2333"
val (page, itemCount) = 1 to 10
val tokenBalances = when (val result = network.getTokens(address, page, itemCount)) {
    is LunieWalletResult.Success -> result.data
    is LunieWalletResult.Fail -> {
        Log.e("LunieWallet", result.error.message ?: "Unknown Error")
        return
    }
}

Get Gas Limit(NFT)

특정 주소와 네트워크를 지정하여 해당 지갑이 해당 네트워크에서 NFT를 전송하기 위해 필요한 GasLimit을 조회합니다.

val network = NETWORK_THE_BALANCE
val toAddress = "0x9baCE0756260de6d28A89AcfcBf37BC512ff2333"
val gaslimit = when (val result = network.getGasLimit(lunieWallet, toAddress, nft)) {
    is LunieWalletResult.Success -> result.data
    is LunieWalletResult.Fail -> {
        Log.e("LunieWallet", result.error.message ?: "Unknown Error")
        return
    }
}

Get Gas Limit(Token)

특정 주소와 네트워크를 지정하여 해당 지갑이 해당 네트워크에서 Token를 전송하기 위해 필요한 GasLimit을 조회합니다.

val network = NETWORK_THE_BALANCE
val toAddress = "0x9baCE0756260de6d28A89AcfcBf37BC512ff2333"
val gaslimit = when (val result = network.getGasLimit(lunieWallet, toAddress, token, tokenAmount)) {
    is LunieWalletResult.Success -> result.data
    is LunieWalletResult.Fail -> {
        Log.e("LunieWallet", result.error.message ?: "Unknown Error")
        return
    }
}

Get Gas Price

특정 주소와 네트워크를 지정하여 해당 지갑이 해당 네트워크에서 Transfer를 실행하기 위해 필요한 GasPrice를 조회합니다.

val network = NETWORK_THE_BALANCE
val toAddress = "0x9baCE0756260de6d28A89AcfcBf37BC512ff2333"
val gasPrice = when (val result = network.getGasPrice()) {
    is LunieWalletResult.Success -> result.data
    is LunieWalletResult.Fail -> {
        Log.e("LunieWallet", result.error.message ?: "Unknown Error")
        return
    }
}

Get Transaction Result By Hash

트랜잭션의 Hash와 네트워크를 지정하여 해당 트랜잭션의 상세 내역을 조회합니다.

val network = NETWORK_THE_BALANCE
val transactionHash = "0xf2edcf8f59cfce9350785f4d9cbdaa7ce76f6fabd4a3a96c3de82b91237973a1"
val transactionResult = when (val result = network.getTransactionResultByHash(transactionHash)) {
    is LunieWalletResult.Success -> result.data
    is LunieWalletResult.Fail -> {
        Log.e("LunieWallet", result.error.message ?: "Unknown Error")
        return
    }
}

Get Account Transaction Results

특정 주소와 네트워크를 지정하여 해당 주소가 포함된 트랜잭션의 전체 내역을 조회합니다.

val network = NETWORK_THE_BALANCE
val address = "0x9baCE0756260de6d28A89AcfcBf37BC512ff2333"
val (page, itemCount) = 1 to 10
val transactionResults =
    when (val result = network.getAccountTransactionResults(address, page, itemCount)) {
        is LunieWalletResult.Success -> result.data
        is LunieWalletResult.Fail -> {
            Log.e("LunieWallet", result.error.message ?: "Unknown Error")
            return
        }
    }

Get Token transaction From Address

특정 주소와 네트워크를 지정하여 해당 주소의 ERC20 트랜잭션의 상세 내역을 조회합니다.

val network = NETWORK_THE_BALANCE
val address = "0x9baCE0756260de6d28A89AcfcBf37BC512ff2333"
val (page, itemCount) = 1 to 10
val transactionResults =
    when (val result = network.getTokenTransactionFromAddress(address, page, itemCount)) {
        is LunieWalletResult.Success -> result.data
        is LunieWalletResult.Fail -> {
            Log.e("LunieWallet", result.error.message ?: "Unknown Error")
            return
        }
    }

Transfer NFT

특정 주소와 네트워크를 지정하여 유저의 지갑이 보유한 NFT를 특정 주소로 전송하는 Transfer를 실행합니다.

val network = NETWORK_THE_BALANCE
val tdAddress = "0x9baCE0756260de6d28A89AcfcBf37BC512ff2333"
val transactionHash = when (val result = network.transferNFT(lunieWallet, tdAddress, nft)) {
    is LunieWalletResult.Success -> result.data
    is LunieWalletResult.Fail -> {
        Log.e("LunieWallet", result.error.message ?: "Unknown Error")
        return
    }
}

Transfer Token

특정 주소와 네트워크를 지정하여 유저의 지갑이 보유한 ERC20을 특정 주소로 전송하는 Transfer를 실행합니다.

val network = NETWORK_THE_BALANCE
val tdAddress = "0x9baCE0756260de6d28A89AcfcBf37BC512ff2333"
val transactionHash =
    when (val result = network.transferToken(lunieWallet, tdAddress, token, amount)) {
        is LunieWalletResult.Success -> result.data
        is LunieWalletResult.Fail -> {
            Log.e("LunieWallet", result.error.message ?: "Unknown Error")
            return
        }
    }

Wallet UI Component Setting

Wallet SDK는 편리한 개발을 지원하기 위해 기본적인 WebView를 지원합니다. 아래 코드를 이용하여 해당 WebView를 확인할 수 있습니다.

// 1. WalletView Initial Setting
override fun onCreateView() {
    ...
    lunieWalletView.init(wallet)
}

<LinearLayout 
	android:layout_width="match_parent"
	android:layout_height="match_parent">
	<com.lambda256.walletsdk.LunieWalletView
		android:layout_width="match_parent"
		android:layout_height="match_parent"/>
</LinearLayout>

📘Android OS 최소 요구사항

안드로이드 프로젝트에 Wallet SDK 연동하기

SDK 초기화 및 지갑 생성/로드하기

Wallet SDK API

Init For Use

Create New Wallet

Check Wallet Existence

Load Wallet

Recovery Wallet(MPC)

Get Address

Get NFTs

Get Native Token

Get Tokens

Get Gas Limit(NFT)

Get Gas Limit(Token)

Get Gas Price

Get Transaction Result By Hash

Get Account Transaction Results

Get Token transaction From Address

Transfer NFT

Transfer Token

Wallet UI Component Setting

📘
Android OS 최소 요구사항