@tauri-apps/plugin-stronghold

Classes

Client

Constructors

new Client()

new Client(path, name): Client

Parameters

Parameter	Type
path	string
name	ClientPath

Returns

Client

Source: undefined

Properties

Property	Type	Defined in
name	ClientPath	Source: undefined
path	string	Source: undefined

Methods

getStore()

getStore(): Store

Returns

Store

Source: undefined

getVault()

getVault(name): Vault

Get a vault by name.

Parameters

Parameter	Type	Description
name	VaultPath

Returns

Vault

Source: undefined

---

Location

Constructors

new Location()

new Location(type, payload): Location

Parameters

Parameter	Type
type	string
payload	Record<string, unknown>

Returns

Location

Source: undefined

Properties

Property	Type	Defined in
payload	Record<string, unknown>	Source: undefined
type	string	Source: undefined

Methods

counter()

static counter(vault, counter): Location

Parameters

Parameter	Type
vault	VaultPath
counter	number

Returns

Location

Source: undefined

generic()

static generic(vault, record): Location

Parameters

Parameter	Type
vault	VaultPath
record	RecordPath

Returns

Location

Source: undefined

---

Store

Constructors

new Store()

new Store(path, client): Store

Parameters

Parameter	Type
path	string
client	ClientPath

Returns

Store

Source: undefined

Properties

Property	Type	Defined in
client	ClientPath	Source: undefined
path	string	Source: undefined

Methods

get()

get(key): Promise<null | Uint8Array<ArrayBufferLike>>

Parameters

Parameter	Type
key	StoreKey

Returns

Promise<null | Uint8Array<ArrayBufferLike>>

Source: undefined

insert()

insert(
   key,
   value,
lifetime?): Promise<void>

Parameters

Parameter	Type
key	StoreKey
value	number[]
lifetime?	Duration

Returns

Promise<void>

Source: undefined

remove()

remove(key): Promise<null | Uint8Array<ArrayBufferLike>>

Parameters

Parameter	Type
key	StoreKey

Returns

Promise<null | Uint8Array<ArrayBufferLike>>

Source: undefined

---

Stronghold

A representation of an access to a stronghold.

Properties

Property	Type	Defined in
path	string	Source: undefined

Methods

createClient()

createClient(client): Promise<Client>

Parameters

Parameter	Type
client	ClientPath

Returns

Promise<Client>

Source: undefined

loadClient()

loadClient(client): Promise<Client>

Parameters

Parameter	Type
client	ClientPath

Returns

Promise<Client>

Source: undefined

save()

save(): Promise<void>

Persists the stronghold state to the snapshot.

Returns

Promise<void>

Source: undefined

unload()

unload(): Promise<void>

Remove this instance from the cache.

Returns

Promise<void>

Source: undefined

load()

static load(path, password): Promise<Stronghold>

Load the snapshot if it exists (password must match), or start a fresh stronghold instance otherwise.

Parameters

Parameter	Type	Description
path	string	-
password	string

Returns

Promise<Stronghold>

Source: undefined

---

Vault

A key-value storage that allows create, update and delete operations. It does not allow reading the data, so one of the procedures must be used to manipulate the stored data, allowing secure storage of secrets.

Extends

• ProcedureExecutor

Constructors

new Vault()

new Vault(
   path,
   client,
   name): Vault

Parameters

Parameter	Type
path	string
client	ClientPath
name	VaultPath

Returns

Vault

Overrides

ProcedureExecutor.constructor

Source: undefined

Properties

Property	Type	Description	Inherited from	Defined in
client	ClientPath	-	-	Source: undefined
name	VaultPath	The vault name.	-	Source: undefined
path	string	The vault path.	-	Source: undefined
procedureArgs	Record<string, unknown>	-	ProcedureExecutor.procedureArgs	Source: undefined

Methods

deriveSLIP10()

deriveSLIP10(
   chain,
   source,
   sourceLocation,
outputLocation): Promise<Uint8Array<ArrayBufferLike>>

Derive a SLIP10 private key using a seed or key.

Parameters

Parameter	Type	Description
chain	number[]	The chain path.
source	"Seed" | "Key"	The source type, either ‘Seed’ or ‘Key’.
sourceLocation	Location	The source location, must be the outputLocation of a previous call to generateSLIP10Seed or deriveSLIP10.
outputLocation	Location	Location of the record where the private key will be stored.

Returns

Promise<Uint8Array<ArrayBufferLike>>

Inherited from

ProcedureExecutor.deriveSLIP10

Source: undefined

generateBIP39()

generateBIP39(outputLocation, passphrase?): Promise<Uint8Array<ArrayBufferLike>>

Generate a BIP39 seed.

Parameters

Parameter	Type	Description
outputLocation	Location	The location of the record where the BIP39 seed will be stored.
passphrase?	string	The optional mnemonic passphrase.

Returns

Promise<Uint8Array<ArrayBufferLike>>

Inherited from

ProcedureExecutor.generateBIP39

Source: undefined

generateSLIP10Seed()

generateSLIP10Seed(outputLocation, sizeBytes?): Promise<Uint8Array<ArrayBufferLike>>

Generate a SLIP10 seed for the given location.

