Class PKPCosmosWallet

Similar to "DirectSecp256k1HdWallet", but uses PKP to sign

Hierarchy

PKPCosmosWallet

Implements

PKPWallet
OfflineDirectSigner
PKPClientHelpers

Index

Constructors

constructor

new PKPCosmosWallet(prop: PKPCosmosWalletProp): PKPCosmosWallet
Parameters
- prop: PKPCosmosWalletProp
Returns PKPCosmosWallet
- Defined in packages/pkp-cosmos/src/lib/pkp-cosmos.ts:70

Properties

addressPrefix

addressPrefix: string

defaultSigName

defaultSigName: string = 'pkp-cosmos-sign-tx'

`Private` `Readonly` pkpBase

pkpBase: PKPBase<PKPBaseDefaultParams>

rpc

rpc: string

Accessors

`Private` address

get address(): string
Returns the Bech32 address with the human-readable part (address prefix)

Returns string
- Defined in packages/pkp-cosmos/src/lib/pkp-cosmos.ts:95

litNodeClientReady

get litNodeClientReady(): boolean
Returns boolean
- Defined in packages/pkp-cosmos/src/lib/pkp-cosmos.ts:66

Methods

formSendTx

formSendTx(options: {
    amount: number;
    denom: string;
    fee: number;
    gasPrice: number;
}): {
    amount: Coin[];
    fee: StdFee;
}
Prepares transaction data by calculating the amount and fee. Returns the amount and fee in the format required by the SigningStargateClient.sign method.

Property
The amount of tokens to send.

Property
The denomination of the tokens to send.

Property
The gas price to use for the transaction.

Property
The fee to use for the transaction.

Returns
An object containing the amount and fee in the format required by the SigningStargateClient.sign method.
Parameters
- options: {
      amount: number;
      denom: string;
      fee: number;
      gasPrice: number;
  }
  
  Transaction configuration.
  - amount: number
  - denom: string
  - fee: number
  - gasPrice: number
Returns {
amount: Coin[];
fee: StdFee;
}
- amount: Coin[]
- fee: StdFee
- Defined in packages/pkp-cosmos/src/lib/pkp-cosmos.ts:231

getAccounts

getAccounts(): Promise<readonly AccountData[]>
Returns account data, including the algorithm used, the address, and the compressed public key

Returns Promise<readonly AccountData[]>
Implementation of OfflineDirectSigner.getAccounts
- Defined in packages/pkp-cosmos/src/lib/pkp-cosmos.ts:123

getAddress

getAddress(): Promise<string>
Return address

Returns
- Cosmos address
Returns Promise<string>
Implementation of PKPWallet.getAddress
- Defined in packages/pkp-cosmos/src/lib/pkp-cosmos.ts:109

getClient

getClient(): Promise<SigningStargateClient>
getClient is an asynchronous function that creates and returns a SigningStargateClient instance. The SigningStargateClient is connected to the provided rpcEndpoint, and the wallet instance itself acts as the signer.

Returns
A promise that resolves to a SigningStargateClient instance connected to the rpcEndpoint with the wallet as the signer.

Returns Promise<SigningStargateClient>
- Defined in packages/pkp-cosmos/src/lib/pkp-cosmos.ts:210

getRpc

getRpc(): any
Returns any
Implementation of PKPClientHelpers.getRpc
- Defined in packages/pkp-cosmos/src/lib/pkp-cosmos.ts:80

handleRequest

handleRequest(): Promise<void>
Returns Promise<void>
Implementation of PKPClientHelpers.handleRequest
- Defined in packages/pkp-cosmos/src/lib/pkp-cosmos.ts:88

init

init(): Promise<void>
Initializes the PKPCosmosWallet instance and its dependencies

Returns Promise<void>
Implementation of PKPWallet.init
- Defined in packages/pkp-cosmos/src/lib/pkp-cosmos.ts:116

runLitAction

runLitAction(toSign: Uint8Array, sigName: string): Promise<any>
Runs the specified Lit action with the given parameters.

Returns
- A Promise that resolves with the signature returned by the Lit action.
Throws
- Throws an error if pkpPubKey is not provided, if controllerAuthSig or controllerSessionSigs is not provided, if controllerSessionSigs is not an object, if executeJsArgs does not have either code or ipfsId, or if an error occurs during the execution of the Lit action.
Parameters
- toSign: Uint8Array
  
  The data to be signed by the Lit action.
- sigName: string
  
  The name of the signature to be returned by the Lit action.
Returns Promise<any>
Implementation of PKPWallet.runLitAction
- Defined in packages/pkp-cosmos/src/lib/pkp-cosmos.ts:309

runSign

