@farcaster/hub-web 0.9.4 → 0.9.6

package/README.grpcweb.md

@@ -53,7 +53,7 @@ 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
+  // If you're using gRPC-Web from a Node.js environment, add a second false parameter
   // const nodeClient = getHubRpcClient('https://testnet1.farcaster.xyz:2285', false);
 })();
 ```
@@ -69,7 +69,7 @@ import { getHubRpcClient } from '@farcaster/hub-web';
 | 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 |
+| `isBrowser` | `boolean` | Optional parameter indicating whether to use the gRPC-Web Node.js transport |
 
 ### Streaming hub events
 

package/README.md

@@ -33,13 +33,34 @@ try {
     const response = await axios.get(`${server}/v1/castsByFid?fid=${fid}`);
 
     console.log(`API Returned HTTP status ${response.status}`);    
-    console.log(`First Cast's text is ${response.messages[0].data.castAddBody.text}`);
+    console.log(`The first cast's text is ${response.messages[0].data.castAddBody.text}`);
 } catch (e) {
     // Handle errors
     console.log(response);
 }
 ```
 
+### Get the username by FID
+
+```typescript
+const getFnameFromFid = async (
+  fid: number,
+  client: HubRpcClient
+): HubAsyncResult<string> => {
+  const result = await client.getUserData({
+    fid: fid,
+    userDataType: UserDataType.FNAME,
+  });
+  return result.map((message) => {
+    if (isUserDataAddMessage(message)) {
+      return message.data.userDataBody.value;
+    } else {
+      return '';
+    }
+  });
+};
+```
+
 ### Running the examples
 
 There are several examples in the `examples/` folder. To run the examples, please look at the individual README files in the examples directory. Most examples can be run by

package/dist/index.d.ts

@@ -453,7 +453,11 @@ declare enum UserDataType {
     /** USERNAME - Preferred Name for the user */
     USERNAME = 6,
     /** LOCATION - Current location for the user */
-    LOCATION = 7
+    LOCATION = 7,
+    /** TWITTER - Username of user on twitter */
+    TWITTER = 8,
+    /** GITHUB - Username of user on github */
+    GITHUB = 9
 }
 /** Type of cast */
 declare enum CastType {

package/dist/index.js

@@ -3138,6 +3138,12 @@ function userDataTypeFromJSON(object) {
     case 7:
     case "USER_DATA_TYPE_LOCATION":
       return 7 /* LOCATION */;
+    case 8:
+    case "USER_DATA_TYPE_TWITTER":
+      return 8 /* TWITTER */;
+    case 9:
+    case "USER_DATA_TYPE_GITHUB":
+      return 9 /* GITHUB */;
     default:
       throw new tsProtoGlobalThis2.Error("Unrecognized enum value " + object + " for enum UserDataType");
   }
@@ -3158,6 +3164,10 @@ function userDataTypeToJSON(object) {
       return "USER_DATA_TYPE_USERNAME";
     case 7 /* LOCATION */:
       return "USER_DATA_TYPE_LOCATION";
+    case 8 /* TWITTER */:
+      return "USER_DATA_TYPE_TWITTER";
+    case 9 /* GITHUB */:
+      return "USER_DATA_TYPE_GITHUB";
     default:
       throw new tsProtoGlobalThis2.Error("Unrecognized enum value " + object + " for enum UserDataType");
   }

package/dist/index.mjs

@@ -3070,6 +3070,12 @@ function userDataTypeFromJSON(object) {
     case 7:
     case "USER_DATA_TYPE_LOCATION":
       return 7 /* LOCATION */;
+    case 8:
+    case "USER_DATA_TYPE_TWITTER":
+      return 8 /* TWITTER */;
+    case 9:
+    case "USER_DATA_TYPE_GITHUB":
+      return 9 /* GITHUB */;
     default:
       throw new tsProtoGlobalThis2.Error("Unrecognized enum value " + object + " for enum UserDataType");
   }
@@ -3090,6 +3096,10 @@ function userDataTypeToJSON(object) {
       return "USER_DATA_TYPE_USERNAME";
     case 7 /* LOCATION */:
       return "USER_DATA_TYPE_LOCATION";
+    case 8 /* TWITTER */:
+      return "USER_DATA_TYPE_TWITTER";
+    case 9 /* GITHUB */:
+      return "USER_DATA_TYPE_GITHUB";
     default:
       throw new tsProtoGlobalThis2.Error("Unrecognized enum value " + object + " for enum UserDataType");
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farcaster/hub-web",
-  "version": "0.9.4",
+  "version": "0.9.6",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
@@ -32,7 +32,7 @@
     "ts-proto": "^1.146.0"
   },
   "dependencies": {
-    "@farcaster/core": "^0.15.5",
+    "@farcaster/core": "^0.16.0",
     "@improbable-eng/grpc-web": "^0.15.0",
     "rxjs": "^7.8.0"
   }