Documentation / @cashconnect-js/core / types

CashConnectSessionProperties

type CashConnectSessionProperties<IsSessionPropertiesDecoded> = object;

Defined in: cashconnect-js/packages/core/src/types.ts:15

Type Parameters

Type Parameter	Default type
IsSessionPropertiesDecoded extends boolean	true

Properties

protocol

protocol: "CashConnect";

Defined in: cashconnect-js/packages/core/src/types.ts:18

version

version: string;

Defined in: cashconnect-js/packages/core/src/types.ts:19

template

template: IsSessionPropertiesDecoded extends true ? Template : string;

Defined in: cashconnect-js/packages/core/src/types.ts:20

allowedTokens

allowedTokens: IsSessionPropertiesDecoded extends true ? string[] : string;

Defined in: cashconnect-js/packages/core/src/types.ts:21

---

BchSessionProposal

type BchSessionProposal<IsSessionPropertiesDecoded> = WalletKitTypes.SessionProposal & object;

Defined in: cashconnect-js/packages/core/src/types.ts:34

Type Declaration

Name	Type	Defined in
params	Omit<WalletKitTypes.SessionProposal["params"], "sessionProperties"> & BchSession<IsSessionPropertiesDecoded>	cashconnect-js/packages/core/src/types.ts:37

Type Parameters

Type Parameter	Default type
IsSessionPropertiesDecoded extends boolean	true

---

RequestEvent

type RequestEvent = WalletKitTypes.BaseEventArgs<{
  request: {
     method: string;
     params: string;
  };
}>;

Defined in: cashconnect-js/packages/core/src/types.ts:45

---

Payloads

type Payloads = 
  | ExecuteActionPayload
  | GetBalancesPayload
  | GetTokensPayload
  | CancelRequestPayload;

Defined in: cashconnect-js/packages/core/src/types.ts:133

---

Methods

type Methods = Payloads["request"]["method"];

Defined in: cashconnect-js/packages/core/src/types.ts:138

---

BchSession

Defined in: cashconnect-js/packages/core/src/types.ts:26

Extends

• Omit<SessionTypes.Struct, "requiredNamespaces" | "sessionProperties">

Type Parameters

Type Parameter	Default type
IsSessionPropertiesDecoded extends boolean	true

Properties

Property	Type	Inherited from	Defined in
sessionProperties	CashConnectSessionProperties<IsSessionPropertiesDecoded>	-	cashconnect-js/packages/core/src/types.ts:31
topic	string	Omit.topic	cashconnect-js/node_modules/@walletconnect/types/dist/types/sign-client/session.d.ts:23
pairingTopic	string	Omit.pairingTopic	cashconnect-js/node_modules/@walletconnect/types/dist/types/sign-client/session.d.ts:24
relay	ProtocolOptions	Omit.relay	cashconnect-js/node_modules/@walletconnect/types/dist/types/sign-client/session.d.ts:25
expiry	number	Omit.expiry	cashconnect-js/node_modules/@walletconnect/types/dist/types/sign-client/session.d.ts:26
acknowledged	boolean	Omit.acknowledged	cashconnect-js/node_modules/@walletconnect/types/dist/types/sign-client/session.d.ts:27
controller	string	Omit.controller	cashconnect-js/node_modules/@walletconnect/types/dist/types/sign-client/session.d.ts:28
namespaces	Namespaces	Omit.namespaces	cashconnect-js/node_modules/@walletconnect/types/dist/types/sign-client/session.d.ts:29
optionalNamespaces	ProposalTypes.OptionalNamespaces	Omit.optionalNamespaces	cashconnect-js/node_modules/@walletconnect/types/dist/types/sign-client/session.d.ts:31
scopedProperties?	ScopedProperties	Omit.scopedProperties	cashconnect-js/node_modules/@walletconnect/types/dist/types/sign-client/session.d.ts:33
sessionConfig?	SessionConfig	Omit.sessionConfig	cashconnect-js/node_modules/@walletconnect/types/dist/types/sign-client/session.d.ts:34
self	object	Omit.self	cashconnect-js/node_modules/@walletconnect/types/dist/types/sign-client/session.d.ts:35
self.publicKey	string	-	cashconnect-js/node_modules/@walletconnect/types/dist/types/sign-client/session.d.ts:36
self.metadata	Metadata	-	cashconnect-js/node_modules/@walletconnect/types/dist/types/sign-client/session.d.ts:37
peer	object	Omit.peer	cashconnect-js/node_modules/@walletconnect/types/dist/types/sign-client/session.d.ts:39
peer.publicKey	string	-	cashconnect-js/node_modules/@walletconnect/types/dist/types/sign-client/session.d.ts:40
peer.metadata	Metadata	-	cashconnect-js/node_modules/@walletconnect/types/dist/types/sign-client/session.d.ts:41
authentication?	Cacao[]	Omit.authentication	cashconnect-js/node_modules/@walletconnect/types/dist/types/sign-client/session.d.ts:43
walletPayResult?	WalletPayResult[]	Omit.walletPayResult	cashconnect-js/node_modules/@walletconnect/types/dist/types/sign-client/session.d.ts:44
transportType?	TransportType	Omit.transportType	cashconnect-js/node_modules/@walletconnect/types/dist/types/sign-client/session.d.ts:45

