aboutsummaryrefslogtreecommitdiff
path: root/src/modules
diff options
context:
space:
mode:
authorST-DDT <[email protected]>2022-12-10 20:36:58 +0100
committerGitHub <[email protected]>2022-12-10 20:36:58 +0100
commit9a1226172fe23aa763c14f5488131373548bba21 (patch)
tree680aa875cfab133f2433c7a882f63979e152e351 /src/modules
parent7b50c2f0126ac865d4e4efea360b8ba71f0cb7c6 (diff)
downloadfaker-9a1226172fe23aa763c14f5488131373548bba21.tar.xz
faker-9a1226172fe23aa763c14f5488131373548bba21.zip
docs(finance): ethereumAddress returns non checksummed addresses (#1650)
Diffstat (limited to 'src/modules')
-rw-r--r--src/modules/finance/index.ts4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/modules/finance/index.ts b/src/modules/finance/index.ts
index e6533e50..9c34faa2 100644
--- a/src/modules/finance/index.ts
+++ b/src/modules/finance/index.ts
@@ -342,7 +342,9 @@ export class FinanceModule {
}
/**
- * Generates a random Ethereum address.
+ * Creates a random, non-checksum Ethereum address.
+ *
+ * To generate a checksummed Ethereum address (with specific per character casing), wrap this method in a custom method and use third-party libraries to transform the result.
*
* @example
* faker.finance.ethereumAddress() // '0xf03dfeecbafc5147241cc4c4ca20b3c9dfd04c4a'