Class PKPSuiWallet

Hierarchy

PKPSuiWallet

Implements

PKPWallet
Signer

Constructors

constructor

new PKPSuiWallet(prop: PKPBaseProp, provider: JsonRpcProvider): PKPSuiWallet
Parameters
- prop: PKPBaseProp
- provider: JsonRpcProvider
Returns PKPSuiWallet
- Defined in packages/pkp-sui/src/lib/pkp-sui.ts:48

Properties

defaultSigName

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

`Private` `Readonly` pkpBase

pkpBase: PKPBase<PKPBaseDefaultParams>

`Readonly` prop

prop: PKPBaseProp

`Readonly` provider

provider: JsonRpcProvider

`Readonly` publicKey

publicKey: Secp256k1PublicKey

Methods

connect

connect(provider: JsonRpcProvider): PKPSuiWallet
Parameters
- provider: JsonRpcProvider
Returns PKPSuiWallet
- Defined in packages/pkp-sui/src/lib/pkp-sui.ts:97

devInspectTransactionBlock

devInspectTransactionBlock(input: Omit<{
    epoch?: string;
    gasPrice?: number | bigint;
    sender: any;
    transactionBlock: string | Uint8Array | TransactionBlock;
}, "sender">): Promise<any>
Runs the transaction in dev-inspect mode. Which allows for nearly any transaction (or Move call) with any arguments. Detailed results are provided, including both the transaction effects and any return values.
Parameters
- input: Omit<{
      epoch?: string;
      gasPrice?: number | bigint;
      sender: any;
      transactionBlock: string | Uint8Array | TransactionBlock;
  }, "sender">
Returns Promise<any>
- Defined in packages/pkp-sui/src/lib/pkp-sui.ts:224

dryRunTransactionBlock

dryRunTransactionBlock(input: {
transactionBlock: string | Uint8Array | TransactionBlock;
}): Promise<any>
Dry run a transaction and return the result.
Parameters
- input: {
  transactionBlock: string | Uint8Array | TransactionBlock;
  }
  - transactionBlock: string | Uint8Array | TransactionBlock
Returns Promise<any>
- Defined in packages/pkp-sui/src/lib/pkp-sui.ts:240

getAddress

getAddress(): Promise<any>
Returns Promise<any>
Implementation of PKPWallet.getAddress
- Defined in packages/pkp-sui/src/lib/pkp-sui.ts:65

getGasCostEstimation

getGasCostEstimation(...args: [input: {
transactionBlock: string | Uint8Array | TransactionBlock;
}]): Promise<any>
Returns the estimated gas cost for the transaction

Returns
total gas cost estimation

Throws
whens fails to estimate the gas cost
Parameters
- Rest ...args: [input: {
  transactionBlock: string | Uint8Array | TransactionBlock;
  }]
Returns Promise<any>
- Defined in packages/pkp-sui/src/lib/pkp-sui.ts:268

getTransactionBlockDigest

getTransactionBlockDigest(tx: Uint8Array | TransactionBlock): Promise<string>
Derive transaction digest from

Returns
transaction digest
Parameters
- tx: Uint8Array | TransactionBlock
  
  BCS serialized transaction data or a Transaction object
Returns Promise<string>
- Defined in packages/pkp-sui/src/lib/pkp-sui.ts:206

init

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

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

`Protected` prepareTransactionBlock

prepareTransactionBlock(transactionBlock: Uint8Array | TransactionBlock): Promise<any>
Parameters
- transactionBlock: Uint8Array | TransactionBlock
Returns Promise<any>
- Defined in packages/pkp-sui/src/lib/pkp-sui.ts:132

requestSuiFromFaucet

requestSuiFromFaucet(httpHeaders?: HttpHeaders): Promise<any>
Request gas tokens from a faucet server and send to the signer address
Parameters
- Optional httpHeaders: HttpHeaders
  
  optional request headers
Returns Promise<any>
- Defined in packages/pkp-sui/src/lib/pkp-sui.ts:109

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-sui/src/lib/pkp-sui.ts:289

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-sui/src/lib/pkp-sui.ts:302

signAndExecuteTransactionBlock