---

WalletProperties

Defined in: cashconnect-js/packages/core/src/types.ts:41

Properties

Property	Type	Defined in
autoApprove	string[]	cashconnect-js/packages/core/src/types.ts:42

---

EventCallbacks

Defined in: cashconnect-js/packages/core/src/types.ts:57

Properties

Property	Type	Defined in
onSessionsUpdated	(sessions) => Promisable<void>	cashconnect-js/packages/core/src/types.ts:58
onSessionProposal	(proposalEvent) => Promisable<WalletProperties>	cashconnect-js/packages/core/src/types.ts:61
onSessionDelete	() => Promisable<void>	cashconnect-js/packages/core/src/types.ts:65
onRPCRequest	(session, request, response) => Promisable<void>	cashconnect-js/packages/core/src/types.ts:67
onError	(error) => Promisable<void>	cashconnect-js/packages/core/src/types.ts:73

---

RequestResponse

Defined in: cashconnect-js/packages/core/src/types.ts:80

Extended by

• GetBalancesPayload
• GetTokensPayload
• ExecuteActionPayload
• CancelRequestPayload

Properties

Property	Type	Defined in
request	object	cashconnect-js/packages/core/src/types.ts:81
request.method	string	cashconnect-js/packages/core/src/types.ts:82
request.params?	unknown	cashconnect-js/packages/core/src/types.ts:83
response	unknown	cashconnect-js/packages/core/src/types.ts:85

---

GetBalancesPayload

Defined in: cashconnect-js/packages/core/src/types.ts:88

Extends

• RequestResponse

Properties

Property	Type	Overrides	Defined in
request	object	RequestResponse.request	cashconnect-js/packages/core/src/types.ts:89
request.method	"getBalances"	-	cashconnect-js/packages/core/src/types.ts:90
response	SpendableUTXOsBalance	RequestResponse.response	cashconnect-js/packages/core/src/types.ts:92

---

GetTokensPayload

Defined in: cashconnect-js/packages/core/src/types.ts:95

Extends

• RequestResponse

Properties

Property	Type	Overrides	Defined in
request	object	RequestResponse.request	cashconnect-js/packages/core/src/types.ts:96
request.method	"getTokens"	-	cashconnect-js/packages/core/src/types.ts:97
response	Output[]	RequestResponse.response	cashconnect-js/packages/core/src/types.ts:99

---

ExecuteActionPayload

Defined in: cashconnect-js/packages/core/src/types.ts:102

Extends

• RequestResponse

Properties

Property	Type	Overrides	Defined in
request	object	RequestResponse.request	cashconnect-js/packages/core/src/types.ts:103
request.method	"executeAction"	-	cashconnect-js/packages/core/src/types.ts:104
request.params	object	-	cashconnect-js/packages/core/src/types.ts:105
request.params.action	string	-	cashconnect-js/packages/core/src/types.ts:106
request.params.params	object	-	cashconnect-js/packages/core/src/types.ts:107
response	object	RequestResponse.response	cashconnect-js/packages/core/src/types.ts:110
response.meta?	object	-	cashconnect-js/packages/core/src/types.ts:111
response.meta.title	TemplateSegment[]	-	cashconnect-js/packages/core/src/types.ts:112
response.meta.description	TemplateSegment[]	-	cashconnect-js/packages/core/src/types.ts:113
response.data	object	-	cashconnect-js/packages/core/src/types.ts:115
response.transactions	TransactionBch[]	-	cashconnect-js/packages/core/src/types.ts:116
response.balanceChanges	SpendableUTXOsBalance	-	cashconnect-js/packages/core/src/types.ts:117

---

CancelRequestPayload

Defined in: cashconnect-js/packages/core/src/types.ts:121

Extends

• RequestResponse

Properties

Property	Type	Overrides	Defined in
request	object	RequestResponse.request	cashconnect-js/packages/core/src/types.ts:122
request.method	"cancelRequest"	-	cashconnect-js/packages/core/src/types.ts:123
request.params	object	-	cashconnect-js/packages/core/src/types.ts:124
request.params.requestId	string	-	cashconnect-js/packages/core/src/types.ts:125
response	object	RequestResponse.response	cashconnect-js/packages/core/src/types.ts:128
response.received	boolean	-	cashconnect-js/packages/core/src/types.ts:129

---

SupportedChains

const SupportedChains: string[];

Defined in: cashconnect-js/packages/core/src/types.ts:13