@quilibrium/quilibrium-js-sdk-channels 2.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Quilibrium Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/channel/channel.d.ts

@@ -0,0 +1,332 @@
+import * as ch from './channelwasm';
+export type NewDoubleRatchetParameters = {
+    session_key: number[];
+    sending_header_key: number[];
+    next_receiving_header_key: number[];
+    is_sender: boolean;
+    sending_ephemeral_private_key: number[];
+    receiving_ephemeral_key?: number[];
+};
+export type NewTripleRatchetParameters = {
+    peers: number[][];
+    peer_key: number[];
+    identity_key: number[];
+    signed_pre_key: number[];
+    threshold: number;
+    async_dkg_ratchet: boolean;
+};
+export type EncryptionKeyPair = {
+    public_key: number[];
+    private_key: number[];
+};
+export type SigningKeyPair = {
+    public_key: number[];
+    private_key: number[];
+};
+export type SenderX3DH = {
+    sending_identity_private_key: number[];
+    sending_ephemeral_private_key: number[];
+    receiving_identity_key: number[];
+    receiving_signed_pre_key: number[];
+    session_key_length: number;
+};
+export type ReceiverX3DH = {
+    sending_identity_private_key: number[];
+    sending_signed_private_key: number[];
+    receiving_identity_key: number[];
+    receiving_ephemeral_key: number[];
+    session_key_length: number;
+};
+export type DoubleRatchetStateAndEnvelope = {
+    ratchet_state: string;
+    envelope: string;
+};
+export type DoubleRatchetStateAndMessage = {
+    ratchet_state: string;
+    message: number[];
+};
+export type TripleRatchetStateAndMetadata = {
+    ratchet_state: string;
+    metadata: {
+        [key: string]: string;
+    };
+};
+export type TripleRatchetStateAndEnvelope = {
+    ratchet_state: string;
+    envelope: string;
+};
+export type TripleRatchetStateAndMessage = {
+    ratchet_state: string;
+    message: number[];
+};
+export type DoubleRatchetParticipant = {
+    sending_ephemeral_private_key: string;
+    receiving_ephemeral_key: string;
+    root_key: string;
+    sending_chain_key: string;
+    current_sending_header_key: string;
+    current_receiving_header_key: string;
+    next_sending_header_key: string;
+    next_receiving_header_key: string;
+    receiving_chain_key: string;
+    current_sending_chain_length: number;
+    previous_sending_chain_length: number;
+    current_receiving_chain_length: number;
+    previous_receiving_chain_length: number;
+    skipped_keys_map: {
+        [key: string]: {
+            [key: number]: string;
+        };
+    };
+};
+export type MessageCiphertext = {
+    ciphertext: string;
+    initialization_vector: string;
+    associated_data?: string;
+};
+export type SealedInboxMessageDecryptRequest = {
+    inbox_private_key: number[];
+    ephemeral_public_key: number[];
+    ciphertext: MessageCiphertext;
+};
+export type SealedInboxMessageEncryptRequest = {
+    inbox_public_key: number[];
+    ephemeral_private_key: number[];
+    plaintext: number[];
+};
+export type Ed448Keypair = {
+    type: 'ed448';
+    public_key: number[];
+    private_key: number[];
+};
+export type X448Keypair = {
+    type: 'x448';
+    public_key: number[];
+    private_key: number[];
+};
+export type Keypair = X448Keypair | Ed448Keypair;
+export type UserKeyset = {
+    user_key: Ed448Keypair;
+    peer_key: X448Keypair;
+};
+export type DeviceKeyset = {
+    identity_key: X448Keypair;
+    pre_key: X448Keypair;
+    inbox_keyset: InboxKeyset;
+};
+export type InboxKeyset = {
+    inbox_address: string;
+    inbox_key: Ed448Keypair;
+    inbox_encryption_key: X448Keypair;
+};
+export type InboxRegistration = {
+    inbox_address: string;
+    inbox_encryption_public_key: string;
+};
+export type DeviceRegistration = {
+    identity_public_key: string;
+    pre_public_key: string;
+    inbox_registration: InboxRegistration;
+};
+export type UserRegistration = {
+    user_address: string;
+    user_public_key: string;
+    peer_public_key: string;
+    device_registrations: DeviceRegistration[];
+    signature: string;
+};
+export type SpaceRegistration = {
+    space_address: string;
+    space_public_key: string;
+    owner_public_keys: string[];
+    config_public_key: string;
+    timestamp: number;
+    space_signature: string;
+    owner_signatures: string[];
+};
+export type SpaceManifest = {
+    space_address: string;
+    space_manifest: string;
+    timestamp: number;
+    ephemeral_public_key: string;
+    owner_public_key: string;
+    owner_signature: string;
+};
+export type SealedMessageWithNetworkTimestamp = {
+    inbox_address: string;
+    ephemeral_public_key: string;
+    envelope: string;
+    inbox_public_key: string;
+    inbox_signature: string;
+    timestamp: number;
+};
+export type OwnerSealedMessage = {
+    inbox_address: string;
+    hub_address: string;
+    ephemeral_public_key: string;
+    envelope: string;
+    owner_public_key: string;
+    owner_signature: string;
+};
+export type HubSealedMessage = {
+    hub_address: string;
+    ephemeral_public_key: string;
+    envelope: string;
+    hub_public_key: string;
+    hub_signature: string;
+};
+export type HubControlMessage = {
+    hub_address: string;
+    inbox_public_key: string;
+    hub_public_key: string;
+    hub_signature: string;
+    inbox_signature: string;
+};
+export type UserConfig = {
+    user_address: string;
+    user_public_key: string;
+    user_config: string;
+    timestamp: number;
+    signature: string;
+};
+export type UserAttestation = {
+    user_address: string;
+    attestation: string;
+    attestation_valid_until: number;
+    attestation_public_key: string;
+    attestation_signature: string;
+};
+export type SealedMessage = {
+    inbox_address: string;
+    ephemeral_public_key: string;
+    envelope: string;
+    inbox_public_key?: string;
+    inbox_signature?: string;
+};
+export type DeleteMessages = {
+    inbox_address: string;
+    timestamps: number[];
+    inbox_public_key: string;
+    inbox_signature: string;
+};
+export type SealedMessageAndMetadata = {
+    sealed_message: SealedMessage;
+    ratchet_state: string;
+    receiving_inbox: InboxKeyset;
+    sending_inbox: SendingInbox;
+    tag: string;
+    sent_accept?: boolean;
+};
+export type SendingInbox = {
+    inbox_address: string;
+    inbox_encryption_key: string;
+    inbox_public_key: string;
+    inbox_private_key: string;
+};
+export type SignedInboxEnvelopeAndMetadata = {
+    inbox_address: string;
+    inbox_public_key: string;
+    inbox_signature: string;
+    envelope: string;
+    ratchet_state: string;
+};
+export type UserProfile = {
+    user_address: string;
+    display_name?: string;
+    user_icon?: string;
+};
+export type InitializationEnvelope = UserProfile & {
+    return_inbox_address: string;
+    return_inbox_encryption_key: string;
+    return_inbox_public_key: string;
+    return_inbox_private_key: string;
+    identity_public_key: string;
+    tag: string;
+    message: string;
+    type: string;
+};
+export type UnsealedEnvelope = InitializationEnvelope & {
+    ephemeral_public_key: string;
+};
+export type NewDoubleRatchetRecipientSession = {
+    state: string;
+    message: string;
+    tag: string;
+    return_inbox_address: string;
+    return_inbox_encryption_key: string;
+    return_inbox_public_key: string;
+    return_inbox_private_key: string;
+    user_address: string;
+    identity_public_key: string;
+};
+export type InboxAndEncryptionState = {
+    inbox_address: string;
+    encryption_state: string;
+};
+export declare const NewUserKeyset: (user_key: Ed448Keypair) => UserKeyset;
+export declare const NewDeviceKeyset: () => Promise<DeviceKeyset>;
+export declare const NewInboxKeyset: () => Promise<InboxKeyset>;
+export declare const ConstructUserRegistration: (userKeyset: UserKeyset, existing_device_keysets: DeviceRegistration[], device_keysets: DeviceKeyset[]) => Promise<UserRegistration>;
+export declare const NewDoubleRatchetSenderSession: (keyset: DeviceKeyset, sender_address: string, device: DeviceRegistration, initial_message: string, sender_name?: string, sender_photo?: string) => Promise<SealedMessageAndMetadata[]>;
+export declare const SealSyncEnvelope: (inbox_address: string, hub_address: string, hub_keyset: Ed448Keypair, owner_keyset: Ed448Keypair, message: string) => Promise<OwnerSealedMessage>;
+export declare const UnsealSyncEnvelope: (hub_keyset: Ed448Keypair, envelope: OwnerSealedMessage) => Promise<any>;
+export declare const UnsealInboxEnvelope: (privKey: number[], envelope: {
+    inbox_public_key: string;
+    ephemeral_public_key: string;
+    envelope: string;
+}) => Promise<any>;
+export declare const SealInboxEnvelope: (pubKey: string, message: string) => Promise<{
+    inbox_public_key: string;
+    ephemeral_public_key: string;
+    envelope: string;
+}>;
+export declare const SealHubEnvelope: (address: string, keyset: Ed448Keypair, message: string) => Promise<HubSealedMessage>;
+export declare const UnsealHubEnvelope: (keyset: Ed448Keypair, envelope: HubSealedMessage) => Promise<any>;
+export declare const UnsealInitializationEnvelope: (keyset: DeviceKeyset, initial_message: SealedMessage) => UnsealedEnvelope;
+export declare const NewDoubleRatchetRecipientSession: (keyset: DeviceKeyset, initial_message: UnsealedEnvelope) => Promise<NewDoubleRatchetRecipientSession>;
+export type DoubleRatchetStateAndInboxKeys = {
+    ratchet_state: string;
+    receiving_inbox: InboxKeyset;
+    sending_inbox: SendingInbox;
+    tag: string;
+    sent_accept?: boolean;
+};
+export declare const DoubleRatchetInboxEncryptForceSenderInit: (device_keyset: DeviceKeyset, encryption_states: DoubleRatchetStateAndInboxKeys[], message: string, acceptee: UserRegistration, sender_name?: string, sender_photo?: string) => SealedMessageAndMetadata[];
+export declare const DoubleRatchetInboxEncrypt: (device_keyset: DeviceKeyset, encryption_states: DoubleRatchetStateAndInboxKeys[], message: string, acceptee: UserRegistration, sender_name?: string, sender_photo?: string) => SealedMessageAndMetadata[];
+export declare const ConfirmDoubleRatchetSenderSession: (encryption_state: DoubleRatchetStateAndInboxKeys, message: SealedMessage) => {
+    receiving_inbox: InboxKeyset;
+    user_profile: UserProfile;
+    tag: string;
+    sending_inbox: SendingInbox;
+    ratchet_state: string;
+    message: string;
+};
+export declare const DoubleRatchetInboxDecrypt: (encryption_state: DoubleRatchetStateAndInboxKeys, message: SealedMessage) => {
+    ratchet_state: string;
+    message: string;
+} | {
+    receiving_inbox: InboxKeyset;
+    user_profile: UserProfile;
+    tag: any;
+    sending_inbox: SendingInbox;
+    ratchet_state: string;
+    message: string;
+};
+export type PeerMessageSet = {
+    [peer: string]: string;
+};
+export type TripleRatchetInitializationBundle = {
+    ratchet_state: string;
+    metadata: PeerMessageSet;
+};
+export declare const EstablishTripleRatchetSessionForSpace: (user_keyset: UserKeyset, device_keyset: DeviceKeyset, registration: UserRegistration, total?: number) => Promise<{
+    state: string;
+    template: any;
+    evals: number[][];
+}>;
+export declare const TripleRatchetInitRound1: typeof ch.js_triple_ratchet_init_round_1;
+export declare const TripleRatchetInitRound2: typeof ch.js_triple_ratchet_init_round_2;
+export declare const TripleRatchetInitRound3: typeof ch.js_triple_ratchet_init_round_3;
+export declare const TripleRatchetInitRound4: typeof ch.js_triple_ratchet_init_round_4;
+export declare const TripleRatchetEncrypt: typeof ch.js_triple_ratchet_encrypt;
+export declare const TripleRatchetDecrypt: typeof ch.js_triple_ratchet_decrypt;

