Documentation / @cashconnect-js/wallet / wallet

ContextCallbacks

type ContextCallbacks = object;

Defined in: packages/wallet/src/wallet.ts:34

Properties

getSpendableUTXOs()

getSpendableUTXOs: () => Promisable<SpendableUTXO[]>;

Defined in: packages/wallet/src/wallet.ts:36

Returns

Promisable<SpendableUTXO[]>

getChangeTemplateDirective()

getChangeTemplateDirective: () => Promisable<ChangeTemplateDirective>;

Defined in: packages/wallet/src/wallet.ts:37

Returns

Promisable<ChangeTemplateDirective>

getSourceOutput()

getSourceOutput: (outpointTransactionHash, outpointIndex) => Promisable<Output>;

Defined in: packages/wallet/src/wallet.ts:38

Parameters

Parameter	Type
outpointTransactionHash	Uint8Array
outpointIndex	number

Returns

Promisable<Output>

---

CashConnectWallet

Defined in: packages/wallet/src/wallet.ts:44

Constructors

Constructor

new CashConnectWallet(
   entropy, 
   projectId, 
   metadata, 
   eventCallbacks, 
   contextCallbacks): CashConnectWallet;

Defined in: packages/wallet/src/wallet.ts:52

Parameters

Parameter	Type
entropy	Uint8Array
projectId	string
metadata	Metadata
eventCallbacks	EventCallbacks
contextCallbacks	ContextCallbacks

Returns

CashConnectWallet

Methods

decodeSession()

static decodeSession(session): BchSession<true>;

Defined in: packages/wallet/src/wallet.ts:568

Parameters

Parameter	Type
session	BchSession<true> | BchSession<false>

Returns

BchSession<true>

normalizeProposal()

static normalizeProposal(proposalEvent): BchSessionProposal<true>;

Defined in: packages/wallet/src/wallet.ts:593

Parameters

Parameter	Type
proposalEvent	BchSessionProposal<false>

Returns

BchSessionProposal<true>

start()

start(): Promise<void>;

Defined in: packages/wallet/src/wallet.ts:77

Returns

Promise<void>

pair()

pair(url): Promise<Struct>;

Defined in: packages/wallet/src/wallet.ts:102

Parameters

Parameter	Type
url	string

Returns

Promise<Struct>

getActiveSessions()

getActiveSessions(): Record<string, BchSession<true>>;

Defined in: packages/wallet/src/wallet.ts:115

Returns

Record<string, BchSession<true>>

disconnectSession()

disconnectSession(topic): Promise<void>;

Defined in: packages/wallet/src/wallet.ts:130

Parameters

Parameter	Type
topic	string

Returns

Promise<void>

disconnectAllSessions()

disconnectAllSessions(): Promise<void>;

Defined in: packages/wallet/src/wallet.ts:145

Returns

Promise<void>

walletStateHasChanged()

walletStateHasChanged(chainId): Promise<void>;

Defined in: packages/wallet/src/wallet.ts:156

Parameters

Parameter	Type	Default value
chainId	string	'bch:bitcoincash'

Returns

Promise<void>

onSessionProposal()

onSessionProposal(proposalEvent): Promise<void>;

Defined in: packages/wallet/src/wallet.ts:197

Parameters

Parameter	Type
proposalEvent	BchSessionProposal<true>

Returns

Promise<void>

onSessionDelete()

onSessionDelete(deleteEvent): Promise<void>;

Defined in: packages/wallet/src/wallet.ts:301

Parameters

Parameter	Type
deleteEvent	Omit<WalletKitTypes.BaseEventArgs, "params">

Returns

Promise<void>

onSessionRequest()

onSessionRequest(requestEvent): Promise<void>;

Defined in: packages/wallet/src/wallet.ts:316

Parameters

Parameter	Type
requestEvent	RequestEvent

Returns

Promise<void>

deriveSandboxKey()

deriveSandboxKey(domain): PrivateKey;

Defined in: packages/wallet/src/wallet.ts:418

Parameters

Parameter	Type
domain	string

Returns

PrivateKey

Properties

Property	Modifier	Type	Defined in
core	public	Core	packages/wallet/src/wallet.ts:46
web3Wallet	public	WalletKit	packages/wallet/src/wallet.ts:47
publicKey	readonly	PublicKey	packages/wallet/src/wallet.ts:50
entropy	readonly	Uint8Array	packages/wallet/src/wallet.ts:53
projectId	readonly	string	packages/wallet/src/wallet.ts:54
metadata	readonly	Metadata	packages/wallet/src/wallet.ts:55
eventCallbacks	readonly	EventCallbacks	packages/wallet/src/wallet.ts:56
contextCallbacks	readonly	ContextCallbacks	packages/wallet/src/wallet.ts:57