JoseSigner

@twine-protocol/twine-builder v0.1.0 • Docs

---

twine-js / @twine-protocol/twine-builder / JoseSigner

Class: JoseSigner

A signer that uses the jose library to sign twines

Example

import { JoseSigner } from '@twine-protocol/twine-builder'
const signer = await JoseSigner.fromRandomness()

Implements

• Signer

Constructors

new JoseSigner()

new JoseSigner(privateKey, publicKey, alg): JoseSigner

Create a new JoseSigner from a JWK

Parameters

Parameter	Type	Description
privateKey	KeyLike	The private key
publicKey	KeyLike	The public key
alg	string	The algorithm to use

Returns

JoseSigner

Defined in

jose-signer.ts:46

Properties

Property	Type	Description	Defined in
privateKey	KeyLike	Private Key	jose-signer.ts:19
publicKey	KeyLike	Public Key	jose-signer.ts:21
algorithm	string	Algorithm	jose-signer.ts:23

Methods

fromRandomness()

static fromRandomness(alg, options): Promise<JoseSigner>

Create a new JoseSigner from a random key pair

Parameters

Parameter	Type	Default value	Description
alg	string	'ES256'	The algorithm to use
options	GenerateKeyPairOptions	{}	Options for the key pair

Returns

Promise<JoseSigner>

See

https://github.com/panva/jose/blob/main/src/runtime/node/generate.ts#L42

Defined in

jose-signer.ts:34

---

getPublicJWK()

getPublicJWK(): Promise<JWK>

Get the public JWK

Returns

Promise<JWK>

See

Signer.getPublicJWK

Implementation of

Signer.getPublicJWK

Defined in

jose-signer.ts:62

---

sign()

sign(bytes): Promise<string>

Sign some bytes

Parameters

Parameter	Type
bytes	Uint8Array

Returns

Promise<string>

See

Signer.sign

Implementation of

Signer.sign

Defined in

jose-signer.ts:72