Jg type comments (#1469)
* Add some field-level comments on the keyring * CHANGELOG
This commit is contained in:
@@ -5,7 +5,13 @@ import type { HexString } from '@polkadot/util/types';
|
||||
import type { EncryptedJson, Keypair, KeypairType, Prefix } from '@polkadot/util-crypto/types';
|
||||
|
||||
export interface KeyringOptions {
|
||||
/**
|
||||
* @description The ss58Format to use for address encoding (defaults to 42)
|
||||
*/
|
||||
ss58Format?: Prefix;
|
||||
/**
|
||||
* @description The type of keyring to create (defaults to ed25519)
|
||||
*/
|
||||
type?: KeypairType;
|
||||
}
|
||||
|
||||
@@ -17,6 +23,9 @@ export interface KeyringPair$Json extends EncryptedJson {
|
||||
}
|
||||
|
||||
export interface SignOptions {
|
||||
/**
|
||||
* @description Create a MultiSignature-compatible output with an indicator type
|
||||
**/
|
||||
withType?: boolean;
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user