@bitsocial/bitsocial-react-hooks 0.1.0

package/dist/hooks/actions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/hooks/actions/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC","sourcesContent":["export * from \"./actions\";\n"]}

package/dist/hooks/authors/author-avatars.d.ts

@@ -0,0 +1,28 @@
+import { Nft, ChainProviders, Author } from "../../types.js";
+/**
+ * @param nft - The NFT object to resolve the URL of.
+ * @param acountName - The nickname of the account, e.g. 'Account 1'. If no accountName is provided, use
+ * the active account.
+ */
+export declare function useNftMetadataUrl(nft?: Nft, accountName?: string): {
+    metadataUrl: undefined;
+    error: Error | undefined;
+};
+/**
+ * @param nftMetadataUrl - The NFT URL to resolve the image URL of.
+ * @param acountName - The nickname of the account, e.g. 'Account 1'. If no accountName is provided, use
+ * the active account.
+ */
+export declare function useNftImageUrl(nftMetadataUrl?: string, accountName?: string): {
+    imageUrl: undefined;
+    error: Error | undefined;
+};
+export declare function useVerifiedAuthorAvatarSignature(author?: Author, accountName?: string): {
+    verified: boolean | undefined;
+    error: Error | undefined;
+};
+export declare const setAuthorAvatarsWhitelistedTokenAddresses: (tokenAddresses: string[]) => void;
+export declare function useAuthorAvatarIsWhitelisted(nft?: Nft): any;
+export declare const getNftMessageToSign: (authorAddress: string, timestamp: number, tokenAddress: string, tokenId: string) => string;
+export declare const verifyAuthorAvatarSignature: (nft: Nft, authorAddress: string, chainProviders: ChainProviders) => Promise<boolean>;
+//# sourceMappingURL=author-avatars.d.ts.map

package/dist/hooks/authors/author-avatars.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"author-avatars.d.ts","sourceRoot":"","sources":["../../../src/hooks/authors/author-avatars.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAQ1D;;;;GAIG;AAEH,wBAAgB,iBAAiB,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,WAAW,CAAC,EAAE,MAAM;;;EA2ChE;AAED;;;;GAIG;AAEH,wBAAgB,cAAc,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM;;;EAgC3E;AAGD,wBAAgB,gCAAgC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM;;;EAyCrF;AA6BD,eAAO,MAAM,yCAAyC,mBAlBQ,MAAM,EAAE,KAAK,IAoB7B,CAAC;AAG/C,wBAAgB,4BAA4B,CAAC,GAAG,CAAC,EAAE,GAAG,OAcrD;AAED,eAAO,MAAM,mBAAmB,GAC9B,eAAe,MAAM,EACrB,WAAW,MAAM,EACjB,cAAc,MAAM,EACpB,SAAS,MAAM,WAKhB,CAAC;AAGF,eAAO,MAAM,2BAA2B,GACtC,KAAK,GAAG,EACR,eAAe,MAAM,EACrB,gBAAgB,cAAc,qBA+C/B,CAAC"}

package/dist/hooks/authors/author-avatars.js