Parameters

Parameter	Type	Description
outputLocation	Location	Location of the record where the seed will be stored.
sizeBytes?	number	The size in bytes of the SLIP10 seed.

Returns

Promise<Uint8Array<ArrayBufferLike>>

Inherited from

ProcedureExecutor.generateSLIP10Seed

Source: undefined

getEd25519PublicKey()

getEd25519PublicKey(privateKeyLocation): Promise<Uint8Array<ArrayBufferLike>>

Gets the Ed25519 public key of a SLIP10 private key.

Parameters

Parameter	Type	Description
privateKeyLocation	Location	The location of the private key. Must be the outputLocation of a previous call to deriveSLIP10.

Returns

Promise<Uint8Array<ArrayBufferLike>>

A promise resolving to the public key hex string.

Since

2.0.0

Inherited from

ProcedureExecutor.getEd25519PublicKey

Source: undefined

insert()

insert(recordPath, secret): Promise<void>

Insert a record to this vault.

Parameters

Parameter	Type
recordPath	RecordPath
secret	number[]

Returns

Promise<void>

Source: undefined

recoverBIP39()

recoverBIP39(
   mnemonic,
   outputLocation,
passphrase?): Promise<Uint8Array<ArrayBufferLike>>

Store a BIP39 mnemonic.

Parameters

Parameter	Type	Description
mnemonic	string	The mnemonic string.
outputLocation	Location	The location of the record where the BIP39 mnemonic will be stored.
passphrase?	string	The optional mnemonic passphrase.

Returns

Promise<Uint8Array<ArrayBufferLike>>

Inherited from

ProcedureExecutor.recoverBIP39

Source: undefined

remove()

remove(location): Promise<void>

Remove a record from the vault.

Parameters

Parameter	Type	Description
location	Location	The record location.

Returns

Promise<void>

Source: undefined

signEd25519()

signEd25519(privateKeyLocation, msg): Promise<Uint8Array<ArrayBufferLike>>

Creates a Ed25519 signature from a private key.

Parameters

Parameter	Type	Description
privateKeyLocation	Location	The location of the record where the private key is stored. Must be the outputLocation of a previous call to deriveSLIP10.
msg	string	The message to sign.

Returns

Promise<Uint8Array<ArrayBufferLike>>

A promise resolving to the signature hex string.

Since

2.0.0

Inherited from

ProcedureExecutor.signEd25519

Source: undefined

Interfaces

AddressInfo

Properties

Property	Type	Defined in
peers	Map<string, PeerAddress>	Source: undefined
relays	string[]	Source: undefined

---

ClientAccess

Properties

Property	Type	Defined in
cloneVaultDefault?	boolean	Source: undefined
cloneVaultExceptions?	Map<VaultPath, boolean>	Source: undefined
readStore?	boolean	Source: undefined
useVaultDefault?	boolean	Source: undefined
useVaultExceptions?	Map<VaultPath, boolean>	Source: undefined
writeStore?	boolean	Source: undefined
writeVaultDefault?	boolean	Source: undefined
writeVaultExceptions?	Map<VaultPath, boolean>	Source: undefined

---

ConnectionLimits

Properties

Property	Type	Defined in
maxEstablishedIncoming?	number	Source: undefined
maxEstablishedOutgoing?	number	Source: undefined
maxEstablishedPerPeer?	number	Source: undefined
maxEstablishedTotal?	number	Source: undefined
maxPendingIncoming?	number	Source: undefined
maxPendingOutgoing?	number	Source: undefined

---

Duration

A duration definition.

Properties

Property	Type	Description	Defined in
nanos	number	The fractional part of this Duration, in nanoseconds. Must be greater or equal to 0 and smaller than 1e+9 (the max number of nanoseoncds in a second)	Source: undefined
secs	number	The number of whole seconds contained by this Duration.	Source: undefined

---

NetworkConfig

Properties

Property	Type	Defined in
addresses?	AddressInfo	Source: undefined
connectionTimeout?	Duration	Source: undefined
connectionsLimit?	ConnectionLimits	Source: undefined
enableMdns?	boolean	Source: undefined
enableRelay?	boolean	Source: undefined
peerPermissions?	Map<string, Permissions>	Source: undefined
permissionsDefault?	Permissions	Source: undefined
requestTimeout?	Duration	Source: undefined

---

PeerAddress

Properties

Property	Type	Defined in
known	string[]	Source: undefined
use_relay_fallback	boolean	Source: undefined

---

Permissions

Properties

Property	Type	Defined in
default?	ClientAccess	Source: undefined
exceptions?	Map<VaultPath, ClientAccess>	Source: undefined

Type Aliases

ClientPath

type ClientPath: string | Iterable<number> | ArrayLike<number> | ArrayBuffer;

Source: undefined

---

RecordPath

type RecordPath: string | Iterable<number> | ArrayLike<number> | ArrayBuffer;

Source: undefined

---

StoreKey

type StoreKey: string | Iterable<number> | ArrayLike<number> | ArrayBuffer;

Source: undefined

---

VaultPath

type VaultPath: string | Iterable<number> | ArrayLike<number> | ArrayBuffer;

Source: undefined