controller_proto.md

Protocol Documentation

Table of Contents

• controller_api.proto

  • AccessTokenData

  • AccessTokenIdentity

  • AddNewWalletRequest

  • AddNewWalletResponse

  • AppInstanceIdentity

  • CloseWalletSessionsRequest

  • CloseWalletSessionsResponse

  • DisableWalletRequest

  • DisableWalletResponse

  • DisableWalletsRequest

  • DisableWalletsResponse

  • DisableWalletsResponse.BookmarksEntry

  • EnableWalletRequest

  • EnableWalletResponse

  • EnableWalletsRequest

  • EnableWalletsResponse

  • EnableWalletsResponse.BookmarksEntry

  • Event

  • ExecuteSignRequestReq

  • ExecuteSignRequestResponse

  • GetAccountRequest

  • GetAccountResponse

  • GetEnabledWalletsRequest

  • GetEnabledWalletsResponse

  • GetEnabledWalletsResponse.BookmarksEntry

  • GetMultipleAccountRequest

  • GetMultipleAccountResponse

  • GetWalletInfoRequest

  • GetWalletInfoResponse

  • GetWalletSessionRequest

  • GetWalletSessionResponse

  • GetWalletSessionsRequest

  • GetWalletSessionsResponse

  • ImportWalletRequest

  • ImportWalletResponse

  • PrepareSignRequestReq

  • PrepareSignRequestResponse

  • SessionInfo

  • SignPurposeIdentity

  • SignRequestData

  • SignRequestEvent

  • SignRequestIdentity

  • StartWalletSessionRequest

  • StartWalletSessionResponse

  • WalletSessionEvent

  • WalletSessionIdentity

  • AccessTokenData.TokenRole

  • Event.Type

  • SignRequestData.ReqStatus

  • SignRequestEvent.Type

  • WalletSessionEvent.Type

  • WalletSessionStatus

  • HdWalletControllerManagerApi

  • HdWalletControllerWalletApi

• Scalar Value Types

Top

controller_api.proto

AccessTokenData

Field	Type	Label	Description
AccessTokenIdentifier	AccessTokenIdentity
Role	AccessTokenData.TokenRole
AccessTokenData	bytes

AccessTokenIdentity

Field	Type	Label	Description
UUID	string

AddNewWalletRequest

Field	Type	Label	Description
CreateAccessTokensCount	uint64		AccessTokens - count of access tokens: - one for signer access - one for "fake signer" - other for read-read only minimal value - 3

AddNewWalletResponse

Field	Type	Label	Description
WalletIdentifier	common.MnemonicWalletIdentity
WalletStatus	common.WalletStatus
AccessTokens	AccessTokenData	repeated

AppInstanceIdentity

Field	Type	Label	Description
UUID	string

CloseWalletSessionsRequest

Field	Type	Label	Description
WalletIdentifier	common.MnemonicWalletIdentity
SessionIdentifier	WalletSessionIdentity

CloseWalletSessionsResponse

Field	Type	Label	Description
WalletIdentifier	common.MnemonicWalletIdentity
SessionIdentifier	WalletSessionIdentity
SessionStatus	WalletSessionStatus

DisableWalletRequest

Field	Type	Label	Description
WalletIdentifier	common.MnemonicWalletIdentity

DisableWalletResponse

Field	Type	Label	Description
WalletIdentifier	common.MnemonicWalletIdentity
WalletStatus	common.WalletStatus

DisableWalletsRequest

Field	Type	Label	Description
WalletIdentifiers	common.MnemonicWalletIdentity	repeated

DisableWalletsResponse

Field	Type	Label	Description
WalletsCount	uint32
WalletsData	common.MnemonicWalletData	repeated
Bookmarks	DisableWalletsResponse.BookmarksEntry	repeated

DisableWalletsResponse.BookmarksEntry

Field	Type	Label	Description
key	string
value	uint32

EnableWalletRequest

Field	Type	Label	Description
WalletIdentifier	common.MnemonicWalletIdentity

EnableWalletResponse

Field	Type	Label	Description
WalletIdentifier	common.MnemonicWalletIdentity
WalletStatus	common.WalletStatus

EnableWalletsRequest

