Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/thirdweb/src/auth/is-erc6492-signature.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import type { Hex } from "../utils/encoding/hex.js";
import { ERC_6492_MAGIC_VALUE } from "./constants.js";

/**
* @description Determines if a signature is compatible with [ERC6492](https://eips.ethereum.org/EIPS/eip-6492)
* Determines if a signature is compatible with [ERC6492](https://eips.ethereum.org/EIPS/eip-6492)
*
* @param {Hex} signature The signature to check for ERC6492 compatibility
*
Expand Down
2 changes: 1 addition & 1 deletion packages/thirdweb/src/auth/parse-erc6492-signature.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export type ParseErc6492SignatureReturnType = OneOf<
>;

/**
* @description Parses a serialized ({@link Hex}) [ERC-6492](https://eips.ethereum.org/EIPS/eip-6492) signature.
* Parses a serialized ({@link Hex}) [ERC-6492](https://eips.ethereum.org/EIPS/eip-6492) signature.
* If the signature is not in ERC-6492 format, the original signature is returned.
*
* @param {Hex} signature The signature to parse
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { ERC_6492_MAGIC_VALUE } from "./constants.js";
import type { Erc6492Signature } from "./types.js";

/**
* @description Serializes a signature for use with [ERC-6492](https://eips.ethereum.org/EIPS/eip-6492). The signature must be generated by a signer for an [ERC-4337](https://eips.ethereum.org/EIPS/eip-4337) Account Factory account with counterfactual deployment addresses.
* Serializes a signature for use with [ERC-6492](https://eips.ethereum.org/EIPS/eip-6492). The signature must be generated by a signer for an [ERC-4337](https://eips.ethereum.org/EIPS/eip-4337) Account Factory account with counterfactual deployment addresses.
*
* @param {@link Erc6492Signature} signature The signature object to serialize into Hex format
* @param {string} signature.address The ERC-4337 Account Factory address
Expand Down
2 changes: 1 addition & 1 deletion packages/thirdweb/src/auth/verify-hash.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ const ZKSYNC_VALIDATOR_ADDRESS: Address =
"0xfB688330379976DA81eB64Fe4BF50d7401763B9C";

/**
* @description Verify that an address created the provided signature for a given hash using [ERC-6492](https://eips.ethereum.org/EIPS/eip-6492). This function is interoperable with all wallet types, including EOAs.
* Verify that an address created the provided signature for a given hash using [ERC-6492](https://eips.ethereum.org/EIPS/eip-6492). This function is interoperable with all wallet types, including EOAs.
* This function should rarely be used directly, instead use @see {import("./verify-signature.js")} and @see {import("./verify-typed-data.js")}}
*
* @param {Hex} options.hash The hash that was signed
Expand Down
2 changes: 1 addition & 1 deletion packages/thirdweb/src/auth/verify-signature.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ export type VerifyContractWalletSignatureParams = Prettify<
>;

/**
* @description Verifies a contract wallet signature using [ERC-6942](https://eips.ethereum.org/EIPS/eip-6942) Signature Validation for Predeploy Contracts.
* Verifies a contract wallet signature using [ERC-6942](https://eips.ethereum.org/EIPS/eip-6942) Signature Validation for Predeploy Contracts.
* This function will validate signatures for both deployed and undeployed smart accounts of all signature types.
*
* @param {@link VerifyContractWalletSignatureParams} options - The parameters for verifying the signature.
Expand Down
4 changes: 2 additions & 2 deletions packages/thirdweb/src/auth/verify-typed-data.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export type VerifyTypedDataParams<
};

/**
* @description Verify am [EIP-712](https://eips.ethereum.org/EIPS/eip-712) typed data signature. This function is interoperable with all wallet types (smart accounts or EOAs).
* Verify am [EIP-712](https://eips.ethereum.org/EIPS/eip-712) typed data signature. This function is interoperable with all wallet types (smart accounts or EOAs).
*
* @param {string} options.address The address that signed the typed data
* @param {string | Uint8Array | Signature} options.signature The signature that was signed
Expand All @@ -38,7 +38,7 @@ export type VerifyTypedDataParams<
* @param {typeof VerifyTypedDataParams.types} options.types The EIP-712 types that were signed.
*
* @returns {Promise<boolean>} A promise that resolves to `true` if the signature is valid, or `false` otherwise.
*
*
* @example
* ```ts
* import { verifyTypedData } from "thirdweb/utils";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { getFid } from "../read/getFid.js";

/**
* Represents the parameters for the `addSigner` function.
* @description
*
* This function can be used wither be provided pre-generated signatures or the wallet accounts directly.
* This is done so the helpers can be used when there's no direct access to the account, but signatures can be generated (e.g. engine)
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { getFid } from "../read/getFid.js";

/**
* Represents the parameters for the `addSignerFor` function.
* @description
*
* This function can be used wither be provided pre-generated signatures or the wallet accounts directly.
* This is done so the helpers can be used when there's no direct access to the account, but signatures can be generated (e.g. engine)
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { getFid } from "../read/getFid.js";

/**
* Represents the parameters for the `registerFidAndSigner` function.
* @description
*
* This function can be used wither be provided pre-generated signatures or the wallet accounts directly.
* This is done so the helpers can be used when there's no direct access to the account, but signatures can be generated (e.g. engine)
*
Expand Down
2 changes: 1 addition & 1 deletion packages/thirdweb/src/storage/download.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export type DownloadOptions = Prettify<
>;

/**
* @description Downloads a file from the specified IPFS, Arweave, or HTTP URI.
* Downloads a file from the specified IPFS, Arweave, or HTTP URI.
*
* `download` will parse the provided URI based on its scheme (ipfs://, ar://, https://) and convert it to a URL to fetch the file from thirdweb's storage service.
*
Expand Down
4 changes: 2 additions & 2 deletions packages/thirdweb/src/utils/type-utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export type Filter<
: readonly [...Acc];

/**
* @description Makes attributes on the type T required if TRequired is true.
* Makes attributes on the type T required if TRequired is true.
* @example
* MaybeRequired<{ a: string, b?: number }, true>
* => { a: string, b: number }
Expand All @@ -31,7 +31,7 @@ export type MaybeRequired<T, TRequired extends boolean> = TRequired extends true
: T;

/**
* @description Combines members of an intersection into a readable type.
* Combines members of an intersection into a readable type.
* @see {@link https://twitter.com/mattpocockuk/status/1622730173446557697?s=20&t=NdpAcmEFXY01xkqU3KO0Mg}
* @example
* Prettify<{ a: string } & { b: string } & { c: number, d: bigint }>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ import type { ClientScopedStorage } from "./client-scoped-storage.js";
import type { Profile } from "./types.js";

/**
* @description
* Links a new account to the current one using an auth token.
* For the public-facing API, use `wallet.linkProfile` instead.
*
Expand Down Expand Up @@ -58,7 +57,6 @@ export async function linkAccount({
}

/**
* @description
* Links a new account to the current one using an auth token.
* For the public-facing API, use `wallet.linkProfile` instead.
*
Expand Down Expand Up @@ -107,7 +105,6 @@ export async function unlinkAccount({
}

/**
* @description
* Gets the linked accounts for the current user.
* For the public-facing API, use `wallet.getProfiles` instead.
*
Expand Down
Loading