Class GcpKmsSigner

GCP KMS Signer integrates GCP Key Management Service (KMS) with the Sui blockchain to provide signing capabilities using GCP-managed cryptographic keys.

Hierarchy (View Summary)

Signer
- GcpKmsSigner

Index

Constructors

constructor

Methods

getKeyScheme getPublicKey sign signAndExecuteTransaction signData signPersonalMessage signTransaction signWithIntent toSuiAddress fromOptions fromVersionName

Constructors

constructor

new GcpKmsSigner(__namedParameters: GcpKmsSignerOptions): GcpKmsSigner
Creates an instance of GcpKmsSigner. It's expected to call the static fromOptions or fromVersionName method to create an instance. For example:
```
const signer = await GcpKmsSigner.fromVersionName(versionName);
```
Parameters
- __namedParameters: GcpKmsSignerOptions
Returns GcpKmsSigner
Throws
Will throw an error if required GCP credentials are not provided.
Overrides Signer.constructor
- Defined in signers/src/gcp/gcp-kms-client.ts:44

Methods

getKeyScheme

getKeyScheme(): | "Secp256k1"
| "Secp256r1"
| "ED25519"
| "MultiSig"
| "ZkLogin"
| "Passkey"
Retrieves the key scheme used by this signer.

Returns "Secp256k1" | "Secp256r1" | "ED25519" | "MultiSig" | "ZkLogin" | "Passkey"
GCP supports only Secp256k1 and Secp256r1 schemes.
Overrides Signer.getKeyScheme
- Defined in signers/src/gcp/gcp-kms-client.ts:57

getPublicKey

getPublicKey(): PublicKey
Retrieves the public key associated with this signer.

Returns PublicKey
The Secp256k1PublicKey instance.

Throws
Will throw an error if the public key has not been initialized.
Overrides Signer.getPublicKey
- Defined in signers/src/gcp/gcp-kms-client.ts:66

sign

sign(bytes: Uint8Array): Promise<Uint8Array<ArrayBufferLike>>
Signs the given data using GCP KMS.
Parameters
- bytes: Uint8Array
  The data to be signed as a Uint8Array.
Returns Promise<Uint8Array<ArrayBufferLike>>
A promise that resolves to the signature as a Uint8Array.

Throws
Will throw an error if the public key is not initialized or if signing fails.
Overrides Signer.sign
- Defined in signers/src/gcp/gcp-kms-client.ts:76

signAndExecuteTransaction

signAndExecuteTransaction(
__namedParameters: SignAndExecuteOptions,
): Promise<TransactionResponse>
Parameters
- __namedParameters: SignAndExecuteOptions
Returns Promise<TransactionResponse>
Inherited from Signer.signAndExecuteTransaction
- Defined in typescript/dist/cjs/cryptography/keypair.d.ts:44

signData

signData(): never
Synchronous signing is not supported by GCP KMS.

Returns never
Throws
Always throws an error indicating synchronous signing is unsupported.
- Defined in signers/src/gcp/gcp-kms-client.ts:93

signPersonalMessage

signPersonalMessage(
bytes: Uint8Array,
): Promise<{ bytes: string; signature: string }>
Signs provided personal message by calling signWithIntent() with a PersonalMessage provided as intent scope
Parameters
- bytes: Uint8Array
Returns Promise<{ bytes: string; signature: string }>
Inherited from Signer.signPersonalMessage
- Defined in typescript/dist/cjs/cryptography/keypair.d.ts:40

signTransaction

signTransaction(bytes: Uint8Array): Promise<SignatureWithBytes>
Signs provided transaction by calling signWithIntent() with a TransactionData provided as intent scope
Parameters
- bytes: Uint8Array
Returns Promise<SignatureWithBytes>
Inherited from Signer.signTransaction
- Defined in typescript/dist/cjs/cryptography/keypair.d.ts:36

signWithIntent

signWithIntent(
bytes: Uint8Array,
intent: IntentScope,
): Promise<SignatureWithBytes>
Sign messages with a specific intent. By combining the message bytes with the intent before hashing and signing, it ensures that a signed message is tied to a specific purpose and domain separator is provided
Parameters
- bytes: Uint8Array
- intent: IntentScope
Returns Promise<SignatureWithBytes>
Inherited from Signer.signWithIntent
- Defined in typescript/dist/cjs/cryptography/keypair.d.ts:32

toSuiAddress

toSuiAddress(): string
Returns string
Inherited from Signer.toSuiAddress
- Defined in typescript/dist/cjs/cryptography/keypair.d.ts:45

`Static`fromOptions

fromOptions(
    options: {
        cryptoKey: string;
        cryptoKeyVersion: string;
        keyRing: string;
        location: string;
        projectId: string;
    },
): Promise<GcpKmsSigner>
Creates a GCP KMS signer from the provided options. Expects the credentials file to be set as an env variable (GOOGLE_APPLICATION_CREDENTIALS).
Parameters
- options: {
      cryptoKey: string;
      cryptoKeyVersion: string;
      keyRing: string;
      location: string;
      projectId: string;
  }
Returns Promise<GcpKmsSigner>
- Defined in signers/src/gcp/gcp-kms-client.ts:102

`Static`fromVersionName

fromVersionName(versionName: string): Promise<GcpKmsSigner>
Parameters
- versionName: string
Returns Promise<GcpKmsSigner>
- Defined in signers/src/gcp/gcp-kms-client.ts:126

Class GcpKmsSigner

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns GcpKmsSigner

Throws

Methods

getKeyScheme

Returns "Secp256k1" | "Secp256r1" | "ED25519" | "MultiSig" | "ZkLogin" | "Passkey"

getPublicKey

Returns PublicKey

Throws

sign

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

Throws

signAndExecuteTransaction

Parameters

Returns Promise<TransactionResponse>

signData

Returns never

Throws

signPersonalMessage

Parameters

Returns Promise<{ bytes: string; signature: string }>

signTransaction

Parameters

Returns Promise<SignatureWithBytes>

signWithIntent

Parameters

Returns Promise<SignatureWithBytes>

toSuiAddress

Returns string

StaticfromOptions

Parameters

Returns Promise<GcpKmsSigner>

StaticfromVersionName

Parameters

Returns Promise<GcpKmsSigner>

Settings

On This Page

`Static`fromOptions

`Static`fromVersionName