Field	Type	Label	Description
WalletIdentifiers	common.MnemonicWalletIdentity	repeated

EnableWalletsResponse

Field	Type	Label	Description
WalletsCount	uint32
WalletsData	common.MnemonicWalletData	repeated
Bookmarks	EnableWalletsResponse.BookmarksEntry	repeated

EnableWalletsResponse.BookmarksEntry

Field	Type	Label	Description
key	string
value	uint32

Event

Field	Type	Label	Description
EventType	Event.Type
AppInstanceIdentifier	AppInstanceIdentity
Data	bytes

ExecuteSignRequestReq

Field	Type	Label	Description
WalletIdentifier	common.MnemonicWalletIdentity
AccountIdentifier	common.AccountIdentity
SessionIdentifier	WalletSessionIdentity
SignRequestIdentifier	SignRequestIdentity
CreatedTxData	bytes

ExecuteSignRequestResponse

Field	Type	Label	Description
WalletIdentifier	common.MnemonicWalletIdentity
SessionIdentifier	WalletSessionIdentity
AccountIdentifier	common.AccountIdentity
SignatureRequestInfo	SignRequestData
SignedTxData	bytes

GetAccountRequest

Field	Type	Label	Description
WalletIdentifier	common.MnemonicWalletIdentity
SessionIdentifier	WalletSessionIdentity
AccountIdentifier	common.AccountIdentity

GetAccountResponse

Field	Type	Label	Description
WalletIdentifier	common.MnemonicWalletIdentity
SessionIdentifier	WalletSessionIdentity
AccountIdentifier	common.AccountIdentity

GetEnabledWalletsRequest

GetEnabledWalletsResponse

Field	Type	Label	Description
WalletsCount	uint32
WalletsData	common.MnemonicWalletData	repeated
Bookmarks	GetEnabledWalletsResponse.BookmarksEntry	repeated

GetEnabledWalletsResponse.BookmarksEntry

Field	Type	Label	Description
key	string
value	uint32

GetMultipleAccountRequest

Field	Type	Label	Description
WalletIdentifier	common.MnemonicWalletIdentity
SessionIdentifier	WalletSessionIdentity
Parameters	google.protobuf.Any

GetMultipleAccountResponse

Field	Type	Label	Description
WalletIdentifier	common.MnemonicWalletIdentity
SessionIdentifier	WalletSessionIdentity
AccountIdentitiesCount	uint64
AccountIdentifiers	common.AccountIdentity	repeated

GetWalletInfoRequest

Field	Type	Label	Description
WalletIdentifier	common.MnemonicWalletIdentity

GetWalletInfoResponse

Field	Type	Label	Description
WalletIdentifier	common.MnemonicWalletIdentity
WalletStatus	common.WalletStatus

GetWalletSessionRequest

Field	Type	Label	Description
WalletIdentifier	common.MnemonicWalletIdentity
SessionIdentifier	WalletSessionIdentity

GetWalletSessionResponse

Field	Type	Label	Description
WalletIdentifier	common.MnemonicWalletIdentity
Session	SessionInfo

GetWalletSessionsRequest

Field	Type	Label	Description
WalletIdentifier	common.MnemonicWalletIdentity

GetWalletSessionsResponse

Field	Type	Label	Description
WalletIdentifier	common.MnemonicWalletIdentity
ActiveSessions	SessionInfo	repeated

ImportWalletRequest

Field	Type	Label	Description
CreateAccessTokensCount	uint64		AccessTokens - count of access tokens: - one for signer access - one for "fake signer" - other for read-read only minimal value - 3
MnemonicPhrase	bytes

ImportWalletResponse

Field	Type	Label	Description
WalletIdentifier	common.MnemonicWalletIdentity
WalletStatus	common.WalletStatus
AccessTokens	AccessTokenData	repeated

PrepareSignRequestReq

Field	Type	Label	Description
WalletIdentifier	common.MnemonicWalletIdentity
AccountIdentifier	common.AccountIdentity
SessionIdentifier	WalletSessionIdentity
SignPurposeIdentifier	SignPurposeIdentity

PrepareSignRequestResponse

Field	Type	Label	Description
WalletIdentifier	common.MnemonicWalletIdentity
SessionIdentifier	WalletSessionIdentity
AccountIdentifier	common.AccountIdentity
SignatureRequestInfo	SignRequestData

