Class: Client
client.Client
Client is a class-based interface for managing a Lattice device.
Constructors
constructor
• new Client(params)
Parameters
| Name | Type | Description |
|---|---|---|
params | Object | Parameters are passed as an object. |
params.baseUrl? | string | The base URL of the signing server. |
params.deviceId? | string | The ID of the connected Lattice |
params.name? | string | The name of the client. |
params.privKey? | string | Buffer | The private key of the client. |
params.retryCount? | number | Number of times to retry a request if it fails. |
params.skipRetryOnWrongWallet? | boolean | If true we will not retry if we get a wrong wallet error code |
params.stateData? | string | User can pass in previous state data to rehydrate connected session |
params.timeout? | number | The time to wait for a response before cancelling. |
Defined in
Properties
activeWallets
• activeWallets: ActiveWallets
Information about the current wallet. Should be null unless we know a wallet is present
Defined in
baseUrl
• baseUrl: string
The base of the remote url to which the SDK sends requests.
Defined in
isPaired
• isPaired: boolean
Is the Lattice paired with this Client.
Defined in
timeout
• timeout: number
The time to wait for a response before cancelling.
Defined in
Lattice Methods
addKvRecords
▸ addKvRecords(__namedParameters): Promise<Buffer>
Takes in a set of key-value records and sends a request to add them to the Lattice.
Parameters
| Name | Type |
|---|---|
__namedParameters | AddKvRecordsRequestParams |
Returns
Promise<Buffer>
Defined in
connect
▸ connect(deviceId): Promise<any>
Attempt to contact a device based on its deviceId. The response should include an ephemeral
public key, which is used to pair with the device in a later request.
Parameters
| Name | Type |
|---|---|
deviceId | string |
Returns
Promise<any>
Defined in
fetchEncryptedData
▸ fetchEncryptedData(params): Promise<Buffer>
Fetch a record of encrypted data from the Lattice. Must specify a data type. Returns a Buffer containing data formatted according to the specified type.
Parameters
| Name | Type |
|---|---|
params | FetchEncDataRequest |
Returns
Promise<Buffer>
Defined in
getAddresses
▸ getAddresses(__namedParameters): Promise<string[] | Buffer[]>
Takes a starting path and a number to get the addresses associated with the active wallet.
Parameters
| Name | Type |
|---|---|
__namedParameters | GetAddressesRequestParams |
Returns
Promise<string[] | Buffer[]>
Defined in
getKvRecords
▸ getKvRecords(__namedParameters): Promise<GetKvRecordsData>
Fetches a list of key-value records from the Lattice.
Parameters
| Name | Type |
|---|---|
__namedParameters | GetKvRecordsRequestParams |
Returns
Promise<GetKvRecordsData>
Defined in
pair
▸ pair(pairingSecret): Promise<any>
If a pairing secret is provided, pair uses it to sign a hash of the public key, name, and
pairing secret. It then sends the name and signature to the device. If no pairing secret is
provided, pair sends a zero-length name buffer to the device.
Parameters
| Name | Type |
|---|---|
pairingSecret | string |
Returns
Promise<any>
Defined in
removeKvRecords
▸ removeKvRecords(__namedParameters): Promise<Buffer>
Takes in an array of ids and sends a request to remove them from the Lattice.
Parameters
| Name | Type |
|---|---|
__namedParameters | RemoveKvRecordsRequestParams |
Returns
Promise<Buffer>
Defined in
sign
▸ sign(__namedParameters): Promise<SignData>
Builds and sends a request for signing to the Lattice.
Parameters
| Name | Type |
|---|---|
__namedParameters | SignRequestParams |
Returns
Promise<SignData>
Defined in
Other Methods
fetchActiveWallet
▸ fetchActiveWallet(): Promise<ActiveWallets>
Fetch the active wallet in the Lattice.
Returns
Promise<ActiveWallets>
Defined in
getActiveWallet
▸ getActiveWallet(): Wallet
Get the active wallet
Returns
Defined in
getAppName
▸ getAppName(): string
Get the pairing name for this client instance
Returns
string
Defined in
getDeviceId
▸ getDeviceId(): string
Get the deviceId for this client instance
Returns
string
Defined in
hasActiveWallet
▸ hasActiveWallet(): boolean
Check if the user has an active wallet
Returns
boolean
Defined in
mutate
▸ mutate(__namedParameters): void
Handles the mutation of Client state in the primary functions.
Parameters
| Name | Type |
|---|---|
__namedParameters | Object |
__namedParameters.activeWallets? | ActiveWallets |
__namedParameters.deviceId? | string |
__namedParameters.ephemeralPub? | Buffer |
__namedParameters.fwVersion? | Buffer |
__namedParameters.isPaired? | boolean |
__namedParameters.url? | string |
Returns
void