org.exoplatform.addon.ethereum.wallet.service

Interface WalletService

public interface WalletService

A storage service to save/load information used by users and spaces wallets

Method Summary

Modifier and Type	Method and Description
GlobalSettings	getSettings() Retrieves global stored settings used for all users.
GlobalSettings	getSettings(Long networkId) Retrieves global stored settings.
GlobalSettings	getSettings(Long networkId, String spaceId, String currentUser) Retrieves global stored settings.
boolean	isFundRequestSent(String notificationId, String currentUser) Get fund request status
void	markFundRequestAsSent(String notificationId, String currentUser) Mark a fund request web notification as sent
void	requestFunds(FundsRequest fundsRequest, String currentUser) Save funds request and send notifications
void	saveSettings(GlobalSettings newGlobalSettings) Save global settings
void	saveSettings(GlobalSettings newGlobalSettings, Integer dataVersion) Save global settings with new dataversion
void	saveUserPreferences(String currentUser, WalletPreferences userPreferences) Save user preferences of Wallet

Method Detail

saveSettings

void saveSettings(GlobalSettings newGlobalSettings)

Save global settings

Parameters:

newGlobalSettings - global settings to save

saveSettings

void saveSettings(GlobalSettings newGlobalSettings,
                  Integer dataVersion)

Save global settings with new dataversion

Parameters:

newGlobalSettings - global settings to save

dataVersion - new data version of global settings to save

getSettings

GlobalSettings getSettings()

Retrieves global stored settings used for all users.

Returns:

GlobalSettings global settings of default watched blockchain network without user preferences

getSettings

GlobalSettings getSettings(Long networkId)

Retrieves global stored settings. if username is not null, the personal settings will be included.

Parameters:

networkId - blockchain network id to retrieve its settings

Returns:

GlobalSettings global settings of blockchain network id without user preferences

getSettings

GlobalSettings getSettings(Long networkId,
                           String spaceId,
                           String currentUser)

Retrieves global stored settings. if username is not null, the personal settings will be included. if spaceId is not null wallet address will be retrieved

Parameters:

networkId - blockchain network id to retrieve its settings

spaceId - space pretty name to include its settings

currentUser - username to include its preferences

Returns:

GlobalSettings global settings with user and space preferences included into it

saveUserPreferences

void saveUserPreferences(String currentUser,
                         WalletPreferences userPreferences)

Save user preferences of Wallet

Parameters:

currentUser - current user name to save its preferences

userPreferences - user preferences to save

requestFunds

void requestFunds(FundsRequest fundsRequest,
                  String currentUser)
           throws IllegalAccessException

Save funds request and send notifications

Parameters:

fundsRequest - funds request details to save

currentUser - username of user sending request

Throws:

IllegalAccessException - if request sender is not allowed to send request to receiver wallet

markFundRequestAsSent

void markFundRequestAsSent(String notificationId,
                           String currentUser)
                    throws IllegalAccessException

Mark a fund request web notification as sent

Parameters:

notificationId - web notification id

currentUser - current username that is marking the notification as sent

Throws:

IllegalAccessException - if current user is not the targetted user of notification

isFundRequestSent

boolean isFundRequestSent(String notificationId,
                          String currentUser)
                   throws IllegalAccessException

Get fund request status

Parameters:

notificationId - web notification id

currentUser - current username

Returns:

true if fund request sent

Throws:

IllegalAccessException - if current user is not the targetted user of notification