SessionInfo

Field	Type	Label	Description
SessionIdentifier	WalletSessionIdentity
SessionStatus	WalletSessionStatus
SessionStartedAt	uint64
SessionExpiredAt	uint64

SignPurposeIdentity

Field	Type	Label	Description
UUID	string

SignRequestData

Field	Type	Label	Description
Identifier	SignRequestIdentity
Status	SignRequestData.ReqStatus
CreateAt	uint64

SignRequestEvent

Field	Type	Label	Description
EventType	SignRequestEvent.Type
SignRequestIdentifier	SignRequestIdentity

SignRequestIdentity

Field	Type	Label	Description
UUID	string

StartWalletSessionRequest

Field	Type	Label	Description
WalletIdentifier	common.MnemonicWalletIdentity

StartWalletSessionResponse

Field	Type	Label	Description
WalletIdentifier	common.MnemonicWalletIdentity
SessionIdentifier	WalletSessionIdentity
SessionStatus	WalletSessionStatus
SessionStartedAt	uint64
SessionExpiredAt	uint64

WalletSessionEvent

Field	Type	Label	Description
EventType	WalletSessionEvent.Type
WalletIdentifier	common.MnemonicWalletIdentity
SessionIdentifier	WalletSessionIdentity

WalletSessionIdentity

Field	Type	Label	Description
SessionUUID	string

AccessTokenData.TokenRole

Name	Number	Description
TOKE_ROLE_PLACEHOLDER	0
TOKE_ROLE_SIGNER	1
TOKE_ROLE_FAKE_SIGNER	2
TOKE_ROLE_INFORMER	3

Event.Type

Name	Number	Description
EVENT_TYPE_PLACEHOLDER	0
EVENT_TYPE_SESSION	1
EVENT_TYPE_SIGN_REQUEST	2

SignRequestData.ReqStatus

Name	Number	Description
REQUEST_PLACEHOLDER	0
REQUEST_CREATED	1
REQUEST_PREPARED	2
REQUEST_SIGNED	3
REQUEST_FAILED	4

SignRequestEvent.Type

Name	Number	Description
PLACEHOLDER	0
PREPARED	1
CLOSED	2

WalletSessionEvent.Type

Name	Number	Description
PLACEHOLDER	0
STARTED	1
CLOSED	2

WalletSessionStatus

Name	Number	Description
WALLET_SESSION_STATUS_PLACEHOLDER	0
WALLET_SESSION_STATUS_PREPARED	1
WALLET_SESSION_STATUS_CLOSED	2

HdWalletControllerManagerApi

Method Name	Request Type	Response Type	Description
AddNewWallet	AddNewWalletRequest	AddNewWalletResponse
ImportWallet	ImportWalletRequest	ImportWalletResponse
EnableWallet	EnableWalletRequest	EnableWalletResponse
GetWalletInfo	GetWalletInfoRequest	GetWalletInfoResponse
GetEnabledWallets	GetEnabledWalletsRequest	GetEnabledWalletsResponse
DisableWallet	DisableWalletRequest	DisableWalletResponse
DisableWallets	DisableWalletsRequest	DisableWalletsResponse
EnableWallets	EnableWalletsRequest	EnableWalletsResponse
GetAccount	GetAccountRequest	GetAccountResponse

HdWalletControllerWalletApi

Method Name	Request Type	Response Type	Description
GetWalletInfo	GetWalletInfoRequest	GetWalletInfoResponse
StartWalletSession	StartWalletSessionRequest	StartWalletSessionResponse
GetWalletSession	GetWalletSessionRequest	GetWalletSessionResponse
GetAllWalletSessions	GetWalletSessionsRequest	GetWalletSessionsResponse
CloseWalletSession	CloseWalletSessionsRequest	CloseWalletSessionsResponse
GetAccount	GetAccountRequest	GetAccountResponse
GetMultipleAccounts	GetMultipleAccountRequest	GetMultipleAccountResponse
PrepareSignRequest	PrepareSignRequestReq	PrepareSignRequestResponse
ExecuteSignRequest	ExecuteSignRequestReq	ExecuteSignRequestResponse

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)