Class PKPSuiWallet

A base class that can be shared between Ethers and Cosmos signers.

Hierarchy

PKPBase
- PKPSuiWallet

Implements

Signer

Index

Constructors

constructor

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

Properties

defaultSigName

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

`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:76

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:203

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:219

getAddress

getAddress(): Promise<any>
Base method to be overridden by subclasses.

Returns
- Address associated with concrete type of PKPBase
Returns Promise<any>
Implementation of Signer.getAddress

Inherited from PKPBase.getAddress
- Defined in packages/pkp-sui/src/lib/pkp-sui.ts:51

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:247

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:185

`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:111

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:88

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:158

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:55

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:100

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:131

Class PKPSuiWallet

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

prop: PKPBaseProp

provider: JsonRpcProvider

Returns PKPSuiWallet

Properties

defaultSigName

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

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>

Protected prepareTransactionBlock

Parameters

transactionBlock: Uint8Array | TransactionBlock

Returns Promise<any>

requestSuiFromFaucet

Parameters

Optional httpHeaders: HttpHeaders

Returns Promise<any>

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>

signMessage

Parameters

input: { message: Uint8Array; }

message: Uint8Array

Returns Promise<SignedMessage>

signTransactionBlock

Parameters

input: { transactionBlock: Uint8Array | TransactionBlock; }

transactionBlock: Uint8Array | TransactionBlock

Returns Promise<SignedTransaction>

Settings

Member Visibility

Theme

`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;
}