package/dist/components/context/PasskeysContext.d.ts

@@ -0,0 +1,34 @@
+import { FC, ReactNode } from 'react';
+import { StoredPasskey } from '../../passkeys/types';
+type PasskeysContextValue = {
+    currentPasskeyInfo: {
+        credentialId: string;
+        address: string;
+        publicKey: string;
+        displayName?: string;
+        pfpUrl?: string;
+        completedOnboarding: boolean;
+    } | undefined;
+    showPasskeyPrompt: {
+        value: boolean;
+        importMode?: boolean;
+    };
+    setShowPasskeyPrompt: (state: {
+        value: boolean;
+        importMode?: boolean;
+    }) => void;
+    passkeyRegistrationComplete?: boolean;
+    setPasskeyRegistrationComplete: (value: boolean | undefined) => void;
+    passkeyRegistrationError?: string;
+    setPasskeyRegistrationError: (value: string | undefined) => void;
+    signWithPasskey: (credentialId: string, payload: string) => Promise<string>;
+    exportKey: (credentialId: string) => Promise<string>;
+    updateStoredPasskey: (credentialId: string, storedPasskey: StoredPasskey) => void;
+};
+type PasskeysContextProps = {
+    fqAppPrefix: string;
+    children: ReactNode;
+};
+declare const PasskeysProvider: FC<PasskeysContextProps>;
+declare const usePasskeysContext: () => PasskeysContextValue;
+export { PasskeysProvider, usePasskeysContext };

package/dist/components/modals/PasskeyModal.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import * as secureChannel from '../../channel/channel';
+export declare const PasskeyModal: ({ fqAppPrefix, getUserRegistration, uploadRegistration, }: {
+    fqAppPrefix: string;
+    getUserRegistration: (address: string) => Promise<secureChannel.UserRegistration>;
+    uploadRegistration: ({ address, registration, }: {
+        address: string;
+        registration: secureChannel.UserRegistration;
+    }) => Promise<void>;
+}) => React.JSX.Element;