tin-envelopes API

Source-derived exports, parameter and result types, public methods and source links.

This reference is generated from the checked-out TypeScript exports. Types and signatures describe the package contract; source presence does not establish deployment or service availability. Error expressions below are direct throws, not an exhaustive list of failures from dependencies.

Source module. See the reference index for package import boundaries and verification scope.

createTinMasterSeedEnvelope

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/tin-envelopes. Implementation, line 159.

createTinMasterSeedEnvelope(params: { provider: string; tin: string; ownerPublicKey: string; routeVersion: number; pruConfigurationHash: string; resourceCommitment: string; seedCiphertext: string; seedNonce: string; seedCiphertextCommitment: string; protectedKey: string; protectedKeyCommitment: string; accessControlHash: string; }): Promise<TinMasterSeedEnvelope>

createTinPublicRoutePayload

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/tin-envelopes. Implementation, line 264.

createTinPublicRoutePayload(params: { tin: string; routeVersion: number; routeNonce: string; pruConfigurationHash: string; prus: PruEndpoint[]; }): TinPublicRoutePayload

decodeTinMasterSeedEnvelope

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/tin-envelopes. Implementation, line 89.

decodeTinMasterSeedEnvelope(value: Uint8Array): TinMasterSeedEnvelope

Direct failure expressions:

new Error("TIN master-seed envelope version is unsupported")
new Error("TIN master-seed envelope is incomplete")

decodeTinPublicRouteEnvelope

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/tin-envelopes. Implementation, line 250.

decodeTinPublicRouteEnvelope(value: Uint8Array): TinPublicRouteEnvelope

Direct failure expressions:

new Error("TIN public-route envelope version or algorithm is unsupported")
new Error("TIN public-route envelope is incomplete")

encodeTinEnvelope

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/tin-envelopes. Implementation, line 85.

encodeTinEnvelope(value: TinMasterSeedEnvelope | TinPublicRouteEnvelope): Uint8Array<ArrayBuffer>

encryptTinPublicRoutePayload

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/tin-envelopes. Implementation, line 291.

encryptTinPublicRoutePayload(params: { payload: TinPublicRoutePayload; nodeRoutingPublicKeyBase64: string; }): TinPublicRouteEnvelope

Direct failure expressions:

new Error("Node routing public key must be exactly 32 bytes")

serializeTinMasterSeedWalletAuthorization

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/tin-envelopes. Implementation, line 137.

serializeTinMasterSeedWalletAuthorization(params: { tin: string; ownerPublicKey: string; routeVersion: number; pruConfigurationHash: string; resourceCommitment: string; deviceSessionBinding: string; }): Uint8Array<ArrayBufferLike>

TIN_MASTER_SEED_ACCESS_DOMAIN

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/tin-envelopes. Implementation, line 10.

"TSN_TIN_MASTER_SEED_ACCESS"

TIN_MASTER_SEED_ENVELOPE_VERSION

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/tin-envelopes. Implementation, line 7.

"tsn-tin-master-seed-envelope"

TIN_MASTER_SEED_LOCAL_ENCRYPTION_ALGORITHM

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/tin-envelopes. Implementation, line 8.

"aes-256-gcm-local-master-seed"

TIN_PUBLIC_ROUTE_ENCRYPTION_ALGORITHM

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/tin-envelopes. Implementation, line 12.

"x25519-xsalsa20-poly1305"

TIN_PUBLIC_ROUTE_ENVELOPE_VERSION

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/tin-envelopes. Implementation, line 11.

"tsn-tin-public-route-envelope"

TinMasterSeedEnvelope

The locally encrypted master seed plus an opaque threshold-protected data key. The SDK never serializes a device private key, wallet signature, master seed, or backend capability into this envelope.

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/tin-envelopes. Implementation, line 19.

export type TinMasterSeedEnvelope = {
  version: typeof TIN_MASTER_SEED_ENVELOPE_VERSION;
  provider: string;
  tin: string;
  routeVersion: number;
  pruConfigurationHash: string;
  resourceCommitment: string;
  seedEncryptionAlgorithm: typeof TIN_MASTER_SEED_LOCAL_ENCRYPTION_ALGORITHM;
  seedCiphertext: string;
  seedNonce: string;
  seedCiphertextCommitment: string;
  protectedKey: string;
  protectedKeyCommitment: string;
  accessControlHash: string;
  integrityCommitment: string;
};

TinPublicRouteEntry

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/tin-envelopes. Implementation, line 36.

export type TinPublicRouteEntry = {
  index: number;
  publicKey: string;
  publicKeyHex: string;
  state: "PLANNED" | "ACTIVE" | "USED" | "SWEPT";
};

TinPublicRouteEnvelope

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/tin-envelopes. Implementation, line 52.

export type TinPublicRouteEnvelope = {
  version: typeof TIN_PUBLIC_ROUTE_ENVELOPE_VERSION;
  algorithm: typeof TIN_PUBLIC_ROUTE_ENCRYPTION_ALGORITHM;
  ephemeralPublicKey: string;
  nonce: string;
  ciphertext: string;
};

TinPublicRoutePayload

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/tin-envelopes. Implementation, line 43.

export type TinPublicRoutePayload = {
  version: typeof TIN_PUBLIC_ROUTE_ENVELOPE_VERSION;
  tin: string;
  routeVersion: number;
  routeNonce: string;
  pruConfigurationHash: string;
  prus: TinPublicRouteEntry[];
};

validateTinMasterSeedEnvelope

Import from @trustlink/tsn-sdk or @trustlink/tsn-sdk/tin-envelopes. Implementation, line 215.

validateTinMasterSeedEnvelope(params: { envelope: TinMasterSeedEnvelope | Uint8Array; tin: string; ownerPublicKey: string; pruConfigurationHash: string; }): Promise<TinMasterSeedEnvelope>

Direct failure expressions:

new Error("TIN master-seed envelope identity does not match")
new Error("TIN master-seed envelope integrity check failed")