@tauri-apps/plugin-stronghold

Classes

Client

Defined in: plugins/stronghold/guest-js/index.ts:261

Constructors

new Client()

new Client(path, name): Client;

Defined in: plugins/stronghold/guest-js/index.ts:265

Parameters

Parameter	Type
path	string
name	ClientPath

Returns

Client

Properties

Property	Type	Defined in
name	ClientPath	plugins/stronghold/guest-js/index.ts:263
path	string	plugins/stronghold/guest-js/index.ts:262

Methods

getStore()

getStore(): Store;

Defined in: plugins/stronghold/guest-js/index.ts:280

Returns

Store

getVault()

getVault(name): Vault;

Defined in: plugins/stronghold/guest-js/index.ts:276

Get a vault by name.

Parameters

Parameter	Type	Description
name	VaultPath	-

Returns

Vault

---

Location

Defined in: plugins/stronghold/guest-js/index.ts:82

Constructors

new Location()

new Location(type, payload): Location;

Defined in: plugins/stronghold/guest-js/index.ts:86

Parameters

Parameter	Type
type	string
payload	Record<string, unknown>

Returns

Location

Properties

Property	Type	Defined in
payload	Record<string, unknown>	plugins/stronghold/guest-js/index.ts:84
type	string	plugins/stronghold/guest-js/index.ts:83

Methods

counter()

static counter(vault, counter): Location;

Defined in: plugins/stronghold/guest-js/index.ts:98

Parameters

Parameter	Type
vault	VaultPath
counter	number

Returns

Location

generic()

static generic(vault, record): Location;

Defined in: plugins/stronghold/guest-js/index.ts:91

Parameters

Parameter	Type
vault	VaultPath
record	RecordPath

Returns

Location

---

Store

Defined in: plugins/stronghold/guest-js/index.ts:285

Constructors

new Store()

new Store(path, client): Store;

Defined in: plugins/stronghold/guest-js/index.ts:289

Parameters

Parameter	Type
path	string
client	ClientPath

Returns

Store

Properties

Property	Type	Defined in
client	ClientPath	plugins/stronghold/guest-js/index.ts:287
path	string	plugins/stronghold/guest-js/index.ts:286

Methods

get()

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

Defined in: plugins/stronghold/guest-js/index.ts:294

Parameters

Parameter	Type
key	StoreKey

Returns

Promise< | Uint8Array | null>

insert()

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

Defined in: plugins/stronghold/guest-js/index.ts:302

Parameters

Parameter	Type
key	StoreKey
value	number[]
lifetime?	Duration

Returns

Promise<void>

remove()

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

Defined in: plugins/stronghold/guest-js/index.ts:316

Parameters

Parameter	Type
key	StoreKey

Returns

Promise< | Uint8Array | null>

---

Stronghold

Defined in: plugins/stronghold/guest-js/index.ts:387

A representation of an access to a stronghold.

Properties

Property	Type	Defined in
path	string	plugins/stronghold/guest-js/index.ts:388

Methods

createClient()

createClient(client): Promise<Client>;

Defined in: plugins/stronghold/guest-js/index.ts:428

Parameters

Parameter	Type
client	ClientPath

Returns

Promise<Client>

loadClient()

loadClient(client): Promise<Client>;

Defined in: plugins/stronghold/guest-js/index.ts:421

Parameters

Parameter	Type
client	ClientPath

Returns

Promise<Client>

save()

save(): Promise<void>;

Defined in: plugins/stronghold/guest-js/index.ts:439

Persists the stronghold state to the snapshot.

Returns

Promise<void>

unload()

unload(): Promise<void>;

Defined in: plugins/stronghold/guest-js/index.ts:415

Remove this instance from the cache.

Returns

Promise<void>

load()

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

Defined in: plugins/stronghold/guest-js/index.ts:405

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>

---

Vault

Defined in: plugins/stronghold/guest-js/index.ts:333

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;

Defined in: plugins/stronghold/guest-js/index.ts:340

Parameters

Parameter	Type
path	string
client	ClientPath
name	VaultPath

Returns

Vault

Overrides

ProcedureExecutor.constructor

Properties

Property	Type	Description	Inherited from	Defined in
client	ClientPath	-	-	plugins/stronghold/guest-js/index.ts:336
name	VaultPath	The vault name.	-	plugins/stronghold/guest-js/index.ts:338
path	string	The vault path.	-	plugins/stronghold/guest-js/index.ts:335
procedureArgs	Record<string, unknown>	-	ProcedureExecutor.procedureArgs	plugins/stronghold/guest-js/index.ts:107

Methods

deriveSLIP10()

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

Defined in: plugins/stronghold/guest-js/index.ts:145

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>

Inherited from

ProcedureExecutor.deriveSLIP10

generateBIP39()

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

Defined in: plugins/stronghold/guest-js/index.ts:200

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>

Inherited from

ProcedureExecutor.generateBIP39

generateSLIP10Seed()

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

Defined in: plugins/stronghold/guest-js/index.ts:120

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>

Inherited from

ProcedureExecutor.generateSLIP10Seed