@@ -0,0 +1,191 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { useEffect, useState } from "react";
+import { useAccount } from "../accounts/index.js";
+import Logger from "@pkcprotocol/pkc-logger";
+const log = Logger("bitsocial-react-hooks:authors:hooks");
+import assert from "assert";
+import { ethers } from "ethers";
+import { getNftMetadataUrl, getNftImageUrl, getNftOwner } from "../../lib/chain/index.js";
+import { getChainProviders } from "../../lib/pkc-compat.js";
+import createStore from "zustand";
+const noMediaIpfsGatewayUrl = "http://no-media-ipfs-gateway-url";
+/**
+ * @param nft - The NFT object to resolve the URL of.
+ * @param acountName - The nickname of the account, e.g. 'Account 1'. If no accountName is provided, use
+ * the active account.
+ */
+// NOTE: useNftMetadataUrl tests are skipped, if changes are made they must be tested manually
+export function useNftMetadataUrl(nft, accountName) {
+    var _a, _b, _c;
+    const account = useAccount({ accountName });
+    const ipfsGatewayUrl = (account === null || account === void 0 ? void 0 : account.mediaIpfsGatewayUrl) || noMediaIpfsGatewayUrl;
+    const chainProviders = getChainProviders(account);
+    const [nftMetadataUrl, setNftMetadataUrl] = useState();
+    const [error, setError] = useState();
+    const getNftMetadataUrlArgs = [
+        nft === null || nft === void 0 ? void 0 : nft.address,
+        nft === null || nft === void 0 ? void 0 : nft.id,
+        nft === null || nft === void 0 ? void 0 : nft.chainTicker,
+        (_b = (_a = chainProviders === null || chainProviders === void 0 ? void 0 : chainProviders[nft === null || nft === void 0 ? void 0 : nft.chainTicker]) === null || _a === void 0 ? void 0 : _a.urls) === null || _b === void 0 ? void 0 : _b[0],
+        (_c = chainProviders === null || chainProviders === void 0 ? void 0 : chainProviders[nft === null || nft === void 0 ? void 0 : nft.chainTicker]) === null || _c === void 0 ? void 0 : _c.chainId,
+        ipfsGatewayUrl,
+    ];
+    useEffect(() => {
+        // reset
+        setError(undefined);
+        setNftMetadataUrl(undefined);
+        if (!account || !nft) {
+            return;
+        }
+        (() => __awaiter(this, void 0, void 0, function* () {
+            try {
+                const url = yield getNftMetadataUrl(...getNftMetadataUrlArgs);
+                setNftMetadataUrl(url);
+            }
+            catch (error) {
+                setError(error);
+                log.error("useNftMetadataUrl getNftMetadataUrl error", {
+                    nft,
+                    ipfsGatewayUrl,
+                    chainProviders,
+                    error,
+                });
+            }
+        }))();
+    }, getNftMetadataUrlArgs);
+    // log('useNftMetadataUrl', {nft, ipfsGatewayUrl, nftMetadataUrl, chainProviders})
+    return { metadataUrl: nftMetadataUrl, error };
+}
+/**
+ * @param nftMetadataUrl - The NFT URL to resolve the image URL of.
+ * @param acountName - The nickname of the account, e.g. 'Account 1'. If no accountName is provided, use
+ * the active account.
+ */
+// NOTE: useNftImageUrl tests are skipped, if changes are made they must be tested manually
+export function useNftImageUrl(nftMetadataUrl, accountName) {
+    assert(!nftMetadataUrl || typeof nftMetadataUrl === "string", `useNftImageUrl invalid argument nftMetadataUrl '${nftMetadataUrl}' not a string`);
+    const account = useAccount({ accountName });
+    const ipfsGatewayUrl = (account === null || account === void 0 ? void 0 : account.mediaIpfsGatewayUrl) || noMediaIpfsGatewayUrl;
+    const [imageUrl, setImageUrl] = useState();
+    const [error, setError] = useState();
+    useEffect(() => {
+        // reset
+        setError(undefined);
+        setImageUrl(undefined);
+        if (!account || !nftMetadataUrl) {
+            return;
+        }
+        (() => __awaiter(this, void 0, void 0, function* () {
+            try {
+                const url = yield getNftImageUrl(nftMetadataUrl, ipfsGatewayUrl);
+                setImageUrl(url);
+            }
+            catch (error) {
+                setError(error);
+                log.error("useNftImageUrl getNftImageUrl error", { nftMetadataUrl, ipfsGatewayUrl, error });
+            }
+        }))();
+    }, [nftMetadataUrl, ipfsGatewayUrl]);
+    // log('useNftImageUrl', {nftMetadataUrl, ipfsGatewayUrl, imageUrl})
+    return { imageUrl, error };
+}
+// NOTE: useVerifiedAuthorAvatarSignature tests are skipped, if changes are made they must be tested manually
+export function useVerifiedAuthorAvatarSignature(author, accountName) {
+    const account = useAccount({ accountName });
+    const chainProviders = getChainProviders(account);
+    const [verified, setVerified] = useState();
+    const [error, setError] = useState();
+    useEffect(() => {
+        // reset
+        setError(undefined);
+        setVerified(undefined);
+        if (!account || !(author === null || author === void 0 ? void 0 : author.avatar)) {
+            return;
+        }
+        (() => __awaiter(this, void 0, void 0, function* () {
+            try {
+                const res = yield verifyAuthorAvatarSignature(author.avatar, author.address, chainProviders);
+                setVerified(res);
+            }
+            catch (error) {
+                setError(error);
+                log.error("useVerifiedAuthorAvatarSignature verifyAuthorAvatarSignature error", {
+                    author,
+                    chainProviders,
+                    error,
+                });
+            }
+        }))();
+    }, [author === null || author === void 0 ? void 0 : author.avatar, author === null || author === void 0 ? void 0 : author.address, chainProviders]);
+    // don't verify nft signature when using mock content during development
+    if (process.env.REACT_APP_BITSOCIAL_REACT_HOOKS_MOCK_CONTENT) {
+        return { verified: true, error: undefined };
+    }
+    // log('useVerifiedAuthorAvatarSignature', {author, verified, chainProviders})
+    return { verified, error };
+}
+const defaultWhitelistedTokenAddresses = [
+    // xpleb nfts
+    "0x890a2e81836e0e76e0f49995e6b51ca6ce6f39ed",
+    // plebsquat
+    "0x52e6cd20f5fca56da5a0e489574c92af118b8188",
+];
+const useAuthorAvatarsWhitelistedTokenAddressesStore = createStore((setState, getState) => ({
+    authorAvatarsWhitelistedTokenAddresses: {},
+    setAuthorAvatarsWhitelistedTokenAddresses: (tokenAddresses) => {
+        const authorAvatarsWhitelistedTokenAddresses = {};
+        for (const tokenAddress of tokenAddresses) {
+            authorAvatarsWhitelistedTokenAddresses[tokenAddress] = true;
+            // make sure lower case version exists
+            authorAvatarsWhitelistedTokenAddresses[tokenAddress.toLowerCase()] = true;
+        }
+        setState({ authorAvatarsWhitelistedTokenAddresses });
+    },
+}));
+export const setAuthorAvatarsWhitelistedTokenAddresses = useAuthorAvatarsWhitelistedTokenAddressesStore.getState()
+    .setAuthorAvatarsWhitelistedTokenAddresses;
+setAuthorAvatarsWhitelistedTokenAddresses(defaultWhitelistedTokenAddresses); // init default
+export function useAuthorAvatarIsWhitelisted(nft) {
+    // TODO: make a list that a dao can vote it, get the list from pkc.getDefaults()
+    // TODO: make community owners able to whitelist their own nfts in their communities
+    // TODO: make each user able to whitelist/blacklist any nft they want for their own client
+    // TODO: make hook to list which default nfts are whitelisted to display to the user
+    var _a;
+    const authorAvatarsWhitelistedTokenAddresses = useAuthorAvatarsWhitelistedTokenAddressesStore((state) => state.authorAvatarsWhitelistedTokenAddresses);
+    const isWhitelisted = (nft === null || nft === void 0 ? void 0 : nft.address) && Boolean(authorAvatarsWhitelistedTokenAddresses[(_a = nft === null || nft === void 0 ? void 0 : nft.address) === null || _a === void 0 ? void 0 : _a.toLowerCase()]);
+    return isWhitelisted;
+}
+export const getNftMessageToSign = (authorAddress, timestamp, tokenAddress, tokenId) => {
+    // use plain JSON so the user can read what he's signing
+    // property names must always be in this order for signature to match so don't use JSON.stringify
+    return `{"domainSeparator":"pkc-author-avatar","authorAddress":"${authorAddress}","timestamp":${timestamp},"tokenAddress":"${tokenAddress}","tokenId":"${tokenId}"}`;
+};
+// NOTE: verifyAuthorAvatarSignature tests are skipped, if changes are made they must be tested manually
+export const verifyAuthorAvatarSignature = (nft, authorAddress, chainProviders) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b, _c, _d, _e;
+    assert(nft && typeof nft === "object", `verifyAuthorAvatarSignature invalid nft argument '${nft}'`);
+    assert(nft === null || nft === void 0 ? void 0 : nft.address, `verifyAuthorAvatarSignature invalid nft.address '${nft === null || nft === void 0 ? void 0 : nft.address}'`);
+    assert((nft === null || nft === void 0 ? void 0 : nft.id) && typeof (nft === null || nft === void 0 ? void 0 : nft.id) === "string", `verifyAuthorAvatarSignature invalid nft.tokenAddress '${nft === null || nft === void 0 ? void 0 : nft.id}' not a string`);
+    assert(typeof (nft === null || nft === void 0 ? void 0 : nft.timestamp) === "number", `verifyAuthorAvatarSignature invalid nft.timestamp '${nft === null || nft === void 0 ? void 0 : nft.timestamp}' not a number`);
+    assert(nft === null || nft === void 0 ? void 0 : nft.signature, `verifyAuthorAvatarSignature invalid nft.signature '${nft === null || nft === void 0 ? void 0 : nft.signature}'`);
+    assert((_a = nft === null || nft === void 0 ? void 0 : nft.signature) === null || _a === void 0 ? void 0 : _a.signature, `verifyAuthorAvatarSignature invalid nft.signature.signature '${(_b = nft === null || nft === void 0 ? void 0 : nft.signature) === null || _b === void 0 ? void 0 : _b.signature}'`);
+    assert(authorAddress, `verifyAuthorAvatarSignature invalid authorAddress '${authorAddress}'`);
+    // get the owner of the nft at nft.id
+    const currentNftOwnerAddress = yield getNftOwner(nft === null || nft === void 0 ? void 0 : nft.address, nft === null || nft === void 0 ? void 0 : nft.id, nft === null || nft === void 0 ? void 0 : nft.chainTicker, (_d = (_c = chainProviders === null || chainProviders === void 0 ? void 0 : chainProviders[nft === null || nft === void 0 ? void 0 : nft.chainTicker]) === null || _c === void 0 ? void 0 : _c.urls) === null || _d === void 0 ? void 0 : _d[0], (_e = chainProviders === null || chainProviders === void 0 ? void 0 : chainProviders[nft === null || nft === void 0 ? void 0 : nft.chainTicker]) === null || _e === void 0 ? void 0 : _e.chainId);
+    const messageThatShouldBeSigned = getNftMessageToSign(authorAddress, nft.timestamp, nft.address, nft.id);
+    const signatureAddress = ethers.utils.verifyMessage(messageThatShouldBeSigned, nft.signature.signature);
+    let verified = true;
+    if (currentNftOwnerAddress !== signatureAddress) {
+        verified = false;
+    }
+    return verified;
+});
+//# sourceMappingURL=author-avatars.js.map

