Micro Raiden is many to one unidirectional state channel protocol system and its off-chain transaction do not cost anything, exchange confined between sender and receiver. See µRaiden documentation for getting more information about Microraiden

Micro Raiden-Android is a java based Android library of µRaiden, which works with µRaiden Smart contract and Ethereum network. So far this library covers the Balance proof signature, Closing hash generation and java api's those are implemented by Microraiden.

It has a runtime dependency:

• Web3j for connecting and communicating with blockchain

Add it in your root build.gradle at the end of repositories:

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

If you are building with Gradle, simply add the following line to the dependencies section of your build.gradle file:

    implementation 'com.github.w3-engineers:microraiden-android:alpha-0.0.1'

For using microraiden library your project need to Java 8 Compatibility support

• For initializing Microraiden, you have to need a channel address, rpc url and set a gas price with a gas limit. Provide a MicroraidenListener listener during initialization.

    microraiden = new Microraiden(channelAddress, web3jRpcURL, mGasPrice, mGasLimit, this)

Acquainted with following variables for accessing microraiden API’s

For preparing a credentials you have to use private key

    Credentials.create(key)

For retrieving token address you should use getTokenAddress API with credentials

    microraiden.getTokenAddress(credentials); 

Create a new channel between sender and receiver for transferring the deposit then you will use createChannel API

    microraiden.createChannel(receiver, deposit, credentials); 

getChannelInfo retrieve the info about channel

    microraiden.getChannelInfo(sender, receiver, blockNumber, credentials);

topUpChannel using for increasing the channel deposit with newly added deposit

    microraiden.topUpChannel(receiver, blockNumber, addedDeposit, credentials); 

Receiver will create the balance proof signature from getBalanceProof API with receiver, blockNumber, balance and credentials

    microraiden.getBalanceProof(receiver, blockNumber, balance, credentials);

verifyBalanceProofSignature return the sender address after verifying the balance proof

    microraiden.verifyBalanceProofSignature(receiver, blockNumber, balance, balanceProof, credentials);

For preparing closing hash signature send can use getClosingSignature with sender, block number, balance and credentials parameters

    microraiden.getClosingHash(sender, blockNumber, balance, credentials);

verifyClosingHashSignature API is helpful for extracting/verifying closing hash signature and provide the receiver address. Following property required for extract closing hash, sender address, block number, balance, closing signature and credentials.

    microraiden.verifyClosingHashSignature(sender, blockNumber, balance, closingHash, credentials); 

withdrawBalance allow for receiver for with the token. For withdrawing balance you should use it and set the following parameters blockNumber, balance, balanceProof and credentials.

    microraiden.withdrawBalance(blockNumber, balance, balanceProof, credentials);

getChannelDepositLimit will share the limit of total token deposit in a channel

    microraiden.getChannelDepositLimit(credentials);

For getting channel key you should use getChannelKey with the set of following properties sender, receiver and blockNumber

    microraiden.getChannelKey(sender, receiver, blockNumber, credentials);

If you want the owner address then call the getOwnerAddress. Then you will get the owner ethereum address.

    microraiden.getOwnerAddress(credentials);

settleChannel will call the sender or receiver when close to the channel and immediate to the settle

    microraiden.settleChannel(receiver, blockNumber, credentials);

getVersion will provide the semantic versioning number to smart contract

    microraiden.getVersion(credentials);

getChallengePeriod that initiated by sender for waiting an uncooperativeClose

    microraiden.getChallengePeriod(credentials); 

addTrustedContracts API called only by owner for adding a set of contract in trusted contract list

    microraiden.addTrustedContracts(trustedContracts, credentials);

createChannelDelegate only allow for delegate contract who can create a channel using sender, receiver, deposit amount and credentials

    microraiden.createChannelDelegate(sender, receiver, deposit, credentials);

topUpDelegate only allow for delegate contract who can increase the channel deposit

    microraiden.topUpDelegate(sender, receiver, blockNumber, addedDeposit, credentials);

removeTrustedContracts only called by owner to remove a contract from trusted contract list.

    microraiden.removeTrustedContracts(trustedContracts, credentials);

closeChannelCooperative called by sender, receiver and delegate contracts, when the need to close the channel and settle immediately.

    microraiden.closeChannelCooperative(receiver, blockNumber, balance, balanceProof, closingHash, credentials); 

closeChannelUncooperative can called by sender with set a challenge period of time

    microraiden.closeChannelUncooperative(receiver, blockNumber, balance, credentials);