Skip to content

SkcVault

Creating Instances

new SkcVault( kmsOptions: VaultClientOptions, offset: string, evmProvider?: ethers.Provider )

Creates a new instance of SkcVault, enabling interaction with the Skuchain's vault signer service.

Properties

  • SkcVault.kmsOptionsVaultClientOptions
    Vault configurations and credential to interact with signer service.

  • SkcVault.offsetstring

    Offset used to sign a transaction/message

  • SkcVault.evmProviderethers.Provider

    EVM provider to interact with contract

Instance Methods

skcVault.storeMnemonic ( mnemonic: string )

Stores a mnemonic in the Vault.



skcVault.connect ( provider: Provider )

Connects the signer to a specified provider.



skcVault.getAddress ()

Retrieves the address associated with the vault.



skcVault.getNonce ( blockTag?: BlockTag )

Gets the transaction nonce for the vault address.



skcVault.populateCall ( tx?: TransactionRequest )

Populates transaction data without sending it.



skcVault.populateTransaction ( tx: TransactionRequest )

Populates a transaction object to be signed and sent.



skcVault.estimateGas ( tx: TransactionRequest )

Estimates the gas required for a transaction.



skcVault.call ( tx: TransactionRequest )

Calls a read-only transaction.



skcVault.resolveName ( name: string )

Resolves an ENS name to an Ethereum address.



skcVault.sendTransaction ( txData: TransactionRequest )

Sends a signed transaction.



skcVault.signTransaction ( txData: TransactionRequest )

Signs a transaction request.



skcVault.signMessage ( message: string | Uint8Array )

Signs an ECDSA message.



skcVault.signTypedData ( domain: TypedDataDomain, types: Record<string, Array<TypedDataField>>, value: Record<string, any> )

Helper method for signing typed data (EIP-712).



skcVault.TypedDataSigner ( domain: TypedDataDomain, types: Record<string, Array<TypedDataField>>, value: Record<string, any> )

Signs typed data (EIP-712).