package/dist/hooks/authors/author-avatars.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"author-avatars.js","sourceRoot":"","sources":["../../../src/hooks/authors/author-avatars.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAW,MAAM,OAAO,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,MAAM,MAAM,yBAAyB,CAAC;AAC7C,MAAM,GAAG,GAAG,MAAM,CAAC,qCAAqC,CAAC,CAAC;AAC1D,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACjF,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,WAAW,MAAM,SAAS,CAAC;AAElC,MAAM,qBAAqB,GAAG,kCAAkC,CAAC;AAEjE;;;;GAIG;AACH,8FAA8F;AAC9F,MAAM,UAAU,iBAAiB,CAAC,GAAS,EAAE,WAAoB;;IAC/D,MAAM,OAAO,GAAG,UAAU,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;IAC5C,MAAM,cAAc,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,mBAAmB,KAAI,qBAAqB,CAAC;IAC7E,MAAM,cAAc,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAClD,MAAM,CAAC,cAAc,EAAE,iBAAiB,CAAC,GAAG,QAAQ,EAAE,CAAC;IACvD,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,EAAqB,CAAC;IAExD,MAAM,qBAAqB,GAAG;QAC5B,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO;QACZ,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,EAAE;QACP,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,WAAW;QAChB,MAAA,MAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAG,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,WAAW,CAAC,0CAAE,IAAI,0CAAG,CAAC,CAAC;QAC7C,MAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAG,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,WAAW,CAAC,0CAAE,OAAO;QAC3C,cAAc;KACf,CAAC;IAEF,SAAS,CAAC,GAAG,EAAE;QACb,QAAQ;QACR,QAAQ,CAAC,SAAS,CAAC,CAAC;QACpB,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAE7B,IAAI,CAAC,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC;YACrB,OAAO;QACT,CAAC;QAED,CAAC,GAAS,EAAE;YACV,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,MAAM,iBAAiB,CAAC,GAAG,qBAAqB,CAAC,CAAC;gBAC9D,iBAAiB,CAAC,GAAG,CAAC,CAAC;YACzB,CAAC;YAAC,OAAO,KAAU,EAAE,CAAC;gBACpB,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAChB,GAAG,CAAC,KAAK,CAAC,2CAA2C,EAAE;oBACrD,GAAG;oBACH,cAAc;oBACd,cAAc;oBACd,KAAK;iBACN,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAA,CAAC,EAAE,CAAC;IACP,CAAC,EAAE,qBAAqB,CAAC,CAAC;IAE1B,kFAAkF;IAClF,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC;AAChD,CAAC;AAED;;;;GAIG;AACH,2FAA2F;AAC3F,MAAM,UAAU,cAAc,CAAC,cAAuB,EAAE,WAAoB;IAC1E,MAAM,CACJ,CAAC,cAAc,IAAI,OAAO,cAAc,KAAK,QAAQ,EACrD,mDAAmD,cAAc,gBAAgB,CAClF,CAAC;IACF,MAAM,OAAO,GAAG,UAAU,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;IAC5C,MAAM,cAAc,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,mBAAmB,KAAI,qBAAqB,CAAC;IAC7E,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,GAAG,QAAQ,EAAE,CAAC;IAC3C,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,EAAqB,CAAC;IAExD,SAAS,CAAC,GAAG,EAAE;QACb,QAAQ;QACR,QAAQ,CAAC,SAAS,CAAC,CAAC;QACpB,WAAW,CAAC,SAAS,CAAC,CAAC;QAEvB,IAAI,CAAC,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC;YAChC,OAAO;QACT,CAAC;QAED,CAAC,GAAS,EAAE;YACV,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;gBACjE,WAAW,CAAC,GAAG,CAAC,CAAC;YACnB,CAAC;YAAC,OAAO,KAAU,EAAE,CAAC;gBACpB,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAChB,GAAG,CAAC,KAAK,CAAC,qCAAqC,EAAE,EAAE,cAAc,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC,CAAC;YAC9F,CAAC;QACH,CAAC,CAAA,CAAC,EAAE,CAAC;IACP,CAAC,EAAE,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC;IAErC,oEAAoE;IACpE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;AAC7B,CAAC;AAED,6GAA6G;AAC7G,MAAM,UAAU,gCAAgC,CAAC,MAAe,EAAE,WAAoB;IACpF,MAAM,OAAO,GAAG,UAAU,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;IAC5C,MAAM,cAAc,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAClD,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,GAAG,QAAQ,EAAW,CAAC;IACpD,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,EAAqB,CAAC;IAExD,SAAS,CAAC,GAAG,EAAE;QACb,QAAQ;QACR,QAAQ,CAAC,SAAS,CAAC,CAAC;QACpB,WAAW,CAAC,SAAS,CAAC,CAAC;QAEvB,IAAI,CAAC,OAAO,IAAI,CAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAA,EAAE,CAAC;YAChC,OAAO;QACT,CAAC;QAED,CAAC,GAAS,EAAE;YACV,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,MAAM,2BAA2B,CAC3C,MAAM,CAAC,MAAM,EACb,MAAM,CAAC,OAAO,EACd,cAAc,CACf,CAAC;gBACF,WAAW,CAAC,GAAG,CAAC,CAAC;YACnB,CAAC;YAAC,OAAO,KAAU,EAAE,CAAC;gBACpB,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAChB,GAAG,CAAC,KAAK,CAAC,oEAAoE,EAAE;oBAC9E,MAAM;oBACN,cAAc;oBACd,KAAK;iBACN,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAA,CAAC,EAAE,CAAC;IACP,CAAC,EAAE,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,EAAE,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC;IAEtD,wEAAwE;IACxE,IAAI,OAAO,CAAC,GAAG,CAAC,4CAA4C,EAAE,CAAC;QAC7D,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;IAC9C,CAAC;IAED,8EAA8E;IAC9E,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;AAC7B,CAAC;AAED,MAAM,gCAAgC,GAAG;IACvC,aAAa;IACb,4CAA4C;IAC5C,YAAY;IACZ,4CAA4C;CAC7C,CAAC;AAOF,MAAM,8CAA8C,GAClD,WAAW,CACT,CAAC,QAAkB,EAAE,QAAkB,EAAE,EAAE,CAAC,CAAC;IAC3C,sCAAsC,EAAE,EAAE;IAC1C,yCAAyC,EAAE,CAAC,cAAwB,EAAE,EAAE;QACtE,MAAM,sCAAsC,GAAwC,EAAE,CAAC;QACvF,KAAK,MAAM,YAAY,IAAI,cAAc,EAAE,CAAC;YAC1C,sCAAsC,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;YAC5D,sCAAsC;YACtC,sCAAsC,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC,GAAG,IAAI,CAAC;QAC5E,CAAC;QACD,QAAQ,CAAC,EAAE,sCAAsC,EAAE,CAAC,CAAC;IACvD,CAAC;CACF,CAAC,CACH,CAAC;AACJ,MAAM,CAAC,MAAM,yCAAyC,GACpD,8CAA8C,CAAC,QAAQ,EAAE;KACtD,yCAAyC,CAAC;AAC/C,yCAAyC,CAAC,gCAAgC,CAAC,CAAC,CAAC,eAAe;AAE5F,MAAM,UAAU,4BAA4B,CAAC,GAAS;IACpD,gFAAgF;IAChF,oFAAoF;IACpF,0FAA0F;IAC1F,oFAAoF;;IAEpF,MAAM,sCAAsC,GAAG,8CAA8C,CAC3F,CAAC,KAAkD,EAAE,EAAE,CACrD,KAAK,CAAC,sCAAsC,CAC/C,CAAC;IAEF,MAAM,aAAa,GACjB,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,KAAI,OAAO,CAAC,sCAAsC,CAAC,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,0CAAE,WAAW,EAAE,CAAC,CAAC,CAAC;IAC/F,OAAO,aAAa,CAAC;AACvB,CAAC;AAED,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,aAAqB,EACrB,SAAiB,EACjB,YAAoB,EACpB,OAAe,EACf,EAAE;IACF,wDAAwD;IACxD,iGAAiG;IACjG,OAAO,2DAA2D,aAAa,iBAAiB,SAAS,oBAAoB,YAAY,gBAAgB,OAAO,IAAI,CAAC;AACvK,CAAC,CAAC;AAEF,wGAAwG;AACxG,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,GAAQ,EACR,aAAqB,EACrB,cAA8B,EAC9B,EAAE;;IACF,MAAM,CACJ,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAC9B,qDAAqD,GAAG,GAAG,CAC5D,CAAC;IACF,MAAM,CAAC,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,EAAE,oDAAoD,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,GAAG,CAAC,CAAC;IAC1F,MAAM,CACJ,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,EAAE,KAAI,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,EAAE,CAAA,KAAK,QAAQ,EACtC,yDAAyD,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,EAAE,gBAAgB,CACjF,CAAC;IACF,MAAM,CACJ,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,SAAS,CAAA,KAAK,QAAQ,EAClC,sDAAsD,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,SAAS,gBAAgB,CACrF,CAAC;IACF,MAAM,CAAC,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,SAAS,EAAE,sDAAsD,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,SAAS,GAAG,CAAC,CAAC;IAChG,MAAM,CACJ,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,SAAS,0CAAE,SAAS,EACzB,gEAAgE,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,SAAS,0CAAE,SAAS,GAAG,CAC7F,CAAC;IACF,MAAM,CAAC,aAAa,EAAE,sDAAsD,aAAa,GAAG,CAAC,CAAC;IAE9F,qCAAqC;IACrC,MAAM,sBAAsB,GAAG,MAAM,WAAW,CAC9C,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,EACZ,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,EAAE,EACP,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,WAAW,EAChB,MAAA,MAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAG,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,WAAW,CAAC,0CAAE,IAAI,0CAAG,CAAC,CAAC,EAC7C,MAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAG,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,WAAW,CAAC,0CAAE,OAAO,CAC5C,CAAC;IAEF,MAAM,yBAAyB,GAAG,mBAAmB,CACnD,aAAa,EACb,GAAG,CAAC,SAAS,EACb,GAAG,CAAC,OAAO,EACX,GAAG,CAAC,EAAE,CACP,CAAC;IACF,MAAM,gBAAgB,GAAG,MAAM,CAAC,KAAK,CAAC,aAAa,CACjD,yBAAyB,EACzB,GAAG,CAAC,SAAS,CAAC,SAAS,CACxB,CAAC;IAEF,IAAI,QAAQ,GAAG,IAAI,CAAC;IACpB,IAAI,sBAAsB,KAAK,gBAAgB,EAAE,CAAC;QAChD,QAAQ,GAAG,KAAK,CAAC;IACnB,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAA,CAAC","sourcesContent":["import { useEffect, useState, useMemo } from \"react\";\nimport { useAccount } from \"../accounts\";\nimport Logger from \"@pkcprotocol/pkc-logger\";\nconst log = Logger(\"bitsocial-react-hooks:authors:hooks\");\nimport assert from \"assert\";\nimport { Nft, ChainProviders, Author } from \"../../types\";\nimport { ethers } from \"ethers\";\nimport { getNftMetadataUrl, getNftImageUrl, getNftOwner } from \"../../lib/chain\";\nimport { getChainProviders } from \"../../lib/pkc-compat\";\nimport createStore from \"zustand\";\n\nconst noMediaIpfsGatewayUrl = \"http://no-media-ipfs-gateway-url\";\n\n/**\n * @param nft - The NFT object to resolve the URL of.\n * @param acountName - The nickname of the account, e.g. 'Account 1'. If no accountName is provided, use\n * the active account.\n */\n// NOTE: useNftMetadataUrl tests are skipped, if changes are made they must be tested manually\nexport function useNftMetadataUrl(nft?: Nft, accountName?: string) {\n  const account = useAccount({ accountName });\n  const ipfsGatewayUrl = account?.mediaIpfsGatewayUrl || noMediaIpfsGatewayUrl;\n  const chainProviders = getChainProviders(account);\n  const [nftMetadataUrl, setNftMetadataUrl] = useState();\n  const [error, setError] = useState<Error | undefined>();\n\n  const getNftMetadataUrlArgs = [\n    nft?.address,\n    nft?.id,\n    nft?.chainTicker,\n    chainProviders?.[nft?.chainTicker]?.urls?.[0],\n    chainProviders?.[nft?.chainTicker]?.chainId,\n    ipfsGatewayUrl,\n  ];\n\n  useEffect(() => {\n    // reset\n    setError(undefined);\n    setNftMetadataUrl(undefined);\n\n    if (!account || !nft) {\n      return;\n    }\n\n    (async () => {\n      try {\n        const url = await getNftMetadataUrl(...getNftMetadataUrlArgs);\n        setNftMetadataUrl(url);\n      } catch (error: any) {\n        setError(error);\n        log.error(\"useNftMetadataUrl getNftMetadataUrl error\", {\n          nft,\n          ipfsGatewayUrl,\n          chainProviders,\n          error,\n        });\n      }\n    })();\n  }, getNftMetadataUrlArgs);\n\n  // log('useNftMetadataUrl', {nft, ipfsGatewayUrl, nftMetadataUrl, chainProviders})\n  return { metadataUrl: nftMetadataUrl, error };\n}\n\n/**\n * @param nftMetadataUrl - The NFT URL to resolve the image URL of.\n * @param acountName - The nickname of the account, e.g. 'Account 1'. If no accountName is provided, use\n * the active account.\n */\n// NOTE: useNftImageUrl tests are skipped, if changes are made they must be tested manually\nexport function useNftImageUrl(nftMetadataUrl?: string, accountName?: string) {\n  assert(\n    !nftMetadataUrl || typeof nftMetadataUrl === \"string\",\n    `useNftImageUrl invalid argument nftMetadataUrl '${nftMetadataUrl}' not a string`,\n  );\n  const account = useAccount({ accountName });\n  const ipfsGatewayUrl = account?.mediaIpfsGatewayUrl || noMediaIpfsGatewayUrl;\n  const [imageUrl, setImageUrl] = useState();\n  const [error, setError] = useState<Error | undefined>();\n\n  useEffect(() => {\n    // reset\n    setError(undefined);\n    setImageUrl(undefined);\n\n    if (!account || !nftMetadataUrl) {\n      return;\n    }\n\n    (async () => {\n      try {\n        const url = await getNftImageUrl(nftMetadataUrl, ipfsGatewayUrl);\n        setImageUrl(url);\n      } catch (error: any) {\n        setError(error);\n        log.error(\"useNftImageUrl getNftImageUrl error\", { nftMetadataUrl, ipfsGatewayUrl, error });\n      }\n    })();\n  }, [nftMetadataUrl, ipfsGatewayUrl]);\n\n  // log('useNftImageUrl', {nftMetadataUrl, ipfsGatewayUrl, imageUrl})\n  return { imageUrl, error };\n}\n\n// NOTE: useVerifiedAuthorAvatarSignature tests are skipped, if changes are made they must be tested manually\nexport function useVerifiedAuthorAvatarSignature(author?: Author, accountName?: string) {\n  const account = useAccount({ accountName });\n  const chainProviders = getChainProviders(account);\n  const [verified, setVerified] = useState<boolean>();\n  const [error, setError] = useState<Error | undefined>();\n\n  useEffect(() => {\n    // reset\n    setError(undefined);\n    setVerified(undefined);\n\n    if (!account || !author?.avatar) {\n      return;\n    }\n\n    (async () => {\n      try {\n        const res = await verifyAuthorAvatarSignature(\n          author.avatar,\n          author.address,\n          chainProviders,\n        );\n        setVerified(res);\n      } catch (error: any) {\n        setError(error);\n        log.error(\"useVerifiedAuthorAvatarSignature verifyAuthorAvatarSignature error\", {\n          author,\n          chainProviders,\n          error,\n        });\n      }\n    })();\n  }, [author?.avatar, author?.address, chainProviders]);\n\n  // don't verify nft signature when using mock content during development\n  if (process.env.REACT_APP_BITSOCIAL_REACT_HOOKS_MOCK_CONTENT) {\n    return { verified: true, error: undefined };\n  }\n\n  // log('useVerifiedAuthorAvatarSignature', {author, verified, chainProviders})\n  return { verified, error };\n}\n\nconst defaultWhitelistedTokenAddresses = [\n  // xpleb nfts\n  \"0x890a2e81836e0e76e0f49995e6b51ca6ce6f39ed\",\n  // plebsquat\n  \"0x52e6cd20f5fca56da5a0e489574c92af118b8188\",\n];\n\ntype AuthorAvatarsWhitelistedTokenAddressesState = {\n  authorAvatarsWhitelistedTokenAddresses: { [tokenAddress: string]: boolean };\n  setAuthorAvatarsWhitelistedTokenAddresses: (tokenAddresses: string[]) => void;\n};\n\nconst useAuthorAvatarsWhitelistedTokenAddressesStore =\n  createStore<AuthorAvatarsWhitelistedTokenAddressesState>(\n    (setState: Function, getState: Function) => ({\n      authorAvatarsWhitelistedTokenAddresses: {},\n      setAuthorAvatarsWhitelistedTokenAddresses: (tokenAddresses: string[]) => {\n        const authorAvatarsWhitelistedTokenAddresses: { [tokenAddress: string]: boolean } = {};\n        for (const tokenAddress of tokenAddresses) {\n          authorAvatarsWhitelistedTokenAddresses[tokenAddress] = true;\n          // make sure lower case version exists\n          authorAvatarsWhitelistedTokenAddresses[tokenAddress.toLowerCase()] = true;\n        }\n        setState({ authorAvatarsWhitelistedTokenAddresses });\n      },\n    }),\n  );\nexport const setAuthorAvatarsWhitelistedTokenAddresses =\n  useAuthorAvatarsWhitelistedTokenAddressesStore.getState()\n    .setAuthorAvatarsWhitelistedTokenAddresses;\nsetAuthorAvatarsWhitelistedTokenAddresses(defaultWhitelistedTokenAddresses); // init default\n\nexport function useAuthorAvatarIsWhitelisted(nft?: Nft) {\n  // TODO: make a list that a dao can vote it, get the list from pkc.getDefaults()\n  // TODO: make community owners able to whitelist their own nfts in their communities\n  // TODO: make each user able to whitelist/blacklist any nft they want for their own client\n  // TODO: make hook to list which default nfts are whitelisted to display to the user\n\n  const authorAvatarsWhitelistedTokenAddresses = useAuthorAvatarsWhitelistedTokenAddressesStore(\n    (state: AuthorAvatarsWhitelistedTokenAddressesState) =>\n      state.authorAvatarsWhitelistedTokenAddresses,\n  );\n\n  const isWhitelisted =\n    nft?.address && Boolean(authorAvatarsWhitelistedTokenAddresses[nft?.address?.toLowerCase()]);\n  return isWhitelisted;\n}\n\nexport const getNftMessageToSign = (\n  authorAddress: string,\n  timestamp: number,\n  tokenAddress: string,\n  tokenId: string,\n) => {\n  // use plain JSON so the user can read what he's signing\n  // property names must always be in this order for signature to match so don't use JSON.stringify\n  return `{\"domainSeparator\":\"pkc-author-avatar\",\"authorAddress\":\"${authorAddress}\",\"timestamp\":${timestamp},\"tokenAddress\":\"${tokenAddress}\",\"tokenId\":\"${tokenId}\"}`;\n};\n\n// NOTE: verifyAuthorAvatarSignature tests are skipped, if changes are made they must be tested manually\nexport const verifyAuthorAvatarSignature = async (\n  nft: Nft,\n  authorAddress: string,\n  chainProviders: ChainProviders,\n) => {\n  assert(\n    nft && typeof nft === \"object\",\n    `verifyAuthorAvatarSignature invalid nft argument '${nft}'`,\n  );\n  assert(nft?.address, `verifyAuthorAvatarSignature invalid nft.address '${nft?.address}'`);\n  assert(\n    nft?.id && typeof nft?.id === \"string\",\n    `verifyAuthorAvatarSignature invalid nft.tokenAddress '${nft?.id}' not a string`,\n  );\n  assert(\n    typeof nft?.timestamp === \"number\",\n    `verifyAuthorAvatarSignature invalid nft.timestamp '${nft?.timestamp}' not a number`,\n  );\n  assert(nft?.signature, `verifyAuthorAvatarSignature invalid nft.signature '${nft?.signature}'`);\n  assert(\n    nft?.signature?.signature,\n    `verifyAuthorAvatarSignature invalid nft.signature.signature '${nft?.signature?.signature}'`,\n  );\n  assert(authorAddress, `verifyAuthorAvatarSignature invalid authorAddress '${authorAddress}'`);\n\n  // get the owner of the nft at nft.id\n  const currentNftOwnerAddress = await getNftOwner(\n    nft?.address,\n    nft?.id,\n    nft?.chainTicker,\n    chainProviders?.[nft?.chainTicker]?.urls?.[0],\n    chainProviders?.[nft?.chainTicker]?.chainId,\n  );\n\n  const messageThatShouldBeSigned = getNftMessageToSign(\n    authorAddress,\n    nft.timestamp,\n    nft.address,\n    nft.id,\n  );\n  const signatureAddress = ethers.utils.verifyMessage(\n    messageThatShouldBeSigned,\n    nft.signature.signature,\n  );\n\n  let verified = true;\n  if (currentNftOwnerAddress !== signatureAddress) {\n    verified = false;\n  }\n  return verified;\n};\n"]}