signAndExecuteTransactionBlock(input: {
    options?: any;
    requestType?: ExecuteTransactionRequestType;
    transactionBlock: Uint8Array | TransactionBlock;
}): Promise<any>
Sign a transaction block and submit to the Fullnode for execution.
Parameters
- input: {
      options?: any;
      requestType?: ExecuteTransactionRequestType;
      transactionBlock: Uint8Array | TransactionBlock;
  }
  - Optional options?: any
    
    specify which fields to return (e.g., transaction, effects, events, etc). By default, only the transaction digest will be returned.
  - Optional requestType?: ExecuteTransactionRequestType
    
    WaitForEffectsCert or WaitForLocalExecution, see details in ExecuteTransactionRequestType. Defaults to WaitForLocalExecution if options.show_effects or options.show_events is true
  - transactionBlock: Uint8Array | TransactionBlock
Returns Promise<any>
- Defined in packages/pkp-sui/src/lib/pkp-sui.ts:179

signData

signData(data: Uint8Array): Promise<string>
Parameters
- data: Uint8Array
Returns Promise<string>
Implementation of Signer.signData
- Defined in packages/pkp-sui/src/lib/pkp-sui.ts:69

signMessage

signMessage(input: {
message: Uint8Array;
}): Promise<SignedMessage>
Sign a message using the keypair, with the PersonalMessage intent.
Parameters
- input: {
  message: Uint8Array;
  }
  - message: Uint8Array
Returns Promise<SignedMessage>
- Defined in packages/pkp-sui/src/lib/pkp-sui.ts:121

signTransactionBlock

signTransactionBlock(input: {
transactionBlock: Uint8Array | TransactionBlock;
}): Promise<SignedTransaction>
Sign a transaction.
Parameters
- input: {
  transactionBlock: Uint8Array | TransactionBlock;
  }
  - transactionBlock: Uint8Array | TransactionBlock
Returns Promise<SignedTransaction>
- Defined in packages/pkp-sui/src/lib/pkp-sui.ts:152

Class PKPSuiWallet

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

prop: PKPBaseProp

provider: JsonRpcProvider

Returns PKPSuiWallet

Properties

defaultSigName

Private Readonly pkpBase

Readonly prop

Readonly provider

Readonly publicKey

Methods

connect

Parameters

provider: JsonRpcProvider

Returns PKPSuiWallet

devInspectTransactionBlock

Parameters

input: Omit<{ epoch?: string; gasPrice?: number | bigint; sender: any; transactionBlock: string | Uint8Array | TransactionBlock; }, "sender">

Returns Promise<any>

dryRunTransactionBlock

Parameters

input: { transactionBlock: string | Uint8Array | TransactionBlock; }

transactionBlock: string | Uint8Array | TransactionBlock

Returns Promise<any>

getAddress

Returns Promise<any>

getGasCostEstimation

Returns

Throws

Parameters

Rest ...args: [input: { transactionBlock: string | Uint8Array | TransactionBlock; }]

Returns Promise<any>

getTransactionBlockDigest

Returns

Parameters

tx: Uint8Array | TransactionBlock

Returns Promise<string>

init

Returns Promise<void>

Protected prepareTransactionBlock

Parameters

transactionBlock: Uint8Array | TransactionBlock

Returns Promise<any>

requestSuiFromFaucet

Parameters

Optional httpHeaders: HttpHeaders

Returns Promise<any>

runLitAction

Returns

Throws

Parameters

toSign: Uint8Array

sigName: string

Returns Promise<any>

runSign

Returns

Throws

Parameters

toSign: Uint8Array

Returns Promise<SigResponse>

signAndExecuteTransactionBlock

Parameters

input: { options?: any; requestType?: ExecuteTransactionRequestType; transactionBlock: Uint8Array | TransactionBlock; }

Optional options?: any

Optional requestType?: ExecuteTransactionRequestType

transactionBlock: Uint8Array | TransactionBlock

Returns Promise<any>

signData

Parameters

data: Uint8Array

Returns Promise<string>

`Private` `Readonly` pkpBase

`Readonly` prop

`Readonly` provider

`Readonly` publicKey

input: Omit<{
epoch?: string;
gasPrice?: number | bigint;
sender: any;
transactionBlock: string | Uint8Array | TransactionBlock;
}, "sender">

input: {
transactionBlock: string | Uint8Array | TransactionBlock;
}

`Rest` ...args: [input: {
transactionBlock: string | Uint8Array | TransactionBlock;
}]

`Protected` prepareTransactionBlock

`Optional` httpHeaders: HttpHeaders

input: {
options?: any;
requestType?: ExecuteTransactionRequestType;
transactionBlock: Uint8Array | TransactionBlock;
}

`Optional` options?: any

`Optional` requestType?: ExecuteTransactionRequestType

input: {
message: Uint8Array;
}

input: {
transactionBlock: Uint8Array | TransactionBlock;
}