@tauri-apps/plugin-stronghold

Clases

Client

Constructores

new Client()

new Client(path, name): Client

Parámetros

Parámetro	Tipo
`path`	`string`
`name`	`ClientPath`

Devuelve

Client

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L265

Propiedades

Propiedad	Tipo	Definido en
`name`	`ClientPath`	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L263
`path`	`string`	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L262

Métodos

getStore()

getStore(): Store

Devuelve

Store

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L280

getVault()

getVault(name): Vault

Obtén una bóveda por nombre.

Parámetros

Parámetro	Tipo	Descripción
`name`	`VaultPath`

Devuelve

Vault

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L276

Location

Constructores

new Location()

new Location(type, payload): Location

Parámetros

Parámetro	Tipo
`type`	`string`
`payload`	`Registro (Record)`<`string`, `unknown`>

Devuelve

Location

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L86

Propiedades

Propiedad	Tipo	Definido en
`payload`	`Registro (Record)`<`string`, `unknown`>	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L84
`type`	`string`	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L83

Métodos

counter()

static counter(vault, counter): Location

Parámetros

Parámetro	Tipo
`vault`	`VaultPath`
`counter`	`number`

Devuelve

Location

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L98

generic()

static generic(vault, record): Location

Parámetros

Parámetro	Tipo
`vault`	`VaultPath`
`record`	`RecordPath`

Devuelve

Location

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L91

Store

Constructores

new Store()

new Store(path, client): Store

Parámetros

Parámetro	Tipo
`path`	`string`
`client`	`ClientPath`

Devuelve

Store

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L289

Propiedades

Propiedad	Tipo	Definido en
`client`	`ClientPath`	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L287
`path`	`string`	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L286

Métodos

get()

get(key): Promise<null | Uint8Array>

Parámetros

Parámetro	Tipo
`key`	`StoreKey`

Devuelve

Promise<null | Uint8Array>

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L294

insert()

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

Parámetros

Parámetro	Tipo
`key`	`StoreKey`
`value`	`number`[]
`lifetime`?	`Duration`

Devuelve

Promise<void>

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L302

remove()

remove(key): Promise<null | Uint8Array>

Parámetros

Parámetro	Tipo
`key`	`StoreKey`

Devuelve

Promise<null | Uint8Array>

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L316

Stronghold

Una representación del acceso a un stronghold.

Propiedades

Propiedad	Tipo	Definido en
`path`	`string`	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L388

Métodos

createClient()

createClient(client): Promise<Client>

Parámetros

Parámetro	Tipo
`client`	`ClientPath`

Devuelve

Promise<Client>

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L428

loadClient()

loadClient(client): Promise<Client>

Parámetros

Parámetro	Tipo
`client`	`ClientPath`

Devuelve

Promise<Client>

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L421

save()

save(): Promise<void>

Persiste el estado del stronghold en la captura instantánea (snapshot).

Devuelve

Promise<void>

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L439

unload()

unload(): Promise<void>

Elimina esta instancia de la caché.

Devuelve

Promise<void>

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L415

load()

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

Carga la captura instantánea si existe (la contraseña debe coincidir), o inicia una nueva instancia de stronghold en caso contrario.

Parámetros

Parámetro	Tipo	Descripción
`path`	`string`	-
`password`	`string`

Devuelve

Promise<Stronghold>

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L405

Vault

Un almacenamiento de clave-valor que permite operaciones de creación, actualización y eliminación. No permite leer los datos, por lo que se debe usar uno de los procedimientos para manipular los datos almacenados, permitiendo el almacenamiento seguro de secretos.

Extiende

ProcedureExecutor

Constructores

new Vault()

new Vault(
   path,
   client,
   name): Vault

Parámetros

Parámetro	Tipo
`path`	`string`
`client`	`ClientPath`
`name`	`VaultPath`

Devuelve

Vault

Sobrescribe

ProcedureExecutor.constructor

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L340

Propiedades

Propiedad	Tipo	Descripción	Heredado de	Definido en
`client`	`ClientPath`	-	-	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L336
`name`	`VaultPath`	El nombre de la bóveda.	-	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L338
`path`	`string`	La ruta de la bóveda.	-	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L335
`procedureArgs`	`Registro (Record)`<`string`, `unknown`>	-	`ProcedureExecutor.procedureArgs`	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L107

Métodos

deriveSLIP10()

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

Deriva una clave privada SLIP10 usando una semilla o clave.

Parámetros

Parámetro	Tipo	Descripción
`chain`	`number`[]	La ruta de la cadena.
`source`	`"Seed"` \| `"Key"`	El tipo de origen, ya sea 'Seed' o 'Key'.
`sourceLocation`	`Location`	La ubicación de origen, debe ser la `outputLocation` de una llamada previa a `generateSLIP10Seed` o `deriveSLIP10`.
`outputLocation`	`Location`	Ubicación del registro donde se almacenará la clave privada.

Devuelve

Promise<Uint8Array>

Heredado de

ProcedureExecutor.deriveSLIP10

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L145

generateBIP39()

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

Genera una semilla BIP39.

Parámetros

Parámetro	Tipo	Descripción
`outputLocation`	`Location`	La ubicación del registro donde se almacenará la semilla BIP39.
`passphrase`?	`string`	La frase de contraseña mnemónica opcional.

Devuelve

Promise<Uint8Array>

Heredado de

ProcedureExecutor.generateBIP39

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L200

