Skip to content

Commit fe01aef

Browse files
committed
docs: include some more details on how to retrieve certain values
TICKET: WP-6461
1 parent 04f0196 commit fe01aef

File tree

1 file changed

+26
-8
lines changed

1 file changed

+26
-8
lines changed

modules/express/src/typedRoutes/api/v2/isWalletAddress.ts

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,24 +36,42 @@ export const KeychainCodec = t.intersection([
3636
export const IsWalletAddressBody = {
3737
/** The address to verify */
3838
address: t.string,
39-
/** Keychains for verification */
39+
40+
/**
41+
* Keychains for cryptographic verification
42+
* Can be retrieved from GET /api/v2/{coin}/key/{id}
43+
*/
4044
keychains: t.array(KeychainCodec),
41-
/** Base address of the wallet */
45+
46+
/** Base address of the wallet (wallet.coinSpecific.baseAddress) */
4247
baseAddress: optional(t.string),
43-
/** Wallet version */
48+
49+
/** Wallet version (wallet.coinSpecific.walletVersion) */
4450
walletVersion: optional(t.number),
45-
/** Address index for TSS/MPC wallet derivation */
51+
52+
/**
53+
* Address derivation index
54+
* ForwarderAddress: address.index
55+
* BaseAddress: 0
56+
*/
4657
index: optional(t.union([t.number, t.string])),
4758
/** Coin-specific address data */
4859
coinSpecific: optional(
4960
t.partial({
50-
/** Forwarder version */
61+
/** Forwarder version (address.coinSpecific.forwarderVersion, required for forwarder addresses only) */
5162
forwarderVersion: t.number,
52-
/** Salt for CREATE2 address derivation */
63+
64+
/**
65+
* Salt for CREATE2 address derivation
66+
* ForwarderAddress: address.coinSpecific.salt
67+
* BaseAddress: wallet.coinSpecific.salt
68+
*/
5369
salt: t.string,
54-
/** Fee address for v4 forwarders */
70+
71+
/** Fee address for v4 forwarders (wallet.coinSpecific.feeAddress) */
5572
feeAddress: t.string,
56-
/** Base address (alternative to top-level baseAddress) */
73+
74+
/** Base address (wallet.coinSpecific.baseAddress) */
5775
baseAddress: t.string,
5876
})
5977
),

0 commit comments

Comments
 (0)