@farcaster/hub-web 0.2.2 → 0.2.4

package/README.md

@@ -4,7 +4,7 @@ A lightweight, fast Typescript interface for Farcaster Hubs. Designed to work wi
 
 ## Features
 
-- Call any Hub endpoint from browser environment (or node environemnt using grpc-web).
+- Call any Hub endpoint from a browser environment using gRPC-Web.
 - Serializes and deserializes Farcaster protobufs into Javascript objects.
 - Has helpers to create and sign Farcaster messages.
 - Written entirely in TypeScript, with strict types for safety.
@@ -19,24 +19,94 @@ yarn add @farcaster/hub-web
 pnpm install @farcaster/hub-web
 ```
 
-### Fetching Data from Hubs
+## Documentation
+
+The @farcaster/hub-web APIs are largely the same as @farcaster/hub-nodejs. Read the [@farcaster/hub-nodejs documentation](https://github.com/farcasterxyz/hubble/tree/main/packages/hub-nodejs/docs) and browse code [examples](https://github.com/farcasterxyz/hubble/tree/main/packages/hub-nodejs/examples). We're also including sample @farcaster/hub-web code below as well as a list of differences with the other package.
+
+### Getting start: fetching casts
 
 ```typescript
 import { getHubRpcClient } from '@farcaster/hub-web';
 
 (async () => {
-  // if you are testing from a node environment
-  // const client = getHubRpcClient('https://testnet1.farcaster.xyz:2284', false);
+  const client = getHubRpcClient('https://testnet1.farcaster.xyz:2285');
 
-  // if you are testing from a browser environment
-  const client = getHubRpcClient('https://testnet1.farcaster.xyz:2284');
-
-  const castsResult = await client.getCastsByFid({ fid: 7884 });
+  const castsResult = await client.getCastsByFid({ fid: 15 });
 
   castsResult.map((casts) => casts.messages.map((cast) => console.log(cast.data?.castAddBody?.text)));
 })();
 ```
 
+### Instantiating a client
+
+The method to construct a Hub gRPC client differs from @farcaster/hub-nodejs. Use `getHubRpcClient`, which returns a Hub gRPC-Web client. Make sure that the gRPC server you're connecting to implements a gRPC-Web proxy. The standard is to expose the gRPC-Web proxy at port 2285.
+
+#### Usage
+
+```typescript
+import { getHubRpcClient } from '@farcaster/hub-web';
+
+(async () => {
+  const client = getHubRpcClient('https://testnet1.farcaster.xyz:2285');
+
+  // If you're using gRPC-Web from a Nodejs environment, add a second false parameter
+  // const nodeClient = getHubRpcClient('https://testnet1.farcaster.xyz:2285', false);
+})();
+```
+
+#### Returns
+
+| Type           | Description                     |
+| :------------- | :------------------------------ |
+| `HubRpcClient` | A new gRPC-Web Client instance. |
+
+#### Parameters
+
+| Name        | Type      | Description                                                                |
+| :---------- | :-------- | :------------------------------------------------------------------------- |
+| `url`       | `string`  | Address and RPC port string (e.g. `https://testnet1.farcaster.xyz:2285`)   |
+| `isBrowser` | `boolean` | Optional parameter indicating whether to use the gRPC-Web Nodejs transport |
+
+### Streaming hub events
+
+gRPC-Web hub event streams are instances of the [Observable class](https://rxjs.dev/guide/observable) in @farcaster/hub-web.
+
+#### Usage
+
+```typescript
+import { getHubRpcClient } from '@farcaster/hub-web';
+
+async () => {
+  const client = getHubRpcClient('https://testnet1.farcaster.xyz:2285');
+
+  const result = client.subscribe({ eventTypes: [HubEventType.PRUNE_MESSAGE], fromId: 0 });
+
+  result.map((observable) => {
+    observable.subscribe({
+      next(event: HubEvent) {
+        console.log('received event', event);
+      },
+      error(err) {
+        console.error(err);
+      },
+    });
+  });
+};
+```
+
+#### Returns
+
+| Type                              | Description                                                                   |
+| :-------------------------------- | :---------------------------------------------------------------------------- |
+| `HubResult<Observable<HubEvent>>` | An [Observable](https://rxjs.dev/guide/observable) stream wrapped in a Result |
+
+#### Parameters
+
+| Name         | Type             | Description                                                                                                                                                                           |
+| :----------- | :--------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `fromId`     | `number`         | (Optional) ID of the hub event to start streaming from. A `fromId` of `0` will stream all events from the hub, and passing no `fromId` will start the stream from the present moment. |
+| `eventTypes` | `HubEventType[]` | Array of hub event types to return. If `eventTypes` is `[]`, all event types will be returned.                                                                                        |
+
 ## Contributing
 
 Please see our [contributing guidelines](https://github.com/farcasterxyz/hubble/blob/main/CONTRIBUTING.md) before making a pull request.

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { HubResult } from '@farcaster/core';
 export * from '@farcaster/core';
 import { grpc } from '@improbable-eng/grpc-web';
+export { grpc } from '@improbable-eng/grpc-web';
 import { Observable } from 'rxjs';
 export { Observable } from 'rxjs';
 import _m0 from 'protobufjs/minimal';
@@ -7880,13 +7881,10 @@ declare class GrpcWebError extends tsProtoGlobalThis.Error {
     constructor(message: string, code: grpc.Code, metadata: grpc.Metadata);
 }
 
-declare const Code: typeof grpc.Code;
-declare const Metadata: typeof grpc.Metadata;
-
 type OriginalUnaryCall<T, U> = (request: T, metadata?: grpc.Metadata) => Promise<U>;
 type WrappedUnaryCall<T, U> = (request: T, metadata?: grpc.Metadata) => Promise<HubResult<U>>;
 type OriginalStream<T, U> = (request: T, metadata?: grpc.Metadata) => Observable<U>;
-type WrappedStream<T, U> = (request: T, metadata?: grpc.Metadata) => Promise<HubResult<Observable<U>>>;
+type WrappedStream<T, U> = (request: T, metadata?: grpc.Metadata) => HubResult<Observable<U>>;
 type WrappedClient<C> = {
     $: C;
 } & {
@@ -7898,4 +7896,4 @@ type AdminRpcClient = WrappedClient<AdminService>;
 declare const getAdminRpcClient: (url: string, isBrowser?: boolean) => AdminRpcClient;
 declare const getAuthMetadata: (username: string, password: string) => grpc.Metadata;
 
-export { AdminRpcClient, AdminService, AdminServiceClientImpl, AdminServiceDeleteAllMessagesFromDbDesc, AdminServiceDesc, AdminServiceRebuildSyncTrieDesc, AdminServiceSubmitIdRegistryEventDesc, AdminServiceSubmitNameRegistryEventDesc, Code, GrpcWebError, GrpcWebImpl, HubRpcClient, HubService, HubServiceClientImpl, HubServiceDesc, HubServiceGetAllCastMessagesByFidDesc, HubServiceGetAllMessagesBySyncIdsDesc, HubServiceGetAllReactionMessagesByFidDesc, HubServiceGetAllSignerMessagesByFidDesc, HubServiceGetAllSyncIdsByPrefixDesc, HubServiceGetAllUserDataMessagesByFidDesc, HubServiceGetAllVerificationMessagesByFidDesc, HubServiceGetCastDesc, HubServiceGetCastsByFidDesc, HubServiceGetCastsByMentionDesc, HubServiceGetCastsByParentDesc, HubServiceGetEventDesc, HubServiceGetFidsDesc, HubServiceGetIdRegistryEventByAddressDesc, HubServiceGetIdRegistryEventDesc, HubServiceGetInfoDesc, HubServiceGetNameRegistryEventDesc, HubServiceGetReactionDesc, HubServiceGetReactionsByCastDesc, HubServiceGetReactionsByFidDesc, HubServiceGetSignerDesc, HubServiceGetSignersByFidDesc, HubServiceGetSyncMetadataByPrefixDesc, HubServiceGetSyncSnapshotByPrefixDesc, HubServiceGetUserDataByFidDesc, HubServiceGetUserDataDesc, HubServiceGetVerificationDesc, HubServiceGetVerificationsByFidDesc, HubServiceSubmitMessageDesc, HubServiceSubscribeDesc, Metadata, getAdminRpcClient, getAuthMetadata, getHubRpcClient };
+export { AdminRpcClient, AdminService, AdminServiceClientImpl, AdminServiceDeleteAllMessagesFromDbDesc, AdminServiceDesc, AdminServiceRebuildSyncTrieDesc, AdminServiceSubmitIdRegistryEventDesc, AdminServiceSubmitNameRegistryEventDesc, GrpcWebError, GrpcWebImpl, HubRpcClient, HubService, HubServiceClientImpl, HubServiceDesc, HubServiceGetAllCastMessagesByFidDesc, HubServiceGetAllMessagesBySyncIdsDesc, HubServiceGetAllReactionMessagesByFidDesc, HubServiceGetAllSignerMessagesByFidDesc, HubServiceGetAllSyncIdsByPrefixDesc, HubServiceGetAllUserDataMessagesByFidDesc, HubServiceGetAllVerificationMessagesByFidDesc, HubServiceGetCastDesc, HubServiceGetCastsByFidDesc, HubServiceGetCastsByMentionDesc, HubServiceGetCastsByParentDesc, HubServiceGetEventDesc, HubServiceGetFidsDesc, HubServiceGetIdRegistryEventByAddressDesc, HubServiceGetIdRegistryEventDesc, HubServiceGetInfoDesc, HubServiceGetNameRegistryEventDesc, HubServiceGetReactionDesc, HubServiceGetReactionsByCastDesc, HubServiceGetReactionsByFidDesc, HubServiceGetSignerDesc, HubServiceGetSignersByFidDesc, HubServiceGetSyncMetadataByPrefixDesc, HubServiceGetSyncSnapshotByPrefixDesc, HubServiceGetUserDataByFidDesc, HubServiceGetUserDataDesc, HubServiceGetVerificationDesc, HubServiceGetVerificationsByFidDesc, HubServiceSubmitMessageDesc, HubServiceSubscribeDesc, getAdminRpcClient, getAuthMetadata, getHubRpcClient };