SDK capability map

@keymaster/connect exposes seven capability groups through one KeymasterConnectClient. This page is the complete operation index: select an SDK method to read its call contract, or select a Params/Result type to inspect every field.

Shared call model

Every named operation delegates to the same type-safe protocol transport:

const result = await keymaster.identityGet(params, options);

• params is specific to the operation.
• KeymasterRequestOptions optionally supplies a request id, timeout, or AbortSignal.
• The returned promise resolves to the operation's Result type.
• Except for connect.login and connect.launch, capability requests belong to an existing connectSessionId.

Connect

Create and manage the persistent session that binds the caller origin to a Keymaster owner identity.

Operation	Type contract	Purpose
connect.login login()	ConnectLoginParams → ConnectLoginResult	Create a session after the user selects an owner identity.
connect.resume resume()	ConnectResumeParams → ConnectResumeResult	Restore the unlock runtime for an existing session.
connect.logout logout()	ConnectLogoutParams → ConnectLogoutResult	Revoke a persistent session.
connect.launch launch()	ConnectLaunchParams → ConnectLaunchResult	Consume an appView launch token and establish its session.

Identity

Read signed claims or sign caller-provided content as an explicit, human-readable intent.

Operation	Type contract	Purpose
identity.get identityGet()	IdentityGetParams → IdentityGetResult	Return a signed identity envelope and requested claims.
intent.sign intentSign()	IntentSignParams → IntentSignResult	Sign application bytes inside a human-readable intent.

Identity requests include aud, iat, and exp. aud must equal the caller's exact browser origin.

Cipher

Encrypt data for the session owner and exact caller origin, then decrypt it in the same trust context.

Operation	Type contract	Purpose
cipher.encrypt cipherEncrypt()	CipherEncryptParams → CipherEncryptResult	Encrypt typed binary content.
cipher.decrypt cipherDecrypt()	CipherDecryptParams → CipherDecryptResult	Recover the content type and original bytes.

Use binary(), binaryText(), binaryBytes(), and binaryToText() with the protocol's explicit BinaryField representation.

Transfer

Request a controlled P2PKH transfer or negotiate a persistent fee-pool draft. Confirmation text and spending policy remain under Keymaster control.

Operation	Type contract	Purpose
p2pkh.transfer p2pkhTransfer()	P2pkhTransferParams → P2pkhTransferResult	Build, sign, and broadcast a controlled mainnet BSV transfer.
feepool.prepare feepoolPrepare()	FeepoolPrepareParams → FeepoolPrepareResult	Prepare the next fee-pool draft operation.
feepool.commit feepoolCommit()	FeepoolCommitParams → FeepoolCommitResult	Verify counterparty signatures and commit the prepared draft.

AppMsg

Send end-to-end sealed application messages and query the session-visible message history.

Operation	Type contract	Purpose
appmsg.send appmsgSend()	AppMsgSendParams → AppMsgSendResult	Send a sealed message to an owner and exact recipient endpoint.
appmsg.list appmsgList()	AppMsgListParams → AppMsgListResult	Incrementally list visible messages.
appmsg.get appmsgGet()	AppMsgGetParams → AppMsgGetResult	Fetch one visible message.

AppMsg event

Event	Payload	Delivery
appmsg.message_received	AppMsgMessageReceivedEventData	KeymasterConnectOptions.onEvent

The event contains the complete message and does not occupy a request slot or produce a Result message.

Broadcast

Publish owner-signed broadcasts and manage the exact channel set contributed by the current caller.

Operation	Type contract	Purpose
broadcast.publish broadcastPublish()	BroadcastPublishParams → BroadcastPublishResult	Publish a message signed by the session owner.
broadcast.subscription_set broadcastSubscriptionSet()	BroadcastSubscriptionSetParams → BroadcastSubscriptionSetResult	Replace the caller's exact channel set.
broadcast.subscription_list broadcastSubscriptionList()	BroadcastSubscriptionListParams → BroadcastSubscriptionListResult	Read the caller's channel set.

Broadcast event

Event	Payload	Delivery
broadcast.message_received	BroadcastMessageReceivedEventData	KeymasterConnectOptions.onEvent

The event contains the complete verified broadcast body. It does not require a follow-up request.

Storage

Manage directories and objects inside the verified application's namespace. Provider credentials, buckets, and physical object keys are never exposed to the caller.

Operation	Type contract	Purpose
storage.list storageList()	StorageListParams → StorageListResult	List app-scoped directories and objects.
storage.directory.create storageDirectoryCreate()	StorageDirectoryParams → StorageDirectoryResult	Create a directory marker.
storage.directory.delete storageDirectoryDelete()	StorageDirectoryParams → StorageDirectoryResult	Delete a directory marker.
storage.put storagePut()	StoragePutParams → StoragePutResult	Write an object within the direct payload limit.
storage.get storageGet()	StorageGetParams → StorageGetResult	Read a complete object or byte range.
storage.delete storageDelete()	StorageDeleteParams → StorageDeleteResult	Delete an object.
storage.upload.begin storageUploadBegin()	StorageUploadBeginParams → StorageUploadBeginResult	Start a multipart upload.
storage.upload.part storageUploadPart()	StorageUploadPartParams → StorageUploadPartResult	Upload one numbered part.
storage.upload.complete storageUploadComplete()	StorageUploadCompleteParams → StoragePutResult	Assemble uploaded parts into the final object.
storage.upload.abort storageUploadAbort()	StorageUploadAbortParams → StorageUploadAbortResult	Discard an unfinished multipart upload.

Storage requires a verified app identity whose requirements include storage. The size and part limits are exported as SDK constants in the API reference.

Lower-level request API

request(method, params) accepts every ProtocolMethod. Its generic MethodParams and MethodResult types provide the same compile-time inference as the named methods.

All server-pushed events use the shared ProtocolEventMessage envelope.