generateSLIP10Seed()

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

Genera una semilla SLIP10 para la ubicación dada.

Parámetros

Parámetro	Tipo	Descripción
`outputLocation`	`Location`	Ubicación del registro donde se almacenará la semilla.
`sizeBytes`?	`number`	El tamaño en bytes de la semilla SLIP10.

Devuelve

Promise<Uint8Array>

Heredado de

ProcedureExecutor.generateSLIP10Seed

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L120

getEd25519PublicKey()

getEd25519PublicKey(privateKeyLocation): Promise<Uint8Array>

Obtiene la clave pública Ed25519 de una clave privada SLIP10.

Parámetros

Parámetro	Tipo	Descripción
`privateKeyLocation`	`Location`	La ubicación de la clave privada. Debe ser la `outputLocation` de una llamada previa a `deriveSLIP10`.

Devuelve

Promise<Uint8Array>

Una promesa que se resuelve con la cadena hexadecimal de la clave pública.

Desde

2.0.0

Heredado de

ProcedureExecutor.getEd25519PublicKey

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L223

insert()

insert(recordPath, secret): Promise<void>

Inserta un registro en esta bóveda.

Parámetros

Parámetro	Tipo
`recordPath`	`RecordPath`
`secret`	`number`[]

Devuelve

Promise<void>

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L358

recoverBIP39()

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

Almacena un mnemónico BIP39.

Parámetros

Parámetro	Tipo	Descripción
`mnemonic`	`string`	La cadena del mnemónico.
`outputLocation`	`Location`	La ubicación del registro donde se almacenará el mnemónico BIP39.
`passphrase`?	`string`	La frase de contraseña mnemónica opcional.

Devuelve

Promise<Uint8Array>

Heredado de

ProcedureExecutor.recoverBIP39

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L175

remove()

remove(location): Promise<void>

Elimina un registro de la bóveda.

Parámetros

Parámetro	Tipo	Descripción
`location`	`Location`	La ubicación del registro.

Devuelve

Promise<void>

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L374

signEd25519()

signEd25519(privateKeyLocation, msg): Promise<Uint8Array>

Crea una firma Ed25519 a partir de una clave privada.

Parámetros

Parámetro	Tipo	Descripción
`privateKeyLocation`	`Location`	La ubicación del registro donde está almacenada la clave privada. Debe ser la `outputLocation` de una llamada previa a `deriveSLIP10`.
`msg`	`string`	El mensaje a firmar.

Devuelve

Promise<Uint8Array>

Una promesa que se resuelve con la cadena hexadecimal de la firma.

Desde

2.0.0

Heredado de

ProcedureExecutor.signEd25519

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L244

Interfaces

AddressInfo

Propiedades

Propiedad	Tipo	Definido en
`peers`	`Map`<`string`, `PeerAddress`>	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L43
`relays`	`string`[]	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L44

ClientAccess

Propiedades

Propiedad	Tipo	Definido en
`cloneVaultDefault?`	`boolean`	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L52
`cloneVaultExceptions?`	`Map`<`VaultPath`, `boolean`>	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L53
`readStore?`	`boolean`	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L54
`useVaultDefault?`	`boolean`	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L48
`useVaultExceptions?`	`Map`<`VaultPath`, `boolean`>	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L49
`writeStore?`	`boolean`	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L55
`writeVaultDefault?`	`boolean`	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L50
`writeVaultExceptions?`	`Map`<`VaultPath`, `boolean`>	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L51

ConnectionLimits

Propiedades

Propiedad	Tipo	Definido en
`maxEstablishedIncoming?`	`number`	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L31
`maxEstablishedOutgoing?`	`number`	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L32
`maxEstablishedPerPeer?`	`number`	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L33
`maxEstablishedTotal?`	`number`	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L34
`maxPendingIncoming?`	`number`	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L29
`maxPendingOutgoing?`	`number`	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L30

Duration

Una definición de duración.

Propiedades

Propiedad	Tipo	Descripción	Definido en
`nanos`	`number`	La parte fraccionaria de esta Duration, en nanosegundos. Debe ser mayor o igual a 0 y menor que 1e+9 (el número máximo de nanosegundos en un segundo)	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L79
`secs`	`number`	El número de segundos enteros contenidos en esta Duration.	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L77

NetworkConfig

Propiedades

Propiedad	Tipo	Definido en
`addresses?`	`AddressInfo`	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L69
`connectionTimeout?`	`Duration`	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L65
`connectionsLimit?`	`ConnectionLimits`	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L66
`enableMdns?`	`boolean`	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L67
`enableRelay?`	`boolean`	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L68
`peerPermissions?`	`Map`<`string`, `Permisos`>	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L70
`permissionsDefault?`	`Permisos`	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L71
`requestTimeout?`	`Duration`	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L64

PeerAddress

Propiedades

Propiedad	Tipo	Definido en
`known`	`string`[]	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L38
`use_relay_fallback`	`boolean`	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L39

Permisos

Propiedades

Propiedad	Tipo	Definido en
`default?`	`ClientAccess`	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L59
`exceptions?`	`Map`<`VaultPath`, `ClientAccess`>	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L60

Alias de tipos

ClientPath

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

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L7

RecordPath

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

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L17

StoreKey

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

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L22

VaultPath

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

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/stronghold/guest-js/index.ts#L12

Apoya en Open Collective Patrocina en GitHub