From 3b68781a145cd16c4e59ea2ceaf46980094fbdbe Mon Sep 17 00:00:00 2001 From: Omar Khan Date: Wed, 15 Jun 2022 16:55:46 -0400 Subject: [PATCH] add jsdoc to SignerEntry --- packages/xrpl/src/models/common/index.ts | 20 +++++++++++++++++++ .../src/models/transactions/signerListSet.ts | 2 +- 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/packages/xrpl/src/models/common/index.ts b/packages/xrpl/src/models/common/index.ts index bad634b3..cd68d760 100644 --- a/packages/xrpl/src/models/common/index.ts +++ b/packages/xrpl/src/models/common/index.ts @@ -61,10 +61,30 @@ interface PathStep { export type Path = PathStep[] +/** + * The object that describes the signer in SignerEntries. + */ export interface SignerEntry { + /** + * The object that describes the signer in SignerEntries. + */ SignerEntry: { + /** + * An XRP Ledger address whose signature contributes to the multi-signature. + * It does not need to be a funded address in the ledger. + */ Account: string + /** + * The weight of a signature from this signer. + * A multi-signature is only valid if the sum weight of the signatures provided meets + * or exceeds the signer list's SignerQuorum value. + */ SignerWeight: number + /** + * An arbitrary 256-bit (32-byte) field that can be used to identify the signer, which + * may be useful for smart contracts, or for identifying who controls a key in a large + * organization. + */ WalletLocator?: string } } diff --git a/packages/xrpl/src/models/transactions/signerListSet.ts b/packages/xrpl/src/models/transactions/signerListSet.ts index 786a51e5..3aaaccbd 100644 --- a/packages/xrpl/src/models/transactions/signerListSet.ts +++ b/packages/xrpl/src/models/transactions/signerListSet.ts @@ -20,7 +20,7 @@ export interface SignerListSet extends BaseTransaction { /** * Array of SignerEntry objects, indicating the addresses and weights of * signers in this list. This signer list must have at least 1 member and no - * more than 8 members. No address may appear more than once in the list, nor + * more than 32 members. No address may appear more than once in the list, nor * may the Account submitting the transaction appear in the list. */ SignerEntries: SignerEntry[]