@xmtp/node-bindings 0.0.41 → 1.0.0-rc1

package/README.md

@@ -1,7 +1,7 @@
 # Node bindings for the libXMTP rust library
 
-> [!CAUTION]
-> These bindings are currently in alpha and under heavy development. The API is subject to change and it is not yet recommended for production use.
+> [!INFO]
+> These bindings are not intended to be used directly, use the associated SDK instead.
 
 ## Useful commands
 

package/dist/index.d.ts

@@ -1,17 +1,18 @@
 /* auto-generated by NAPI-RS */
 /* eslint-disable */
 export declare class Client {
-  accountAddress: string
+  accountIdentifier: Identifier
   inboxId(): string
   isRegistered(): boolean
   installationId(): string
   installationIdBytes(): Uint8Array
-  canMessage(accountAddresses: Array<string>): Promise<Record<string, boolean>>
+  /** The resulting vec will be the same length as the input and should be zipped for the results. */
+  canMessage(accountIdentities: Array<Identifier>): Promise<Record<string, boolean>>
   registerIdentity(): Promise<void>
   conversations(): Conversations
   sendHistorySyncRequest(): Promise<void>
   sendConsentSyncRequest(): Promise<void>
-  findInboxIdByAddress(address: string): Promise<string | null>
+  findInboxIdByIdentifier(identifier: Identifier): Promise<string | null>
   addressesFromInboxId(refreshFromNetwork: boolean, inboxIds: Array<string>): Promise<Array<InboxState>>
   setConsentStates(records: Array<Consent>): Promise<void>
   getConsentState(entityType: ConsentEntityType, entity: string): Promise<ConsentState>
@@ -24,11 +25,12 @@ export declare class Client {
   inboxState(refreshFromNetwork: boolean): Promise<InboxState>
   getLatestInboxState(inboxId: string): Promise<InboxState>
   createInboxSignatureText(): Promise<string | null>
-  addWalletSignatureText(newWalletAddress: string): Promise<string>
-  revokeWalletSignatureText(walletAddress: string): Promise<string>
+  addIdentifierSignatureText(newIdentifier: Identifier): Promise<string>
+  revokeIdentifierSignatureText(identifier: Identifier): Promise<string>
   revokeAllOtherInstallationsSignatureText(): Promise<string>
   revokeInstallationsSignatureText(installationIds: Array<Uint8Array>): Promise<string>
-  addSignature(signatureType: SignatureRequestType, signatureBytes: Uint8Array): Promise<void>
+  addEcdsaSignature(signatureType: SignatureRequestType, signatureBytes: Uint8Array): Promise<void>
+  addPasskeySignature(signatureType: SignatureRequestType, signature: PasskeySignature): Promise<void>
   addScwSignature(signatureType: SignatureRequestType, signatureBytes: Uint8Array, chainId: bigint, blockNumber?: bigint | undefined | null): Promise<void>
   applySignatureRequests(): Promise<void>
   signWithInstallationKey(signatureText: string): Uint8Array
@@ -49,14 +51,14 @@ export declare class Conversation {
   superAdminList(): Array<string>
   isAdmin(inboxId: string): boolean
   isSuperAdmin(inboxId: string): boolean
-  addMembers(accountAddresses: Array<string>): Promise<void>
+  addMembers(accountIdentities: Array<Identifier>): Promise<void>
   addAdmin(inboxId: string): Promise<void>
   removeAdmin(inboxId: string): Promise<void>
   addSuperAdmin(inboxId: string): Promise<void>
   removeSuperAdmin(inboxId: string): Promise<void>
   groupPermissions(): GroupPermissions
   addMembersByInboxId(inboxIds: Array<string>): Promise<void>
-  removeMembers(accountAddresses: Array<string>): Promise<void>
+  removeMembers(accountIdentities: Array<Identifier>): Promise<void>
   removeMembersByInboxId(inboxIds: Array<string>): Promise<void>
   updateGroupName(groupName: string): Promise<void>
   groupName(): string
@@ -67,6 +69,7 @@ export declare class Conversation {
   stream(callback: (err: null | Error, result: Message | undefined) => void): StreamCloser
   createdAtNs(): number
   isActive(): boolean
+  pausedForVersion(): string | null
   addedByInboxId(): string
   groupMetadata(): Promise<GroupMetadata>
   consentState(): ConsentState
@@ -86,9 +89,9 @@ export declare class ConversationListItem {
 }
 
 export declare class Conversations {
-  createGroup(accountAddresses: Array<string>, options?: CreateGroupOptions | undefined | null): Promise<Conversation>
+  createGroup(accountIdentities: Array<Identifier>, options?: CreateGroupOptions | undefined | null): Promise<Conversation>
   createGroupByInboxId(inboxIds: Array<string>, options?: CreateGroupOptions | undefined | null): Promise<Conversation>
-  createDm(accountAddress: string, options?: CreateDmOptions | undefined | null): Promise<Conversation>
+  createDm(accountIdentity: Identifier, options?: CreateDmOptions | undefined | null): Promise<Conversation>
   createDmByInboxId(inboxId: string, options?: CreateDmOptions | undefined | null): Promise<Conversation>
   findGroupById(groupId: string): Conversation
   findDmByTargetInboxId(targetInboxId: string): Conversation
@@ -112,7 +115,7 @@ export declare class Conversations {
 
 export declare class GroupMember {
   inboxId: string
-  accountAddresses: Array<string>
+  accountIdentifiers: Array<Identifier>
   installationIds: Array<string>
   permissionLevel: PermissionLevel
   consentState: ConsentState
@@ -153,8 +156,7 @@ export interface Consent {
 
 export declare const enum ConsentEntityType {
   GroupId = 0,
-  InboxId = 1,
-  Address = 2
+  InboxId = 1
 }
 
 export declare const enum ConsentState {
@@ -196,7 +198,7 @@ export declare const enum ConversationType {
  * It can be one of: `debug`, `info`, `warn`, `error` or 'off'.
  * By default, logging is disabled.
  */
-export declare export declare function createClient(host: string, isSecure: boolean, dbPath: string | undefined | null, inboxId: string, accountAddress: string, encryptionKey?: Uint8Array | undefined | null, historySyncUrl?: string | undefined | null, logOptions?: LogOptions | undefined | null): Promise<Client>
+export declare export declare function createClient(host: string, isSecure: boolean, dbPath: string | undefined | null, inboxId: string, accountIdentifier: Identifier, encryptionKey?: Uint8Array | undefined | null, historySyncUrl?: string | undefined | null, logOptions?: LogOptions | undefined | null): Promise<Client>
 
 export interface CreateDmOptions {
   messageDisappearingSettings?: MessageDisappearingSettings
@@ -233,9 +235,9 @@ export declare export declare function encodeMultiRemoteAttachment(multiRemoteAt
 
 export declare export declare function encodeReaction(reaction: Reaction): Uint8Array
 
-export declare export declare function generateInboxId(accountAddress: string): string
+export declare export declare function generateInboxId(accountIdent: Identifier): string
 
-export declare export declare function getInboxIdForAddress(host: string, isSecure: boolean, accountAddress: string): Promise<string | null>
+export declare export declare function getInboxIdForIdentifier(host: string, isSecure: boolean, identifier: Identifier): Promise<string | null>
 
 export declare const enum GroupMembershipState {
   Allowed = 0,
@@ -259,11 +261,22 @@ export interface HmacKey {
   epoch: bigint
 }
 
+export interface Identifier {
+  identifier: string
+  identifierKind: IdentifierKind
+  relyingParty?: string
+}
+
+export declare const enum IdentifierKind {
+  Ethereum = 0,
+  Passkey = 1
+}
+
 export interface InboxState {
   inboxId: string
-  recoveryAddress: string
+  recoveryIdentifier: Identifier
   installations: Array<Installation>
-  accountAddresses: Array<string>
+  identifiers: Array<Identifier>
 }
 
 export interface Installation {
@@ -343,6 +356,13 @@ export interface MultiRemoteAttachment {
   attachments: Array<RemoteAttachmentInfo>
 }
 
+export interface PasskeySignature {
+  publicKey: Array<number>
+  signature: Array<number>
+  authenticatorData: Array<number>
+  clientDataJson: Array<number>
+}
+
 export declare const enum PermissionLevel {
   Member = 0,
   Admin = 1,

package/dist/index.js

@@ -365,7 +365,7 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-const { Client, Conversation, ConversationListItem, Conversations, GroupMember, GroupMetadata, GroupPermissions, StreamCloser, ConsentEntityType, ConsentState, ContentType, ConversationType, createClient, decodeMultiRemoteAttachment, decodeReaction, DeliveryStatus, encodeMultiRemoteAttachment, encodeReaction, generateInboxId, getInboxIdForAddress, GroupMembershipState, GroupMessageKind, GroupPermissionsOptions, isAddressAuthorized, isInstallationAuthorized, LogLevel, MetadataField, PermissionLevel, PermissionPolicy, PermissionUpdateType, ReactionAction, ReactionSchema, SignatureRequestType, SortDirection, verifySignedWithPublicKey } = nativeBinding
+const { Client, Conversation, ConversationListItem, Conversations, GroupMember, GroupMetadata, GroupPermissions, StreamCloser, ConsentEntityType, ConsentState, ContentType, ConversationType, createClient, decodeMultiRemoteAttachment, decodeReaction, DeliveryStatus, encodeMultiRemoteAttachment, encodeReaction, generateInboxId, getInboxIdForIdentifier, GroupMembershipState, GroupMessageKind, GroupPermissionsOptions, IdentifierKind, isAddressAuthorized, isInstallationAuthorized, LogLevel, MetadataField, PermissionLevel, PermissionPolicy, PermissionUpdateType, ReactionAction, ReactionSchema, SignatureRequestType, SortDirection, verifySignedWithPublicKey } = nativeBinding
 export { Client }
 export { Conversation }
 export { ConversationListItem }
@@ -385,10 +385,11 @@ export { DeliveryStatus }
 export { encodeMultiRemoteAttachment }
 export { encodeReaction }
 export { generateInboxId }
-export { getInboxIdForAddress }
+export { getInboxIdForIdentifier }
 export { GroupMembershipState }
 export { GroupMessageKind }
 export { GroupPermissionsOptions }
+export { IdentifierKind }
 export { isAddressAuthorized }
 export { isInstallationAuthorized }
 export { LogLevel }

package/dist/version.json

@@ -1,5 +1,5 @@
 {
   "branch": "main",
-  "version": "6bd613d",
-  "date": "2025-03-06 14:52:58 +0000"
+  "version": "070b27a",
+  "date": "2025-03-11 15:23:17 +0000"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xmtp/node-bindings",
-  "version": "0.0.41",
+  "version": "1.0.0-rc1",
   "repository": {
     "type": "git",
     "url": "git+https://git@github.com/xmtp/libxmtp.git",
@@ -52,7 +52,7 @@
     "vite": "^6.2.0",
     "vite-tsconfig-paths": "^5.1.4",
     "vitest": "^3.0.4",
-    "zx": "^8.3.2"
+    "zx": "^8.4.0"
   },
   "packageManager": "yarn@4.6.0",
   "engines": {