@xmtp/node-bindings 0.0.16 → 0.0.18

package/README.md

@@ -1,17 +1,15 @@
-# Node bindings for the MLS client
+# Node bindings for the libXMTP rust library
 
-> **Important**  
-> These bindings are currently in **Alpha** status. Do not use in production as the API is not final and certain functionality may not work as intended.
+> [!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.
 
 ## Useful commands
 
 - `yarn`: Installs all dependencies (required before building)
-- `yarn build:release`: Build a release version of the Node bindings for the current platform
+- `yarn build`: Build a release version of the Node bindings for the current platform
+- `yarn lint`: Run cargo clippy and fmt checks
+- `yarn test`: Run the test suite on Node
 
 ## Testing
 
-There are several test scripts written in Node located in the `/scripts` folder.
-
-Test users are available as exports in `users.mjs`. To register all users on the network, run the `setup.mjs` script.
-
-Before running any of the test scripts, a local XMTP node must be running. This can be achieved by running `./dev/up` at the root of this repository.
+Before running the test suite, a local XMTP node must be running. This can be achieved by running `./dev/up` at the root of this repository. Docker is required.

package/dist/index.d.ts

@@ -1,64 +1,45 @@
 /* auto-generated by NAPI-RS */
 /* eslint-disable */
-export class NapiClient {
+export declare class Client {
   accountAddress: string
-  setConsentStates(records: Array<NapiConsent>): Promise<void>
-  getConsentState(entityType: NapiConsentEntityType, entity: string): Promise<NapiConsentState>
-  /**
-   * Get the client's inbox state.
-   *
-   * If `refresh_from_network` is true, the client will go to the network first to refresh the state.
-   * Otherwise, the state will be read from the local database.
-   */
-  inboxState(refreshFromNetwork: boolean): Promise<NapiInboxState>
-  getLatestInboxState(inboxId: string): Promise<NapiInboxState>
   inboxId(): string
   isRegistered(): boolean
   installationId(): string
   canMessage(accountAddresses: Array<string>): Promise<Record<string, boolean>>
   registerIdentity(): Promise<void>
-  conversations(): NapiConversations
-  requestHistorySync(): Promise<void>
+  conversations(): Conversations
+  sendHistorySyncRequest(): Promise<void>
+  sendConsentSyncRequest(): Promise<void>
   findInboxIdByAddress(address: string): Promise<string | null>
-  addressesFromInboxId(refreshFromNetwork: boolean, inboxIds: Array<string>): Promise<Array<NapiInboxState>>
+  addressesFromInboxId(refreshFromNetwork: boolean, inboxIds: Array<string>): Promise<Array<InboxState>>
+  setConsentStates(records: Array<Consent>): Promise<void>
+  getConsentState(entityType: ConsentEntityType, entity: string): Promise<ConsentState>
+  /**
+   * Get the client's inbox state.
+   *
+   * If `refresh_from_network` is true, the client will go to the network first to refresh the state.
+   * Otherwise, the state will be read from the local database.
+   */
+  inboxState(refreshFromNetwork: boolean): Promise<InboxState>
+  getLatestInboxState(inboxId: string): Promise<InboxState>
   createInboxSignatureText(): Promise<string | null>
   addWalletSignatureText(existingWalletAddress: string, newWalletAddress: string): Promise<string>
   revokeWalletSignatureText(walletAddress: string): Promise<string>
   revokeInstallationsSignatureText(): Promise<string>
-  addSignature(signatureType: NapiSignatureRequestType, signatureBytes: Uint8Array): Promise<void>
+  addSignature(signatureType: SignatureRequestType, signatureBytes: Uint8Array): Promise<void>
+  addScwSignature(signatureType: SignatureRequestType, signatureBytes: Uint8Array, chainId: bigint, blockNumber?: bigint | undefined | null): Promise<void>
   applySignatureRequests(): Promise<void>
 }
 
-export class NapiConversations {
-  createGroup(accountAddresses: Array<string>, options?: NapiCreateGroupOptions | undefined | null): Promise<NapiGroup>
-  createDm(accountAddress: string): Promise<NapiGroup>
-  findGroupById(groupId: string): NapiGroup
-  findDmByTargetInboxId(targetInboxId: string): NapiGroup
-  findMessageById(messageId: string): NapiMessage
-  processStreamedWelcomeMessage(envelopeBytes: Uint8Array): Promise<NapiGroup>
-  sync(): Promise<void>
-  list(opts?: NapiListConversationsOptions | undefined | null): Promise<Array<NapiGroup>>
-  listGroups(opts?: NapiListConversationsOptions | undefined | null): Promise<Array<NapiGroup>>
-  listDms(opts?: NapiListConversationsOptions | undefined | null): Promise<Array<NapiGroup>>
-  stream(callback: (err: null | Error, result: NapiGroup) => void): NapiStreamCloser
-  streamGroups(callback: (err: null | Error, result: NapiGroup) => void): NapiStreamCloser
-  streamDms(callback: (err: null | Error, result: NapiGroup) => void): NapiStreamCloser
-  streamAllMessages(callback: (err: null | Error, result: NapiMessage) => void): NapiStreamCloser
-  streamAllGroupMessages(callback: (err: null | Error, result: NapiMessage) => void): NapiStreamCloser
-  streamAllDmMessages(callback: (err: null | Error, result: NapiMessage) => void): NapiStreamCloser
-}
-
-export class NapiGroup {
+export declare class Conversation {
   id(): string
-  send(encodedContent: NapiEncodedContent): Promise<string>
-  /** send a message without immediately publishing to the delivery service. */
-  sendOptimistic(encodedContent: NapiEncodedContent): string
-  /** Publish all unpublished messages */
+  send(encodedContent: EncodedContent): Promise<string>
+  sendOptimistic(encodedContent: EncodedContent): string
   publishMessages(): Promise<void>
   sync(): Promise<void>
-  findMessages(opts?: NapiListMessagesOptions | undefined | null): Array<NapiMessage>
-  processStreamedGroupMessage(envelopeBytes: Uint8Array): Promise<NapiMessage>
-  listMembers(): Promise<Array<NapiGroupMember>>
+  findMessages(opts?: ListMessagesOptions | undefined | null): Array<Message>
+  processStreamedGroupMessage(envelopeBytes: Uint8Array): Promise<Message>
+  listMembers(): Promise<Array<GroupMember>>
   adminList(): Array<string>
   superAdminList(): Array<string>
   isAdmin(inboxId: string): boolean
@@ -68,7 +49,7 @@ export class NapiGroup {
   removeAdmin(inboxId: string): Promise<void>
   addSuperAdmin(inboxId: string): Promise<void>
   removeSuperAdmin(inboxId: string): Promise<void>
-  groupPermissions(): NapiGroupPermissions
+  groupPermissions(): GroupPermissions
   addMembersByInboxId(inboxIds: Array<string>): Promise<void>
   removeMembers(accountAddresses: Array<string>): Promise<void>
   removeMembersByInboxId(inboxIds: Array<string>): Promise<void>
@@ -80,45 +61,54 @@ export class NapiGroup {
   groupDescription(): string
   updateGroupPinnedFrameUrl(pinnedFrameUrl: string): Promise<void>
   groupPinnedFrameUrl(): string
-  stream(callback: (err: null | Error, result: NapiMessage) => void): NapiStreamCloser
+  stream(callback: (err: null | Error, result: Message | undefined) => void): StreamCloser
   createdAtNs(): number
   isActive(): boolean
   addedByInboxId(): string
-  groupMetadata(): NapiGroupMetadata
-  consentState(): NapiConsentState
-  updateConsentState(state: NapiConsentState): void
+  groupMetadata(): GroupMetadata
+  consentState(): ConsentState
+  updateConsentState(state: ConsentState): void
   dmPeerInboxId(): string
 }
 
-export class NapiGroupMember {
+export declare class Conversations {
+  createGroup(accountAddresses: Array<string>, options?: CreateGroupOptions | undefined | null): Promise<Conversation>
+  createDm(accountAddress: string): Promise<Conversation>
+  findGroupById(groupId: string): Conversation
+  findDmByTargetInboxId(targetInboxId: string): Conversation
+  findMessageById(messageId: string): Message
+  processStreamedWelcomeMessage(envelopeBytes: Uint8Array): Promise<Conversation>
+  sync(): Promise<void>
+  list(opts?: ListConversationsOptions | undefined | null): Promise<Array<Conversation>>
+  listGroups(opts?: ListConversationsOptions | undefined | null): Promise<Array<Conversation>>
+  listDms(opts?: ListConversationsOptions | undefined | null): Promise<Array<Conversation>>
+  stream(callback: (err: null | Error, result: Conversation | undefined) => void): StreamCloser
+  streamGroups(callback: (err: null | Error, result: Conversation | undefined) => void): StreamCloser
+  streamDms(callback: (err: null | Error, result: Conversation | undefined) => void): StreamCloser
+  streamAllMessages(callback: (err: null | Error, result: Message | undefined) => void): StreamCloser
+  streamAllGroupMessages(callback: (err: null | Error, result: Message | undefined) => void): StreamCloser
+  streamAllDmMessages(callback: (err: null | Error, result: Message | undefined) => void): StreamCloser
+}
+
+export declare class GroupMember {
   inboxId: string
   accountAddresses: Array<string>
   installationIds: Array<string>
-  permissionLevel: NapiPermissionLevel
-  consentState: NapiConsentState
+  permissionLevel: PermissionLevel
+  consentState: ConsentState
 }
 
-export class NapiGroupMetadata {
+export declare class GroupMetadata {
   creatorInboxId(): string
   conversationType(): string
 }
 
-export class NapiGroupPermissions {
-  policyType(): NapiGroupPermissionsOptions
-  policySet(): NapiPermissionPolicySet
-}
-
-export class NapiMessage {
-  id: string
-  sentAtNs: number
-  convoId: string
-  senderInboxId: string
-  content: NapiEncodedContent
-  kind: NapiGroupMessageKind
-  deliveryStatus: NapiDeliveryStatus
+export declare class GroupPermissions {
+  policyType(): GroupPermissionsOptions
+  policySet(): PermissionPolicySet
 }
 
-export class NapiStreamCloser {
+export declare class StreamCloser {
   /**
    * Signal the stream to end
    * Does not wait for the stream to end.
@@ -134,128 +124,154 @@ export class NapiStreamCloser {
   isClosed(): boolean
 }
 
-/**
- * Create an MLS client
- * Optionally specify a filter for the log level as a string.
- * It can be one of: `debug`, `info`, `warn`, `error` or 'off'.
- * By default, logging is set to `info`. `off` completely disables logging.
- */
-export declare function createClient(host: string, isSecure: boolean, dbPath: string, inboxId: string, accountAddress: string, encryptionKey?: Uint8Array | undefined | null, historySyncUrl?: string | undefined | null, envFilter?: string | undefined | null): Promise<NapiClient>
-
-export declare function generateInboxId(accountAddress: string): string
-
-export declare function getInboxIdForAddress(host: string, isSecure: boolean, accountAddress: string): Promise<string | null>
-
-export interface NapiConsent {
-  entityType: NapiConsentEntityType
-  state: NapiConsentState
+export interface Consent {
+  entityType: ConsentEntityType
+  state: ConsentState
   entity: string
 }
 
-export const enum NapiConsentEntityType {
+export declare const enum ConsentEntityType {
   GroupId = 0,
   InboxId = 1,
   Address = 2
 }
 
-export const enum NapiConsentState {
+export declare const enum ConsentState {
   Unknown = 0,
   Allowed = 1,
   Denied = 2
 }
 
-export interface NapiContentTypeId {
+export interface ContentTypeId {
   authorityId: string
   typeId: string
   versionMajor: number
   versionMinor: number
 }
 
-export const enum NapiConversationType {
+export declare const enum ConversationType {
   Dm = 0,
   Group = 1,
   Sync = 2
 }
 
-export interface NapiCreateGroupOptions {
-  permissions?: NapiGroupPermissionsOptions
+/**
+ * Create a client
+ *
+ * Optionally specify a filter for the log level as a string.
+ * 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, inboxId: string, accountAddress: string, encryptionKey?: Uint8Array | undefined | null, historySyncUrl?: string | undefined | null, logOptions?: LogOptions | undefined | null): Promise<Client>
+
+export interface CreateGroupOptions {
+  permissions?: GroupPermissionsOptions
   groupName?: string
   groupImageUrlSquare?: string
   groupDescription?: string
   groupPinnedFrameUrl?: string
 }
 
-export const enum NapiDeliveryStatus {
+export declare const enum DeliveryStatus {
   Unpublished = 0,
   Published = 1,
   Failed = 2
 }
 
-export const enum NapiDirection {
-  Ascending = 0,
-  Descending = 1
-}
-
-export interface NapiEncodedContent {
-  type?: NapiContentTypeId
+export interface EncodedContent {
+  type?: ContentTypeId
   parameters: Record<string, string>
   fallback?: string
   compression?: number
   content: Uint8Array
 }
 
-export const enum NapiGroupMembershipState {
+export declare export declare function generateInboxId(accountAddress: string): string
+
+export declare export declare function getInboxIdForAddress(host: string, isSecure: boolean, accountAddress: string): Promise<string | null>
+
+export declare const enum GroupMembershipState {
   Allowed = 0,
   Rejected = 1,
   Pending = 2
 }
 
-export const enum NapiGroupMessageKind {
+export declare const enum GroupMessageKind {
   Application = 0,
   MembershipChange = 1
 }
 
-export const enum NapiGroupPermissionsOptions {
+export declare const enum GroupPermissionsOptions {
   AllMembers = 0,
   AdminOnly = 1,
   CustomPolicy = 2
 }
 
-export interface NapiInboxState {
+export interface InboxState {
   inboxId: string
   recoveryAddress: string
-  installations: Array<NapiInstallation>
+  installations: Array<Installation>
   accountAddresses: Array<string>
 }
 
-export interface NapiInstallation {
+export interface Installation {
   id: string
   clientTimestampNs?: bigint
 }
 
-export interface NapiListConversationsOptions {
-  allowedStates?: Array<NapiGroupMembershipState>
+export declare const enum Level {
+  off = 'off',
+  error = 'error',
+  warn = 'warn',
+  info = 'info',
+  debug = 'debug',
+  trace = 'trace'
+}
+
+export interface ListConversationsOptions {
+  allowedStates?: Array<GroupMembershipState>
   createdAfterNs?: number
   createdBeforeNs?: number
   limit?: number
-  conversationType?: NapiConversationType
+  conversationType?: ConversationType
 }
 
-export interface NapiListMessagesOptions {
+export interface ListMessagesOptions {
   sentBeforeNs?: number
   sentAfterNs?: number
   limit?: number
-  deliveryStatus?: NapiDeliveryStatus
-  direction?: NapiDirection
+  deliveryStatus?: DeliveryStatus
+  direction?: SortDirection
+}
+
+/** Specify options for the logger */
+export interface LogOptions {
+  /**
+   * enable structured JSON logging to stdout.Useful for third-party log viewers
+   * an option so that it does not require being specified in js object.
+   */
+  structured?: boolean
+  /** Filter logs by level */
+  level?: Level
+}
+
+export interface Message {
+  id: string
+  sentAtNs: number
+  convoId: string
+  senderInboxId: string
+  content: EncodedContent
+  kind: GroupMessageKind
+  deliveryStatus: DeliveryStatus
 }
 
-export const enum NapiPermissionLevel {
+export declare const enum PermissionLevel {
   Member = 0,
   Admin = 1,
   SuperAdmin = 2
 }
 
-export const enum NapiPermissionPolicy {
+export declare const enum PermissionPolicy {
   Allow = 0,
   Deny = 1,
   Admin = 2,
@@ -264,18 +280,18 @@ export const enum NapiPermissionPolicy {
   Other = 5
 }
 
-export interface NapiPermissionPolicySet {
-  addMemberPolicy: NapiPermissionPolicy
-  removeMemberPolicy: NapiPermissionPolicy
-  addAdminPolicy: NapiPermissionPolicy
-  removeAdminPolicy: NapiPermissionPolicy
-  updateGroupNamePolicy: NapiPermissionPolicy
-  updateGroupDescriptionPolicy: NapiPermissionPolicy
-  updateGroupImageUrlSquarePolicy: NapiPermissionPolicy
-  updateGroupPinnedFrameUrlPolicy: NapiPermissionPolicy
+export interface PermissionPolicySet {
+  addMemberPolicy: PermissionPolicy
+  removeMemberPolicy: PermissionPolicy
+  addAdminPolicy: PermissionPolicy
+  removeAdminPolicy: PermissionPolicy
+  updateGroupNamePolicy: PermissionPolicy
+  updateGroupDescriptionPolicy: PermissionPolicy
+  updateGroupImageUrlSquarePolicy: PermissionPolicy
+  updateGroupPinnedFrameUrlPolicy: PermissionPolicy
 }
 
-export const enum NapiPermissionUpdateType {
+export declare const enum PermissionUpdateType {
   AddMember = 0,
   RemoveMember = 1,
   AddAdmin = 2,
@@ -283,10 +299,14 @@ export const enum NapiPermissionUpdateType {
   UpdateMetadata = 4
 }
 
-export const enum NapiSignatureRequestType {
+export declare const enum SignatureRequestType {
   AddWallet = 0,
   CreateInbox = 1,
   RevokeWallet = 2,
   RevokeInstallations = 3
 }
 
+export declare const enum SortDirection {
+  Ascending = 0,
+  Descending = 1
+}

package/dist/index.js

@@ -1,9 +1,13 @@
 // prettier-ignore
 /* eslint-disable */
+// @ts-nocheck
 /* auto-generated by NAPI-RS */
 
-const { readFileSync } = require('fs')
+import { createRequire } from 'node:module'
+const require = createRequire(import.meta.url)
+const __dirname = new URL('.', import.meta.url).pathname
 
+const { readFileSync } = require('node:fs')
 let nativeBinding = null
 const loadErrors = []
 
@@ -336,7 +340,7 @@ if (!nativeBinding || process.env.NAPI_RS_FORCE_WASI) {
     nativeBinding = require('./bindings_node.wasi.cjs')
   } catch (err) {
     if (process.env.NAPI_RS_FORCE_WASI) {
-      console.error(err)
+      loadErrors.push(err)
     }
   }
   if (!nativeBinding) {
@@ -344,7 +348,7 @@ if (!nativeBinding || process.env.NAPI_RS_FORCE_WASI) {
       nativeBinding = require('@xmtp/node-bindings-wasm32-wasi')
     } catch (err) {
       if (process.env.NAPI_RS_FORCE_WASI) {
-        console.error(err)
+        loadErrors.push(err)
       }
     }
   }
@@ -361,26 +365,27 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-module.exports.NapiClient = nativeBinding.NapiClient
-module.exports.NapiConversations = nativeBinding.NapiConversations
-module.exports.NapiGroup = nativeBinding.NapiGroup
-module.exports.NapiGroupMember = nativeBinding.NapiGroupMember
-module.exports.NapiGroupMetadata = nativeBinding.NapiGroupMetadata
-module.exports.NapiGroupPermissions = nativeBinding.NapiGroupPermissions
-module.exports.NapiMessage = nativeBinding.NapiMessage
-module.exports.NapiStreamCloser = nativeBinding.NapiStreamCloser
-module.exports.createClient = nativeBinding.createClient
-module.exports.generateInboxId = nativeBinding.generateInboxId
-module.exports.getInboxIdForAddress = nativeBinding.getInboxIdForAddress
-module.exports.NapiConsentEntityType = nativeBinding.NapiConsentEntityType
-module.exports.NapiConsentState = nativeBinding.NapiConsentState
-module.exports.NapiConversationType = nativeBinding.NapiConversationType
-module.exports.NapiDeliveryStatus = nativeBinding.NapiDeliveryStatus
-module.exports.NapiDirection = nativeBinding.NapiDirection
-module.exports.NapiGroupMembershipState = nativeBinding.NapiGroupMembershipState
-module.exports.NapiGroupMessageKind = nativeBinding.NapiGroupMessageKind
-module.exports.NapiGroupPermissionsOptions = nativeBinding.NapiGroupPermissionsOptions
-module.exports.NapiPermissionLevel = nativeBinding.NapiPermissionLevel
-module.exports.NapiPermissionPolicy = nativeBinding.NapiPermissionPolicy
-module.exports.NapiPermissionUpdateType = nativeBinding.NapiPermissionUpdateType
-module.exports.NapiSignatureRequestType = nativeBinding.NapiSignatureRequestType
+const { Client, Conversation, Conversations, GroupMember, GroupMetadata, GroupPermissions, StreamCloser, ConsentEntityType, ConsentState, ConversationType, createClient, DeliveryStatus, generateInboxId, getInboxIdForAddress, GroupMembershipState, GroupMessageKind, GroupPermissionsOptions, Level, PermissionLevel, PermissionPolicy, PermissionUpdateType, SignatureRequestType, SortDirection } = nativeBinding
+export { Client }
+export { Conversation }
+export { Conversations }
+export { GroupMember }
+export { GroupMetadata }
+export { GroupPermissions }
+export { StreamCloser }
+export { ConsentEntityType }
+export { ConsentState }
+export { ConversationType }
+export { createClient }
+export { DeliveryStatus }
+export { generateInboxId }
+export { getInboxIdForAddress }
+export { GroupMembershipState }
+export { GroupMessageKind }
+export { GroupPermissionsOptions }
+export { Level }
+export { PermissionLevel }
+export { PermissionPolicy }
+export { PermissionUpdateType }
+export { SignatureRequestType }
+export { SortDirection }

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@xmtp/node-bindings",
-  "version": "0.0.16",
+  "version": "0.0.18",
   "repository": {
     "type": "git",
     "url": "git+https://git@github.com/xmtp/libxmtp.git",
     "directory": "bindings_node"
   },
   "license": "MIT",
+  "type": "module",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -20,32 +21,35 @@
   ],
   "scripts": {
     "artifacts": "napi artifacts",
-    "build": "napi build --platform --release",
+    "build": "yarn build:clean && yarn build:release && yarn build:finish",
     "build:clean": "rm -rf dist",
-    "build:debug": "napi build --platform",
+    "build:debug": "napi build --platform --esm",
     "build:finish": "mkdir dist && mv index.js dist && mv index.d.ts dist && mv *.node dist",
-    "build:release": "yarn build:clean && yarn build && yarn build:finish",
+    "build:release": "napi build --platform --release --esm",
     "clean": "yarn build:clean && yarn test:clean",
     "format": "prettier -w .",
     "format:check": "prettier -c .",
+    "lint": "yarn lint:clippy && yarn lint:fmt",
+    "lint:clippy": "cargo clippy --all-features --all-targets --no-deps -- -Dwarnings",
+    "lint:fmt": "cargo fmt --check",
     "test": "vitest run",
     "test:clean": "rm -rf test/*.db3*"
   },
   "devDependencies": {
-    "@ianvs/prettier-plugin-sort-imports": "^4.2.1",
-    "@napi-rs/cli": "^3.0.0-alpha.55",
-    "@types/node": "^20.14.2",
-    "@types/uuid": "^10",
-    "prettier": "^3.3.2",
-    "prettier-plugin-packagejson": "^2.5.0",
-    "typescript": "^5.4.5",
-    "uuid": "^10.0.0",
-    "viem": "^2.11.1",
-    "vite": "^5.2.13",
-    "vite-tsconfig-paths": "^4.3.2",
-    "vitest": "^1.6.0"
+    "@ianvs/prettier-plugin-sort-imports": "^4.4.0",
+    "@napi-rs/cli": "^3.0.0-alpha.64",
+    "@types/node": "^20.17.6",
+    "@types/uuid": "^10.0.0",
+    "prettier": "^3.3.3",
+    "prettier-plugin-packagejson": "^2.5.3",
+    "typescript": "^5.6.3",
+    "uuid": "^11.0.3",
+    "viem": "^2.21.44",
+    "vite": "^5.4.11",
+    "vite-tsconfig-paths": "^5.1.2",
+    "vitest": "^2.1.4"
   },
-  "packageManager": "yarn@4.2.2",
+  "packageManager": "yarn@4.5.1",
   "engines": {
     "node": ">=18"
   },