runSign(toSign: Uint8Array): Promise<SigResponse>
Sign the provided data with the PKP private key.

Returns
- A Promise that resolves with the signature of the provided data.
Throws
- Throws an error if pkpPubKey is not provided, if controllerAuthSig or controllerSessionSigs is not provided, if controllerSessionSigs is not an object, or if an error occurs during the signing process.
Parameters
- toSign: Uint8Array
  
  The data to be signed.
Returns Promise<SigResponse>
Implementation of PKPWallet.runSign
- Defined in packages/pkp-cosmos/src/lib/pkp-cosmos.ts:322

setRpc

setRpc(rpc: string): Promise<void>
Parameters
- rpc: string
Returns Promise<void>
Implementation of PKPClientHelpers.setRpc
- Defined in packages/pkp-cosmos/src/lib/pkp-cosmos.ts:84

sign

sign(messages: readonly EncodeObject[], fee: StdFee, memo: string, explicitSignerData?: SignerData): Promise<{
    authInfoBytes: Uint8Array;
    bodyBytes: Uint8Array;
    signatures: readonly Uint8Array[];
}>
*** NOTE: This is a copy of the SigningStargateClient.sign method ***

Gets account number and sequence from the API, creates a sign doc, creates a single signature and assembles the signed transaction.

The sign mode (SIGN_MODE_DIRECT or SIGN_MODE_LEGACY_AMINO_JSON) is determined by this client's signer.

You can pass signer data (account number, sequence and chain ID) explicitly instead of querying them from the chain. This is needed when signing for a multisig account, but it also allows for offline signing (See the SigningStargateClient.offline constructor).

Returns
A promise that resolves to an object containing the signed transaction bytes and signature array
Parameters
- messages: readonly EncodeObject[]
  
  An array of messages to be signed, following the EncodeObject format
- fee: StdFee
  
  The transaction fee object, containing the gas limit and amount
- memo: string
  
  An optional memo string to be included in the transaction
- Optional explicitSignerData: SignerData
  
  Optional SignerData to be used during signing (e.g., account number, sequence, and chain ID)
Returns Promise<{
    authInfoBytes: Uint8Array;
    bodyBytes: Uint8Array;
    signatures: readonly Uint8Array[];
}>
- Defined in packages/pkp-cosmos/src/lib/pkp-cosmos.ts:278

signDirect

signDirect(address: string, signDoc: SignDoc): Promise<DirectSignResponse>
Signs the provided transaction using the LIT node client and returns the signed transaction and the encoded signature.

Returns
A promise that resolves to a DirectSignResponse containing the signed transaction and the encoded signature.
Parameters
- address: string
  
  The address of the signer.
- signDoc: SignDoc
  
  The transaction data to be signed.
Returns Promise<DirectSignResponse>
Implementation of OfflineDirectSigner.signDirect
- Defined in packages/pkp-cosmos/src/lib/pkp-cosmos.ts:142

Class PKPCosmosWallet

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

prop: PKPCosmosWalletProp

Returns PKPCosmosWallet

Properties

addressPrefix

defaultSigName

Private Readonly pkpBase

rpc

Accessors

Private address

Returns string

litNodeClientReady

Returns boolean

Methods

formSendTx

Property

Property

Property

Property

Returns

Parameters

options: { amount: number; denom: string; fee: number; gasPrice: number; }

amount: number

denom: string

fee: number

gasPrice: number

Returns { amount: Coin[]; fee: StdFee; }

amount: Coin[]

fee: StdFee

getAccounts

Returns Promise<readonly AccountData[]>

getAddress

Returns

Returns Promise<string>

getClient

Returns

Returns Promise<SigningStargateClient>

getRpc

Returns any

handleRequest

Returns Promise<void>

init

Returns Promise<void>

runLitAction

Returns

Throws

Parameters

toSign: Uint8Array

sigName: string

Returns Promise<any>

runSign

Returns

Throws

Parameters

toSign: Uint8Array

Returns Promise<SigResponse>

setRpc

Parameters

rpc: string

Returns Promise<void>

sign

Returns

Parameters

messages: readonly EncodeObject[]

fee: StdFee

memo: string

Optional explicitSignerData: SignerData

Returns Promise<{ authInfoBytes: Uint8Array; bodyBytes: Uint8Array; signatures: readonly Uint8Array[]; }>

signDirect

Returns

`Private` `Readonly` pkpBase

`Private` address

options: {
amount: number;
denom: string;
fee: number;
gasPrice: number;
}

Returns {
amount: Coin[];
fee: StdFee;
}

`Optional` explicitSignerData: SignerData

Returns Promise<{
authInfoBytes: Uint8Array;
bodyBytes: Uint8Array;
signatures: readonly Uint8Array[];
}>