Class StellarWalletsKit

Hierarchy

StellarWalletsKit

Index

Constructors

Properties

WCActiveSession? WCSignClient? network selectedWallet

Methods

closeSession connectWalletConnect getPublicKey getSessions getWalletConnectPublicKey onSessionDeleted setNetwork setSession setWallet sign signWalletConnectTransaction startWalletConnect getSupportedWallets

Constructors

constructor

new StellarWalletsKit(params: {
network: WalletNetwork;
selectedWallet: WalletType;
}): StellarWalletsKit
Parameters
- params: {
  network: WalletNetwork;
  selectedWallet: WalletType;
  }
  - network: WalletNetwork
  - selectedWallet: WalletType
Returns StellarWalletsKit
- Defined in lib/stellar-wallets-kit.ts:74

Properties

`Private` `Optional` WCActiveSession

WCActiveSession?: string

`Private` `Optional` WCSignClient

WCSignClient?: ISignClientExtended

`Private` network

network: WalletNetwork

`Private` selectedWallet

selectedWallet: WalletType

Methods

closeSession

closeSession(sessionId: string, reason?: string): Promise<void>
Parameters
- sessionId: string
- Optional reason: string
Returns Promise<void>
- Defined in lib/stellar-wallets-kit.ts:265

connectWalletConnect

connectWalletConnect(params?: IConnectWalletConnectParams): Promise<IParsedWalletConnectSession>
Parameters
- Optional params: IConnectWalletConnectParams
Returns Promise<IParsedWalletConnectSession>
- Defined in lib/stellar-wallets-kit.ts:241

getPublicKey

getPublicKey(): Promise<string>
Returns Promise<string>
- Defined in lib/stellar-wallets-kit.ts:121

getSessions

getSessions(): Promise<IParsedWalletConnectSession[]>
Returns Promise<IParsedWalletConnectSession[]>
- Defined in lib/stellar-wallets-kit.ts:279

`Private` getWalletConnectPublicKey

getWalletConnectPublicKey(): Promise<string>
Returns Promise<string>
- Defined in lib/stellar-wallets-kit.ts:287

onSessionDeleted

onSessionDeleted(cb: ((sessionId: string) => void)): void
Parameters
- cb: ((sessionId: string) => void)
  - - (sessionId: string): void
    - Parameters
      
      sessionId: string
      
      Returns void
Returns void
- Defined in lib/stellar-wallets-kit.ts:215

setNetwork

setNetwork(network: WalletNetwork): void
Parameters
- network: WalletNetwork
Returns void
- Defined in lib/stellar-wallets-kit.ts:105

setSession

setSession(sessionId: string): void
Allows manually setting the current active session to be used in the kit when doing WalletConnect requests
Parameters
- sessionId: string
  
  The session ID is a placeholder for the session "topic", term used in WalletConnect
Returns void
- Defined in lib/stellar-wallets-kit.ts:211

setWallet

setWallet(type: WalletType): void
Parameters
- type: WalletType
Returns void
- Defined in lib/stellar-wallets-kit.ts:113

sign

sign(params: IStellarWalletsKitSignParams): Promise<{
signedXDR: string;
}>
Parameters
- params: IStellarWalletsKitSignParams
Returns Promise<{
signedXDR: string;
}>
- Defined in lib/stellar-wallets-kit.ts:147

`Private` signWalletConnectTransaction

signWalletConnectTransaction(params: {
    chain?: WalletConnectTargetChain;
    method?: WalletConnectAllowedMethods;
    xdr: string;
}): Promise<{
    signedXDR: string;
}>
Parameters
- params: {
      chain?: WalletConnectTargetChain;
      method?: WalletConnectAllowedMethods;
      xdr: string;
  }
  - Optional chain?: WalletConnectTargetChain
  - Optional method?: WalletConnectAllowedMethods
  - xdr: string
Returns Promise<{
signedXDR: string;
}>
- Defined in lib/stellar-wallets-kit.ts:306

startWalletConnect

startWalletConnect(params: {
    description: string;
    icons: string[];
    name: string;
    projectId: string;
    url: string;
}): Promise<void>
Parameters
- params: {
      description: string;
      icons: string[];
      name: string;
      projectId: string;
      url: string;
  }
  - description: string
  - icons: string[]
  - name: string
  - projectId: string
  - url: string
Returns Promise<void>
- Defined in lib/stellar-wallets-kit.ts:225

`Static` getSupportedWallets

getSupportedWallets(): ISupportedWallet[]
This method will return an array with all wallets supported by this kit but will let you know those the user have already installed/has access to There are wallets that are by default available since they either don't need to be installed or have a fallback

Returns ISupportedWallet[]
- Defined in lib/stellar-wallets-kit.ts:83

Class StellarWalletsKit

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

params: { network: WalletNetwork; selectedWallet: WalletType; }

network: WalletNetwork

selectedWallet: WalletType

Returns StellarWalletsKit

Properties

Private Optional WCActiveSession

Private Optional WCSignClient

Private network

Private selectedWallet

Methods

closeSession

Parameters

sessionId: string

Optional reason: string

Returns Promise<void>

connectWalletConnect

Parameters

Optional params: IConnectWalletConnectParams

Returns Promise<IParsedWalletConnectSession>

getPublicKey

Returns Promise<string>

getSessions

Returns Promise<IParsedWalletConnectSession[]>

Private getWalletConnectPublicKey

Returns Promise<string>

onSessionDeleted

Parameters

cb: ((sessionId: string) => void)

Parameters

sessionId: string

Returns void

Returns void

setNetwork

Parameters

network: WalletNetwork

Returns void

setSession

Parameters

sessionId: string

Returns void

setWallet

Parameters

type: WalletType

Returns void

sign

Parameters

params: IStellarWalletsKitSignParams

Returns Promise<{ signedXDR: string; }>

Private signWalletConnectTransaction

Parameters

params: { chain?: WalletConnectTargetChain; method?: WalletConnectAllowedMethods; xdr: string; }

Optional chain?: WalletConnectTargetChain

Optional method?: WalletConnectAllowedMethods

xdr: string

Returns Promise<{ signedXDR: string; }>

startWalletConnect

Parameters

params: { description: string; icons: string[]; name: string; projectId: string; url: string; }

description: string

icons: string[]

name: string

projectId: string

url: string

Returns Promise<void>

Static getSupportedWallets

Returns ISupportedWallet[]

Settings

Theme

params: {
network: WalletNetwork;
selectedWallet: WalletType;
}

`Private` `Optional` WCActiveSession

`Private` `Optional` WCSignClient

`Private` network

`Private` selectedWallet

`Optional` reason: string

`Optional` params: IConnectWalletConnectParams

`Private` getWalletConnectPublicKey

Returns Promise<{
signedXDR: string;
}>

`Private` signWalletConnectTransaction

params: {
chain?: WalletConnectTargetChain;
method?: WalletConnectAllowedMethods;
xdr: string;
}

`Optional` chain?: WalletConnectTargetChain

`Optional` method?: WalletConnectAllowedMethods

Returns Promise<{
signedXDR: string;
}>

params: {
description: string;
icons: string[];
name: string;
projectId: string;
url: string;
}

`Static` getSupportedWallets