getEd25519PublicKey()

getEd25519PublicKey(privateKeyLocation): Promise<Uint8Array>;

Defined in: plugins/stronghold/guest-js/index.ts:223

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>

A promise resolving to the public key hex string.

Since

2.0.0

Inherited from

ProcedureExecutor.getEd25519PublicKey

insert()

insert(recordPath, secret): Promise<void>;

Defined in: plugins/stronghold/guest-js/index.ts:358

Insert a record to this vault.

Parameters

Parameter	Type
recordPath	RecordPath
secret	number[]

Returns

Promise<void>

recoverBIP39()

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

Defined in: plugins/stronghold/guest-js/index.ts:175

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>

Inherited from

ProcedureExecutor.recoverBIP39

remove()

remove(location): Promise<void>;

Defined in: plugins/stronghold/guest-js/index.ts:374

Remove a record from the vault.

Parameters

Parameter	Type	Description
location	Location	The record location.

Returns

Promise<void>

signEd25519()

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

Defined in: plugins/stronghold/guest-js/index.ts:244

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>

A promise resolving to the signature hex string.

Since

2.0.0

Inherited from

ProcedureExecutor.signEd25519

Interfaces

AddressInfo

Defined in: plugins/stronghold/guest-js/index.ts:42

Properties

Property	Type	Defined in
peers	Map<string, PeerAddress>	plugins/stronghold/guest-js/index.ts:43
relays	string[]	plugins/stronghold/guest-js/index.ts:44

---

ClientAccess

Defined in: plugins/stronghold/guest-js/index.ts:47

Properties

Property	Type	Defined in
cloneVaultDefault?	boolean	plugins/stronghold/guest-js/index.ts:52
cloneVaultExceptions?	Map<VaultPath, boolean>	plugins/stronghold/guest-js/index.ts:53
readStore?	boolean	plugins/stronghold/guest-js/index.ts:54
useVaultDefault?	boolean	plugins/stronghold/guest-js/index.ts:48
useVaultExceptions?	Map<VaultPath, boolean>	plugins/stronghold/guest-js/index.ts:49
writeStore?	boolean	plugins/stronghold/guest-js/index.ts:55
writeVaultDefault?	boolean	plugins/stronghold/guest-js/index.ts:50
writeVaultExceptions?	Map<VaultPath, boolean>	plugins/stronghold/guest-js/index.ts:51

---

ConnectionLimits

Defined in: plugins/stronghold/guest-js/index.ts:28

Properties

Property	Type	Defined in
maxEstablishedIncoming?	number	plugins/stronghold/guest-js/index.ts:31
maxEstablishedOutgoing?	number	plugins/stronghold/guest-js/index.ts:32
maxEstablishedPerPeer?	number	plugins/stronghold/guest-js/index.ts:33
maxEstablishedTotal?	number	plugins/stronghold/guest-js/index.ts:34
maxPendingIncoming?	number	plugins/stronghold/guest-js/index.ts:29
maxPendingOutgoing?	number	plugins/stronghold/guest-js/index.ts:30

---

Duration

Defined in: plugins/stronghold/guest-js/index.ts:75

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)	plugins/stronghold/guest-js/index.ts:79
secs	number	The number of whole seconds contained by this Duration.	plugins/stronghold/guest-js/index.ts:77

---

NetworkConfig

Defined in: plugins/stronghold/guest-js/index.ts:63

Properties

Property	Type	Defined in
addresses?	AddressInfo	plugins/stronghold/guest-js/index.ts:69
connectionsLimit?	ConnectionLimits	plugins/stronghold/guest-js/index.ts:66
connectionTimeout?	Duration	plugins/stronghold/guest-js/index.ts:65
enableMdns?	boolean	plugins/stronghold/guest-js/index.ts:67
enableRelay?	boolean	plugins/stronghold/guest-js/index.ts:68
peerPermissions?	Map<string, Permissions>	plugins/stronghold/guest-js/index.ts:70
permissionsDefault?	Permissions	plugins/stronghold/guest-js/index.ts:71
requestTimeout?	Duration	plugins/stronghold/guest-js/index.ts:64

---

PeerAddress

Defined in: plugins/stronghold/guest-js/index.ts:37

Properties

Property	Type	Defined in
known	string[]	plugins/stronghold/guest-js/index.ts:38
use_relay_fallback	boolean	plugins/stronghold/guest-js/index.ts:39

---

Permissions

Defined in: plugins/stronghold/guest-js/index.ts:58

Properties

Property	Type	Defined in
default?	ClientAccess	plugins/stronghold/guest-js/index.ts:59
exceptions?	Map<VaultPath, ClientAccess>	plugins/stronghold/guest-js/index.ts:60

Type Aliases

ClientPath

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

Defined in: plugins/stronghold/guest-js/index.ts:7

---

RecordPath

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

Defined in: plugins/stronghold/guest-js/index.ts:17

---

StoreKey

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

Defined in: plugins/stronghold/guest-js/index.ts:22

---

VaultPath

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

Defined in: plugins/stronghold/guest-js/index.ts:12