@gala-chain/api ∙ API
API > RegisterUserDto
Class: RegisterUserDto
Contents
- Description
- Extends
- Constructors
- new RegisterUserDto()
- Properties
- prefix
- publicKey
- signature
- signerAddress
- signerPublicKey
- signing
- trace
- uniqueKey
- user
- ENCODING
- Methods
- isSignatureValid()
- serialize()
- sign()
- signed()
- validate()
- validateOrReject()
- deserialize()
Description
Dto for secure method to save public keys for legacy users. Method is called and signed by Curators
Extends
Constructors
new RegisterUserDto()
new RegisterUserDto():
RegisterUserDto
Inherited from
Properties
prefix
prefix?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:160
publicKey
publicKey:
string
Description
Public secp256k1 key (compact or non-compact, hex or base64).
Source
chain-api/src/types/dtos.ts:420
signature
signature?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:151
signerAddress
signerAddress?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:167
signerPublicKey
signerPublicKey?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:174
signing
signing?:
SigningScheme
Inherited from
Source
chain-api/src/types/dtos.ts:184
trace
trace?:
TraceContext
Inherited from
Source
chain-api/src/types/dtos.ts:126
uniqueKey
uniqueKey?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:141
user
user:
string
Description
Id of user to save public key for. Must be a valid user alias. See also @IsUserAlias().
Source
chain-api/src/types/dtos.ts:413
ENCODING
static
readonly
ENCODING:"base64"
="base64"
Inherited from
Source
chain-api/src/types/dtos.ts:127
Methods
isSignatureValid()
isSignatureValid(
publicKey
):boolean
Parameters
▪ publicKey: string
Inherited from
Source
chain-api/src/types/dtos.ts:258
serialize()
serialize():
string
Returns
string
Inherited from
Description
Serialze this object to string in a determinsitic fashion. See Hyperledger Fabric's documentation on JSON Determinism for more details.
Source
chain-api/src/types/dtos.ts:208
sign()
sign(
privateKey
,useDer
):void
Parameters
▪ privateKey: string
▪ useDer: boolean
= false
Inherited from
Source
chain-api/src/types/dtos.ts:236
signed()
signed(
privateKey
,useDer
):RegisterUserDto
Creates a signed copy of current object.
Parameters
▪ privateKey: string
▪ useDer: boolean
= false
Inherited from
Source
chain-api/src/types/dtos.ts:252
validate()
validate():
Promise
\<ValidationError
[]>
Inherited from
Source
chain-api/src/types/dtos.ts:186
validateOrReject()
validateOrReject():
Promise
\<void
>
Inherited from
Source
chain-api/src/types/dtos.ts:190
deserialize()
static
deserialize\<T
>(constructor
,object
):T
Type parameters
▪ T
Parameters
▪ constructor: ClassConstructor
\<Inferred
\<T
, ChainCallDTO
>>
ClassConstructor
that extends ChainCallDTO
▪ object: string
| Record
\<string
, unknown
> | Record
\<string
, unknown
>[]
serialized string or plain object to be instantiated via the provided ClassConstructor
Returns
An instantiated class created with the provided ClassConstructor
Inherited from
Description
Instantiate a class instance from a serialized object using the provided ClassConstructor
.