package/dist/hooks/authors/authors.d.ts

@@ -0,0 +1,37 @@
+import { UseAuthorOptions, UseAuthorResult, UseAuthorCommentsOptions, UseAuthorCommentsResult, UseAuthorAvatarOptions, UseAuthorAvatarResult, UseResolvedAuthorAddressOptions, UseResolvedAuthorAddressResult, UseAuthorAddressOptions, UseAuthorAddressResult } from "../../types.js";
+export { setAuthorAvatarsWhitelistedTokenAddresses } from "./author-avatars.js";
+/**
+ * @param authorAddress - The address of the author
+ * @param commentCid - The last known comment cid of the author (not possible to get an author without providing at least 1 comment cid)
+ * @param acountName - The nickname of the account, e.g. 'Account 1'. If no accountName is provided, use
+ * the active account.
+ */
+export declare function useAuthorComments(options?: UseAuthorCommentsOptions): UseAuthorCommentsResult;
+/**
+ * @param authorAddress - The address of the author
+ * @param commentCid - The last known comment cid of the author (not possible to get an author without providing at least 1 comment cid)
+ * @param acountName - The nickname of the account, e.g. 'Account 1'. If no accountName is provided, use
+ * the active account.
+ */
+export declare function useAuthor(options?: UseAuthorOptions): UseAuthorResult;
+/**
+ * @param author - The Author object to resolve the avatar image URL of.
+ * @param acountName - The nickname of the account, e.g. 'Account 1'. If no accountName is provided, use
+ * the active account.
+ */
+export declare function useAuthorAvatar(options?: UseAuthorAvatarOptions): UseAuthorAvatarResult;
+/**
+ * @param author - The Author object to resolve the address of.
+ * @param acountName - The nickname of the account, e.g. 'Account 1'. If no accountName is provided, use
+ * the active account.
+ */
+export declare function useAuthorAddress(options?: UseAuthorAddressOptions): UseAuthorAddressResult;
+/** For tests: reset caches to make resolution paths deterministic. */
+export declare function resetAuthorAddressCacheForTesting(): void;
+/**
+ * @param author - The author with author.address to resolve to a public key, e.g. 'john.eth' resolves to '12D3KooW...'.
+ * @param acountName - The nickname of the account, e.g. 'Account 1'. If no accountName is provided, use
+ * the active account.
+ */
+export declare function useResolvedAuthorAddress(options?: UseResolvedAuthorAddressOptions): UseResolvedAuthorAddressResult;
+//# sourceMappingURL=authors.d.ts.map

package/dist/hooks/authors/authors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"authors.d.ts","sourceRoot":"","sources":["../../../src/hooks/authors/authors.ts"],"names":[],"mappings":"AAMA,OAAO,EAGL,gBAAgB,EAChB,eAAe,EACf,wBAAwB,EACxB,uBAAuB,EACvB,sBAAsB,EACtB,qBAAqB,EACrB,+BAA+B,EAC/B,8BAA8B,EAC9B,uBAAuB,EACvB,sBAAsB,EACvB,MAAM,aAAa,CAAC;AAoBrB,OAAO,EAAE,yCAAyC,EAAE,MAAM,kBAAkB,CAAC;AAwB7E;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,CAAC,EAAE,wBAAwB,GAAG,uBAAuB,CAqF7F;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,eAAe,CA+DrE;AAED;;;;GAIG;AAEH,wBAAgB,eAAe,CAAC,OAAO,CAAC,EAAE,sBAAsB,GAAG,qBAAqB,CA4DvF;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,CAAC,EAAE,uBAAuB,GAAG,sBAAsB,CA4F1F;AAKD,sEAAsE;AACtE,wBAAgB,iCAAiC,SAKhD;AAED;;;;GAIG;AAEH,wBAAgB,wBAAwB,CACtC,OAAO,CAAC,EAAE,+BAA+B,GACxC,8BAA8B,CAmOhC"}