diff --git a/docs/tweaks/returns.hbs b/docs/tweaks/returns.hbs index 41667ca37..0026b6f49 100644 --- a/docs/tweaks/returns.hbs +++ b/docs/tweaks/returns.hbs @@ -1,12 +1,11 @@ {{#if returns}} -{{#if returns.[0].description~}} -**Returnsssss**: {{#each returns~}} +**Returns**: {{#each returns~}} {{#if type~}} {{#if type.names}}{{>linked-type-list types=type.names delimiter=" \| " ~}}{{/if}} - {{~#if description}} -

`{{{stripTags (inlineLinks description)}}}`

{{/if~}} + {{~#if description}} - {{{inlineLinks description}}}{{/if~}} {{else~}} {{{inlineLinks description}~}} {{/if~}} {{~/each}} -{{/if}}{{/if}} \ No newline at end of file +{{/if}} diff --git a/modules/client-common/src/encoding.ts b/modules/client-common/src/encoding.ts index ec73ef207..76947dcda 100644 --- a/modules/client-common/src/encoding.ts +++ b/modules/client-common/src/encoding.ts @@ -15,7 +15,7 @@ import { * * @export * @param {string} value - * @return {*} {string} + * @return {string} */ export function ensure0x(value: string): string { return value.startsWith("0x") ? value : "0x" + value; @@ -26,7 +26,7 @@ export function ensure0x(value: string): string { * * @export * @param {string} value - * @return {*} {string} + * @return {string} */ export function strip0x(value: string): string { return value.startsWith("0x") ? value.substring(2) : value; @@ -37,7 +37,7 @@ export function strip0x(value: string): string { * * @export * @param {string} hexString - * @return {*} {Uint8Array} + * @return {Uint8Array} */ export function hexToBytes(hexString: string): Uint8Array { if (!hexString) return new Uint8Array(); @@ -63,7 +63,7 @@ export function hexToBytes(hexString: string): Uint8Array { * @export * @param {Uint8Array} buff * @param {boolean} [skip0x] - * @return {*} {string} + * @return {string} */ export function bytesToHex(buff: Uint8Array, skip0x?: boolean): string { const bytes: string[] = []; @@ -81,7 +81,7 @@ export function bytesToHex(buff: Uint8Array, skip0x?: boolean): string { * @export * @param {number} ratio * @param {number} digits - * @return {*} {bigint} + * @return {bigint} */ export function encodeRatio(ratio: number, digits: number): number { if (ratio < 0 || ratio > 1) { @@ -98,7 +98,7 @@ export function encodeRatio(ratio: number, digits: number): number { * @export * @param {bigint} onChainValue * @param {number} digits - * @return {*} {number} + * @return {number} */ export function decodeRatio( onChainValue: bigint | number, @@ -119,7 +119,7 @@ export function decodeRatio( * @export * @param {string} pluginAddress * @param {number} id - * @return {*} + * @return */ export function encodeProposalId(pluginAddress: string, id: number) { if (!/^0x[A-Fa-f0-9]{40}$/.test(pluginAddress)) { @@ -134,11 +134,11 @@ export function encodeProposalId(pluginAddress: string, id: number) { * * @export * @param {string} proposalId - * @return {*} {{ pluginAddress: string; id: number }} + * @return {{ pluginAddress: string; id: number }} */ export function decodeProposalId( proposalId: string, -): { pluginAddress: string; id: number } { +): { pluginAddress: string; id: number } params if (!isProposalId(proposalId)) { throw new InvalidProposalIdError(); } @@ -159,7 +159,7 @@ export function decodeProposalId( * * @export * @param {Array} [bools] - * @return {*} + * @return */ export function boolArrayToBitmap(bools?: Array) { if (!bools || !bools.length) return BigInt(0); @@ -178,7 +178,7 @@ export function boolArrayToBitmap(bools?: Array) { * Transforms a bigint into an array of booleans * * @param {bigint} bitmap - * @return {*} {Array} + * @return {Array} */ export function bitmapToBoolArray(bitmap: bigint): Array { if (bitmap >= (BigInt(1) << BigInt(256))) { @@ -199,7 +199,7 @@ export function bitmapToBoolArray(bitmap: bigint): Array { * * @export * @param {string} proposalId - * @returns {*} {string} + * @returns {string} */ export const getExtendedProposalId = (proposalId: string): string => { if (!isProposalId(proposalId)) { @@ -214,7 +214,7 @@ export const getExtendedProposalId = (proposalId: string): string => { * * @export * @param {string} proposalId - * @returns {*} {string} + * @returns {string} */ export const getCompactProposalId = (proposalId: string): string => { if (!proposalId.match(/^(0x[A-Fa-f0-9]{40})_(0x[A-Fa-f0-9]{1,64})$/)) { diff --git a/modules/client-common/src/promises.ts b/modules/client-common/src/promises.ts index 89f6502c0..60ad105de 100644 --- a/modules/client-common/src/promises.ts +++ b/modules/client-common/src/promises.ts @@ -12,7 +12,7 @@ import { * @param {Promise} prom The promise to track * @param {number} timeout Timeout (in milliseconds) to wait before failing * @param {string} [timeoutMessage] (optional) Message to use when throwing a timeout error. By default: `"Time out"` - * @return {*} {Promise} + * @return {Promise} */ export function promiseWithTimeout( prom: Promise, @@ -46,8 +46,8 @@ export function promiseWithTimeout( * func: () => Promise; * onFail?: (e: Error) => void; * shouldRetry: () => boolean; - * }} { func, onFail, shouldRetry } - * @return {*} + * }} params func, onFail, shouldRetry } + * @return */ export async function runAndRetry({ func, onFail, shouldRetry }: { func: () => Promise; diff --git a/modules/client-common/src/utils.ts b/modules/client-common/src/utils.ts index fa80e8e79..c1c96b53d 100644 --- a/modules/client-common/src/utils.ts +++ b/modules/client-common/src/utils.ts @@ -51,7 +51,7 @@ import { Zero } from "@ethersproject/constants"; * @param {ContractReceipt} receipt * @param {Interface} iface * @param {string} eventName - * @return {*} {(Log | undefined)} + * @return {(Log | undefined)} */ export function findLog( receipt: ContractReceipt, @@ -75,7 +75,7 @@ export function findLog( * @export * @param {Uint8Array} data * @param {string[]} availableFunctions - * @return {*} {FunctionFragment} + * @return {FunctionFragment} */ export function getFunctionFragment( data: Uint8Array, @@ -91,7 +91,7 @@ export function getFunctionFragment( * * @export * @param {MetadataAbiInput[]} [inputs=[]] - * @return {*} {string[]} + * @return {string[]} */ export function getNamedTypesFromMetadata( inputs: MetadataAbiInput[] = [], @@ -124,7 +124,7 @@ export function getNamedTypesFromMetadata( * @export * @param {IClientWeb3Core} web3 * @param {PrepareInstallationParams} params - * @return {*} + * @return */ export async function prepareGenericInstallationEstimation( web3: IClientWeb3Core, @@ -180,7 +180,7 @@ export async function prepareGenericInstallationEstimation( * @export * @param {IClientWeb3Core} web3 * @param {(PrepareInstallationParams & { pluginSetupProcessorAddress: string })} params - * @return {*} {AsyncGenerator} + * @return {AsyncGenerator} */ export async function* prepareGenericInstallation( web3: IClientWeb3Core, @@ -259,7 +259,7 @@ export async function* prepareGenericInstallation( * * @param {IClientGraphQLCore} graphql * @param {PrepareUpdateParams} params - * @return {*} {Promise} + * @return {Promise} */ async function getPrepareUpdateParams( graphql: IClientGraphQLCore, @@ -319,7 +319,7 @@ async function getPrepareUpdateParams( * @param {IClientWeb3Core} web3 * @param {IClientGraphQLCore} graphql * @param {(PrepareUpdateParams & { pluginSetupProcessorAddress: string })} params - * @return {*} {Promise} + * @return {Promise} */ export async function prepareGenericUpdateEstimation( web3: IClientWeb3Core, @@ -401,7 +401,7 @@ export async function* prepareGenericUpdate( * * @export * @param {Networkish} networkish - * @return {*} {Network} + * @return {Network} */ export function getNetwork(networkish: Networkish): Network { let network: Network | undefined; @@ -437,7 +437,7 @@ export function getNetwork(networkish: Networkish): Network { * * @export * @param {Interface} iface - * @return {*} {string} + * @return {string} */ export function getInterfaceId(iface: Interface): string { let interfaceId = Zero; diff --git a/modules/client-common/src/validation.ts b/modules/client-common/src/validation.ts index cef1b3f8d..226acc373 100644 --- a/modules/client-common/src/validation.ts +++ b/modules/client-common/src/validation.ts @@ -13,7 +13,7 @@ import { MultiUri } from "./multiuri"; * * @export * @param {string} data - * @return {*} {string} + * @return {string} */ export function resolveIpfsCid(data: string): string { const uri = new MultiUri(data); @@ -29,7 +29,7 @@ export function resolveIpfsCid(data: string): string { * * @export * @param {string} proposalId - * @return {*} {boolean} + * @return {boolean} */ export function isProposalId(proposalId: string): boolean { const regex = new RegExp(OSX_PROPOSAL_ID_REGEX); @@ -41,7 +41,7 @@ export function isProposalId(proposalId: string): boolean { * * @export * @param {string} name - * @return {*} {boolean} + * @return {boolean} */ export function isEnsName(name: string): boolean { const regex = new RegExp(ENS_REGEX); @@ -53,7 +53,7 @@ export function isEnsName(name: string): boolean { * * @export * @param {string} cid - * @return {*} {boolean} + * @return {boolean} */ export function isIpfsUri(cid: string): boolean { const regex = new RegExp( @@ -67,7 +67,7 @@ export function isIpfsUri(cid: string): boolean { * * @export * @param {string} name - * @return {*} {boolean} + * @return {boolean} */ export function isSubdomain(name: string): boolean { const regex = new RegExp(SUBDOMAIN_REGEX); diff --git a/modules/client/src/addresslistVoting/client.ts b/modules/client/src/addresslistVoting/client.ts index de70d1d30..d874b8fa3 100644 --- a/modules/client/src/addresslistVoting/client.ts +++ b/modules/client/src/addresslistVoting/client.ts @@ -42,7 +42,7 @@ export class AddresslistVotingClient extends ClientCore * * @param {AddresslistVotingPluginInstall} params * @param {Networkish} [network="mainnet"] - * @return {*} {PluginInstallItem} + * @return {PluginInstallItem} * @memberof AddresslistVotingClient */ getPluginInstallItem: ( diff --git a/modules/client/src/addresslistVoting/internal/client/decoding.ts b/modules/client/src/addresslistVoting/internal/client/decoding.ts index b69fa3c36..1a0fa64b8 100644 --- a/modules/client/src/addresslistVoting/internal/client/decoding.ts +++ b/modules/client/src/addresslistVoting/internal/client/decoding.ts @@ -21,7 +21,7 @@ export class AddresslistVotingClientDecoding extends ClientCore * Decodes a dao metadata from an encoded update metadata action * * @param {Uint8Array} data - * @return {*} {VotingSettings} + * @return {VotingSettings} * @memberof AddresslistVotingClientDecoding */ public updatePluginSettingsAction(data: Uint8Array): VotingSettings { @@ -31,7 +31,7 @@ export class AddresslistVotingClientDecoding extends ClientCore * Decodes a list of addresses from an encoded add members action * * @param {Uint8Array} data - * @return {*} {string[]} + * @return {string[]} * @memberof AddresslistVotingClientDecoding */ public addMembersAction(data: Uint8Array): string[] { @@ -48,7 +48,7 @@ export class AddresslistVotingClientDecoding extends ClientCore * Decodes a list of addresses from an encoded remove members action * * @param {Uint8Array} data - * @return {*} {string[]} + * @return {string[]} * @memberof AddresslistVotingClientDecoding */ public removeMembersAction(data: Uint8Array): string[] { @@ -67,7 +67,7 @@ export class AddresslistVotingClientDecoding extends ClientCore * Returns the decoded function info given the encoded data of an action * * @param {Uint8Array} data - * @return {*} {(InterfaceParams | null)} + * @return {(InterfaceParams | null)} * @memberof AddresslistVotingClientDecoding */ public findInterface(data: Uint8Array): InterfaceParams | null { diff --git a/modules/client/src/addresslistVoting/internal/client/encoding.ts b/modules/client/src/addresslistVoting/internal/client/encoding.ts index 78939865a..d0c24691c 100644 --- a/modules/client/src/addresslistVoting/internal/client/encoding.ts +++ b/modules/client/src/addresslistVoting/internal/client/encoding.ts @@ -36,7 +36,7 @@ export class AddresslistVotingClientEncoding extends ClientCore * * @param {AddresslistVotingPluginInstall} params * @param {Networkish} network - * @return {*} {PluginInstallItem} + * @return {PluginInstallItem} * @memberof AddresslistVotingClientEncoding */ static getPluginInstallItem( @@ -67,7 +67,7 @@ export class AddresslistVotingClientEncoding extends ClientCore * * @param {string} pluginAddress * @param {VotingSettings} params - * @return {*} {DaoAction} + * @return {DaoAction} * @memberof AddresslistVotingClientEncoding */ public updatePluginSettingsAction( @@ -89,7 +89,7 @@ export class AddresslistVotingClientEncoding extends ClientCore * * @param {string} pluginAddress * @param {string[]} members - * @return {*} {DaoAction} + * @return {DaoAction} * @memberof AddresslistVotingClientEncoding */ public addMembersAction(pluginAddress: string, members: string[]): DaoAction { @@ -118,7 +118,7 @@ export class AddresslistVotingClientEncoding extends ClientCore * * @param {string} pluginAddress * @param {string[]} members - * @return {*} {DaoAction} + * @return {DaoAction} * @memberof AddresslistVotingClientEncoding */ public removeMembersAction( diff --git a/modules/client/src/addresslistVoting/internal/client/estimation.ts b/modules/client/src/addresslistVoting/internal/client/estimation.ts index 975a1b71e..371bf3fcc 100644 --- a/modules/client/src/addresslistVoting/internal/client/estimation.ts +++ b/modules/client/src/addresslistVoting/internal/client/estimation.ts @@ -24,7 +24,7 @@ export class AddresslistVotingClientEstimation extends ClientCore * Estimates the gas fee of creating a proposal on the plugin * * @param {CreateMajorityVotingProposalParams} params - * @return {*} {Promise} + * @return {Promise} * @memberof AddresslistVotingClientEstimation */ public async createProposal( @@ -65,7 +65,7 @@ export class AddresslistVotingClientEstimation extends ClientCore * Estimates the gas fee of casting a vote on a proposal * * @param {VoteProposalParams} params - * @return {*} {Promise} + * @return {Promise} * @memberof AddresslistVotingClientEstimation */ public async voteProposal( @@ -94,7 +94,7 @@ export class AddresslistVotingClientEstimation extends ClientCore * Estimates the gas fee of executing an AddressList proposal * * @param {string} proposalId - * @return {*} {Promise} + * @return {Promise} * @memberof AddresslistVotingClientEstimation */ public async executeProposal( @@ -119,7 +119,7 @@ export class AddresslistVotingClientEstimation extends ClientCore * Estimates the gas fee of preparing an update * * @param {AddresslistVotingPluginPrepareUpdateParams} params - * @return {*} {Promise} + * @return {Promise} * @memberof AddresslistVotingClientEstimation */ public async prepareUpdate( diff --git a/modules/client/src/addresslistVoting/internal/client/methods.ts b/modules/client/src/addresslistVoting/internal/client/methods.ts index 51da1d897..e83b9e4db 100644 --- a/modules/client/src/addresslistVoting/internal/client/methods.ts +++ b/modules/client/src/addresslistVoting/internal/client/methods.ts @@ -89,7 +89,7 @@ export class AddresslistVotingClientMethods extends ClientCore * Creates a new proposal on the given AddressList plugin contract * * @param {CreateMajorityVotingProposalParams} params - * @return {*} {AsyncGenerator} + * @return {AsyncGenerator} * @memberof AddresslistVotingClientMethods */ public async *createProposal( @@ -164,7 +164,7 @@ export class AddresslistVotingClientMethods extends ClientCore * Pins a metadata object into IPFS and retruns the generated hash * * @param {ProposalMetadata} params - * @return {*} {Promise} + * @return {Promise} * @memberof ClientMethods */ public async pinMetadata(params: ProposalMetadata): Promise { @@ -180,7 +180,7 @@ export class AddresslistVotingClientMethods extends ClientCore * Cast a vote on the given proposal using the client's wallet. Depending on the proposal settings, an affirmative vote may execute the proposal's actions on the DAO. * * @param {VoteProposalParams} params - * @return {*} {AsyncGenerator} + * @return {AsyncGenerator} * @memberof AddresslistVotingClientMethods */ public async *voteProposal( @@ -217,7 +217,7 @@ export class AddresslistVotingClientMethods extends ClientCore * Executes the given proposal, provided that it has already passed * * @param {string} proposalId - * @return {*} {AsyncGenerator} + * @return {AsyncGenerator} * @memberof AddresslistVotingClientMethods */ public async *executeProposal( @@ -246,7 +246,7 @@ export class AddresslistVotingClientMethods extends ClientCore * Prepares the installation of a token voting plugin in a given dao * * @param {AddresslistVotingPluginPrepareInstallationParams} params - * @return {*} {AsyncGenerator} + * @return {AsyncGenerator} * @memberof MultisigClientMethods */ public async *prepareInstallation( @@ -275,7 +275,7 @@ export class AddresslistVotingClientMethods extends ClientCore * Prepares the update of a token voting plugin in a given dao * * @param {AddresslistVotingPluginPrepareUpdateParams} params - * @return {*} {AsyncGenerator} + * @return {AsyncGenerator} * @memberof AddresslistVotingClientMethods */ public async *prepareUpdate( @@ -296,7 +296,7 @@ export class AddresslistVotingClientMethods extends ClientCore * Checks if an user can vote in a proposal * * @param {CanVoteParams} params - * @return {*} {Promise} + * @return {Promise} * @memberof AddresslistVotingClientMethods */ public async canVote(params: CanVoteParams): Promise { @@ -318,7 +318,7 @@ export class AddresslistVotingClientMethods extends ClientCore * Checks whether the current proposal can be executed * * @param {string} proposalId - * @return {*} {Promise} + * @return {Promise} * @memberof AddresslistVotingClientMethods */ public async canExecute( @@ -338,15 +338,14 @@ export class AddresslistVotingClientMethods extends ClientCore /** * Returns the list of wallet addresses with signing capabilities on the plugin * - * @param {MembersQueryParams} { + * @param {MembersQueryParams} params * pluginAddress, * blockNumber, * limit = 10, * skip = 0, * direction = SortDirection.ASC, - * sortBy = MembersSortBy.ADDRESS, - * } - * @return {*} {Promise} + * sortBy = MembersSortBy.ADDRESS + * @return {Promise} * @memberof AddresslistVotingClientMethods */ public async getMembers({ @@ -384,7 +383,7 @@ export class AddresslistVotingClientMethods extends ClientCore * Returns the details of the given proposal * * @param {string} proposalId - * @return {*} {(Promise)} + * @return {(Promise)} * @memberof AddresslistVotingClientMethods */ public async getProposal( @@ -436,15 +435,14 @@ export class AddresslistVotingClientMethods extends ClientCore /** * Returns a list of proposals on the Plugin, filtered by the given criteria * - * @param {ProposalQueryParams} { + * @param {ProposalQueryParams} params * daoAddressOrEns, * limit = 10, * status, * skip = 0, * direction = SortDirection.ASC, - * sortBy = ProposalSortBy.CREATED_AT, - * } - * @return {*} {Promise} + * sortBy = ProposalSortBy.CREATED_AT + * @return {Promise} * @memberof AddresslistVotingClientMethods */ public async getProposals({ @@ -540,7 +538,7 @@ export class AddresslistVotingClientMethods extends ClientCore * * @param {string} pluginAddress * @param {number} blockNumber - * @return {*} {(Promise)} + * @return {(Promise)} * @memberof AddresslistVotingClientMethods */ public async getVotingSettings( diff --git a/modules/client/src/internal/client/decoding.ts b/modules/client/src/internal/client/decoding.ts index d4f43887f..1afff3dff 100644 --- a/modules/client/src/internal/client/decoding.ts +++ b/modules/client/src/internal/client/decoding.ts @@ -56,7 +56,7 @@ import { export class ClientDecoding extends ClientCore implements IClientDecoding { /** * @param {data} Uint8Array - * @return {*} {DecodedApplyInstallationParams} + * @return {DecodedApplyInstallationParams} * @memberof ClientDecoding */ public applyInstallationAction( @@ -71,7 +71,7 @@ export class ClientDecoding extends ClientCore implements IClientDecoding { } /** * @param {data} Uint8Array - * @return {*} {DecodedApplyInstallationParams} + * @return {DecodedApplyInstallationParams} * @memberof ClientDecoding */ public applyUninstallationAction( @@ -89,7 +89,7 @@ export class ClientDecoding extends ClientCore implements IClientDecoding { * Decodes the apply update parameters from an encoded apply update action * * @param {Uint8Array} data - * @return {*} {DecodedApplyUpdateParams} + * @return {DecodedApplyUpdateParams} * @memberof ClientDecoding */ public applyUpdateAction( @@ -102,7 +102,7 @@ export class ClientDecoding extends ClientCore implements IClientDecoding { * Decodes the permission parameters from an encoded grant action * * @param {Uint8Array} data - * @return {*} {GrantPermissionDecodedParams} + * @return {GrantPermissionDecodedParams} * @memberof ClientDecoding */ public grantAction(data: Uint8Array): GrantPermissionDecodedParams { @@ -113,7 +113,7 @@ export class ClientDecoding extends ClientCore implements IClientDecoding { * Decodes the grant permission with condition parameters from an encoded grant with condition action * * @param {Uint8Array} data - * @return {*} {GrantPermissionWithConditionParams} + * @return {GrantPermissionWithConditionParams} * @memberof ClientDecoding */ public grantWithConditionAction( @@ -130,7 +130,7 @@ export class ClientDecoding extends ClientCore implements IClientDecoding { * Decodes the permission parameters from an encoded revoke action * * @param {Uint8Array} data - * @return {*} {RevokePermissionDecodedParams} + * @return {RevokePermissionDecodedParams} * @memberof ClientDecoding */ public revokeAction(data: Uint8Array): RevokePermissionDecodedParams { @@ -145,7 +145,7 @@ export class ClientDecoding extends ClientCore implements IClientDecoding { * Decodes the withdraw parameters from an encoded withdraw action * * @param {Uint8Array} data - * @return {*} {WithdrawParams} + * @return {WithdrawParams} * @memberof ClientDecoding */ public withdrawAction( @@ -216,7 +216,7 @@ export class ClientDecoding extends ClientCore implements IClientDecoding { * Decodes a dao metadata ipfs uri from an encoded update metadata action * * @param {Uint8Array} data - * @return {*} {string} + * @return {string} * @memberof ClientDecoding */ public updateDaoMetadataRawAction(data: Uint8Array): string { @@ -233,7 +233,7 @@ export class ClientDecoding extends ClientCore implements IClientDecoding { * Decodes a dao metadata from an encoded update metadata raw action * * @param {Uint8Array} data - * @return {*} {Promise} + * @return {Promise} * @memberof ClientDecoding */ public async updateDaoMetadataAction(data: Uint8Array): Promise { @@ -255,7 +255,7 @@ export class ClientDecoding extends ClientCore implements IClientDecoding { * Decodes the daoUri from a setDaoUriAction * * @param {Uint8Array} data - * @return {*} {string} + * @return {string} * @memberof ClientDecoding */ public setDaoUriAction(data: Uint8Array): string { @@ -270,7 +270,7 @@ export class ClientDecoding extends ClientCore implements IClientDecoding { * Decodes the RegisterStandardCallbackParams from a registerStandardCallbackAction * * @param {Uint8Array} data - * @return {*} {RegisterStandardCallbackParams} + * @return {RegisterStandardCallbackParams} * @memberof ClientDecoding */ public registerStandardCallbackAction( @@ -293,7 +293,7 @@ export class ClientDecoding extends ClientCore implements IClientDecoding { * Decodes the implementation address from an encoded upgradeToAction * * @param {Uint8Array} data - * @return {*} {string} + * @return {string} * @memberof ClientDecoding */ public setSignatureValidatorAction( @@ -315,7 +315,7 @@ export class ClientDecoding extends ClientCore implements IClientDecoding { * Decodes upgradeToAndCallback params from an upgradeToAndCallAction * * @param {Uint8Array} data - * @return {*} {UpgradeToAndCallParams} + * @return {UpgradeToAndCallParams} * @memberof ClientDecoding */ public upgradeToAndCallAction( @@ -329,7 +329,7 @@ export class ClientDecoding extends ClientCore implements IClientDecoding { * Decodes the initializeFrom params from an initializeFromAction * * @param {Uint8Array} data - * @return {*} {InitializeFromParams} + * @return {InitializeFromParams} * @memberof ClientDecoding */ public initializeFromAction(data: Uint8Array): InitializeFromParams { @@ -341,7 +341,7 @@ export class ClientDecoding extends ClientCore implements IClientDecoding { * Returns the decoded function info given the encoded data of an action * * @param {Uint8Array} data - * @return {*} {(InterfaceParams | null)} + * @return {(InterfaceParams | null)} * @memberof ClientDecoding */ public findInterface(data: Uint8Array): InterfaceParams | null { @@ -353,7 +353,7 @@ export class ClientDecoding extends ClientCore implements IClientDecoding { * Decodes the dao update params from a daoUpdateAction * * @param {Uint8Array} data - * @return {*} {DaoUpdateDecodedParams} + * @return {DaoUpdateDecodedParams} * @memberof ClientDecoding */ public daoUpdateAction( diff --git a/modules/client/src/internal/client/encoding.ts b/modules/client/src/internal/client/encoding.ts index ab1b81148..feb3f4c1f 100644 --- a/modules/client/src/internal/client/encoding.ts +++ b/modules/client/src/internal/client/encoding.ts @@ -67,7 +67,7 @@ export class ClientEncoding extends ClientCore implements IClientEncoding { /** * @param {string} daoAddress * @param {ApplyInstallationParams} params - * @return {*} {DaoAction} + * @return {DaoAction} * @memberof ClientEncoding */ public applyInstallationAction( @@ -149,7 +149,7 @@ export class ClientEncoding extends ClientCore implements IClientEncoding { * * @param {string} daoAddress * @param {ApplyUpdateParams} params - * @return {*} {DaoAction[]} + * @return {DaoAction[]} * @memberof ClientEncoding */ public applyUpdateAndPermissionsActionBlock( @@ -218,7 +218,7 @@ export class ClientEncoding extends ClientCore implements IClientEncoding { * * @param {string} daoAddress * @param {GrantPermissionParams} params - * @return {*} {DaoAction} + * @return {DaoAction} * @memberof ClientEncoding */ public grantAction( @@ -254,7 +254,7 @@ export class ClientEncoding extends ClientCore implements IClientEncoding { * * @param {string} daoAddress * @param {GrantPermissionWithConditionParams} params - * @return {*} {DaoAction} + * @return {DaoAction} * @memberof ClientEncoding */ public grantWithConditionAction( @@ -294,7 +294,7 @@ export class ClientEncoding extends ClientCore implements IClientEncoding { * * @param {string} daoAddress * @param {RevokePermissionParams} params - * @return {*} {DaoAction} + * @return {DaoAction} * @memberof ClientEncoding */ public revokeAction( @@ -330,7 +330,7 @@ export class ClientEncoding extends ClientCore implements IClientEncoding { * * @param {string} recipientAddressOrEns * @param {WithdrawParams} value - * @return {*} {Promise} + * @return {Promise} * @memberof ClientEncoding */ public async withdrawAction(params: WithdrawParams): Promise { @@ -428,7 +428,7 @@ export class ClientEncoding extends ClientCore implements IClientEncoding { * * @param {string} daoAddressOrEns * @param {DaoMetadata} params - * @return {*} {Promise} + * @return {Promise} * @memberof ClientEncoding */ public async updateDaoMetadataAction( @@ -462,7 +462,7 @@ export class ClientEncoding extends ClientCore implements IClientEncoding { * * @param {string} daoAddressOrEns * @param {string} daoUri - * @return {*} {DaoAction} + * @return {DaoAction} * @memberof ClientEncoding */ public setDaoUriAction( @@ -485,7 +485,7 @@ export class ClientEncoding extends ClientCore implements IClientEncoding { * * @param {string} daoAddressOrEns * @param {string} daoUri - * @return {*} {DaoAction} + * @return {DaoAction} * @memberof ClientEncoding */ public registerStandardCallbackAction( @@ -510,7 +510,7 @@ export class ClientEncoding extends ClientCore implements IClientEncoding { * * @param {string} daoAddressOrEns * @param {string} signatureValidator - * @return {*} {DaoAction} + * @return {DaoAction} * @memberof ClientEncoding */ public setSignatureValidatorAction( @@ -534,7 +534,7 @@ export class ClientEncoding extends ClientCore implements IClientEncoding { * * @param {string} daoAddressOrEns * @param {string} implementationAddress - * @return {*} {DaoAction} + * @return {DaoAction} * @memberof ClientEncoding */ public upgradeToAction( @@ -558,7 +558,7 @@ export class ClientEncoding extends ClientCore implements IClientEncoding { * * @param {string} daoAddressOrEns * @param {UpgradeToAndCallParams} params - * @return {*} {DaoAction} + * @return {DaoAction} * @memberof ClientEncoding */ public upgradeToAndCallAction( @@ -584,7 +584,7 @@ export class ClientEncoding extends ClientCore implements IClientEncoding { * * @param {string} daoAddressOrEns * @param {InitializeFromParams} params - * @return {*} + * @return {DaoAction} * @memberof ClientEncoding */ public initializeFromAction( @@ -610,7 +610,7 @@ export class ClientEncoding extends ClientCore implements IClientEncoding { * * @param {string} daoAddressOrEns * @param {DaoUpdateParams} params - * @return {*} + * @return {Promise} * @memberof ClientEncoding */ public async daoUpdateAction( diff --git a/modules/client/src/internal/client/estimation.ts b/modules/client/src/internal/client/estimation.ts index c24f089cb..d966fbd16 100644 --- a/modules/client/src/internal/client/estimation.ts +++ b/modules/client/src/internal/client/estimation.ts @@ -57,7 +57,7 @@ export class ClientEstimation extends ClientCore implements IClientEstimation { * Estimates the gas fee of creating a DAO * * @param {CreateDaoParams} _params - * @return {*} {Promise} + * @return {Promise} * @memberof ClientEstimation */ public async createDao(params: CreateDaoParams): Promise { @@ -102,7 +102,7 @@ export class ClientEstimation extends ClientCore implements IClientEstimation { * This does not estimate the gas cost of updating the allowance of an ERC20 token * * @param {DepositParams} params - * @return {*} {Promise} + * @return {Promise} * @memberof ClientEstimation */ public async deposit( @@ -139,7 +139,7 @@ export class ClientEstimation extends ClientCore implements IClientEstimation { * Estimates the gas fee of updating the allowance of an ERC20 token * * @param {SetAllowanceParams} _params - * @return {*} {Promise} + * @return {Promise} * @memberof ClientEstimation */ public async setAllowance( @@ -178,7 +178,7 @@ export class ClientEstimation extends ClientCore implements IClientEstimation { * Estimates the gas fee of preparing an update * * @param {PrepareUpdateParams} params - * @return {*} {Promise} + * @return {Promise} * @memberof ClientEstimation */ public async prepareUpdate( diff --git a/modules/client/src/internal/client/methods.ts b/modules/client/src/internal/client/methods.ts index 6cabd100a..a837d0a0f 100644 --- a/modules/client/src/internal/client/methods.ts +++ b/modules/client/src/internal/client/methods.ts @@ -181,7 +181,7 @@ export class ClientMethods extends ClientCore implements IClientMethods { * Creates a DAO with the given settings and plugins * @param {CreateDaoParams} params - * @return {*} {AsyncGenerator} + * @return {AsyncGenerator} * @memberof ClientMethods */ public async *createDao( @@ -297,7 +297,7 @@ export class ClientMethods extends ClientCore implements IClientMethods { * Pins a metadata object into IPFS and retruns the generated hash * * @param {DaoMetadata} params - * @return {*} {Promise} + * @return {Promise} * @memberof ClientMethods */ public async pinMetadata(params: DaoMetadata): Promise { @@ -314,7 +314,7 @@ export class ClientMethods extends ClientCore implements IClientMethods { * Deposits ether or an ERC20 token into the DAO * * @param {DepositParams} params - * @return {*} {AsyncGenerator} + * @return {AsyncGenerator} * @memberof ClientMethods */ public async *deposit( @@ -535,7 +535,7 @@ export class ClientMethods extends ClientCore implements IClientMethods { * Checks if the allowance is enough and updates it * * @param {SetAllowanceParams} params - * @return {*} {AsyncGenerator} + * @return {AsyncGenerator} * @memberof ClientMethods */ public async *setAllowance( @@ -579,7 +579,7 @@ export class ClientMethods extends ClientCore implements IClientMethods { * Prepare uninstallation of a plugin * * @param {PrepareUninstallationParams} params - * @return {*} {AsyncGenerator} + * @return {AsyncGenerator} * @memberof ClientMethods */ public async *prepareUninstallation( @@ -671,7 +671,7 @@ export class ClientMethods extends ClientCore implements IClientMethods { * Prepare update of a plugin * * @param {PrepareUpdateParams} params - * @return {*} {AsyncGenerator} + * @return {AsyncGenerator} * @memberof ClientMethods */ public async *prepareUpdate( @@ -692,7 +692,7 @@ export class ClientMethods extends ClientCore implements IClientMethods { * Checks whether a role is granted by the current DAO's ACL settings * * @param {HasPermissionParams} params - * @return {*} {Promise} + * @return {Promise} * @memberof ClientMethods */ public async hasPermission(params: HasPermissionParams): Promise { @@ -711,7 +711,7 @@ export class ClientMethods extends ClientCore implements IClientMethods { * Retrieves metadata for DAO with given identifier (address or ens domain) * * @param {string} daoAddressOrEns - * @return {*} {(Promise)} + * @return {(Promise)} * @memberof ClientMethods */ public async getDao(daoAddressOrEns: string): Promise { @@ -761,13 +761,12 @@ export class ClientMethods extends ClientCore implements IClientMethods { /** * Retrieves metadata for DAO with given identifier (address or ens domain) * - * @param {DaoQueryParams} { + * @param {DaoQueryParams} params * limit = 10, * skip = 0, * direction = SortDirection.ASC, - * sortBy = DaoSortBy.CREATED_AT, - * } - * @return {*} {Promise} + * sortBy = DaoSortBy.CREATED_AT + * @return {Promise} * @memberof ClientMethods */ public async getDaos({ @@ -823,14 +822,13 @@ export class ClientMethods extends ClientCore implements IClientMethods { /** * Retrieves the asset balances of the given DAO, by default, ETH, DAI, USDC and USDT on Mainnet * - * @param {DaoBalancesQueryParams} { + * @param {DaoBalancesQueryParams} params * daoAddressOrEns, * limit = 10, * skip = 0, * direction = SortDirection.ASC, - * sortBy = AssetBalanceSortBy.LAST_UPDATED, - * } - * @return {*} {(Promise)} + * sortBy = AssetBalanceSortBy.LAST_UPDATED + * @return {(Promise)} * @memberof ClientMethods */ public async getDaoBalances({ @@ -889,15 +887,14 @@ export class ClientMethods extends ClientCore implements IClientMethods { /** * Retrieves the list of asset transfers to and from the given DAO (by default, from ETH, DAI, USDC and USDT, on Mainnet) * - * @param {TransferQueryParams} { + * @param {TransferQueryParams} params * daoAddressOrEns, * type, * limit = 10, * skip = 0, * direction = SortDirection.ASC, - * sortBy = TransferSortBy.CREATED_AT, - * } - * @return {*} {(Promise)} + * sortBy = TransferSortBy.CREATED_AT + * @return {(Promise)} * @memberof ClientMethods */ public async getDaoTransfers({ @@ -1000,14 +997,13 @@ export class ClientMethods extends ClientCore implements IClientMethods { /** * Retrieves the list of plugins available on the PluginRegistry * - * @param {PluginQueryParams} { + * @param {PluginQueryParams} params * limit = 10, * skip = 0, * direction = SortDirection.ASC, * sortBy = PluginSortBy.SUBDOMAIN, * subdomain - * } - * @return {*} {(Promise)} + * @return {(Promise)} * @memberof ClientMethods */ public async getPlugins({ @@ -1056,7 +1052,7 @@ export class ClientMethods extends ClientCore implements IClientMethods { * Get plugin details given an address, release and build * * @param {string} pluginAddress - * @return {*} {Promise} + * @return {Promise} * @memberof ClientMethods */ public async getPlugin(pluginAddress: string): Promise { @@ -1077,7 +1073,7 @@ export class ClientMethods extends ClientCore implements IClientMethods { * if the transaction fails returns [1,0,0] * * @param {string} contractAddress - * @return {*} {Promise<[number, number, number]>} + * @return {Promise} * @memberof ClientMethods */ public async getProtocolVersion( @@ -1104,7 +1100,7 @@ export class ClientMethods extends ClientCore implements IClientMethods { * Given a proposal id returns if that proposal is a dao update proposal * * @param {string} proposalId - * @return {*} {Promise} + * @return {Promise} * @memberof ClientMethods */ public async isDaoUpdateProposal( @@ -1132,7 +1128,7 @@ export class ClientMethods extends ClientCore implements IClientMethods { * Given a proposal id returns if that proposal is a plugin update proposal * * @param {string} proposalId - * @return {*} {Promise} + * @return {Promise} * @memberof ClientMethods */ public async isPluginUpdateProposal( @@ -1157,7 +1153,7 @@ export class ClientMethods extends ClientCore implements IClientMethods { * Check if the specified proposal id is valid for updating a plugin * * @param {string} proposalId - * @return {*} {Promise} + * @return {Promise} * @memberof ClientMethods */ public async isPluginUpdateProposalValid( @@ -1218,7 +1214,7 @@ export class ClientMethods extends ClientCore implements IClientMethods { * * @param {string} proposalId * @param {SupportedVersion} [version] - * @return {*} {Promise} + * @return {Promise} * @memberof ClientMethods */ public async isDaoUpdateProposalValid( @@ -1280,7 +1276,7 @@ export class ClientMethods extends ClientCore implements IClientMethods { * Return the implementation address for the specified dao factory * * @param {string} daoFactoryAddress - * @return {*} {Promise} + * @return {Promise} * @memberof ClientMethods */ public async getDaoImplementation( diff --git a/modules/client/src/internal/utils.ts b/modules/client/src/internal/utils.ts index c5ec06bb3..4c21ceb41 100644 --- a/modules/client/src/internal/utils.ts +++ b/modules/client/src/internal/utils.ts @@ -1132,7 +1132,7 @@ export function validateRevokeRootPermissionAction( * @param {string} daoAddress * @param {IClientGraphQLCore} graphql * @param {IClientIpfsCore} ipfs - * @return {*} {Promise} + * @return {Promise} */ export async function validateApplyUpdateFunction( action: DaoAction, @@ -1293,7 +1293,7 @@ export async function validateApplyUpdateFunction( * * @export * @param {DaoAction[]} actions - * @return {*} {ProposalActionTypes[]} + * @return {ProposalActionTypes[]} */ export function classifyProposalActions( actions: DaoAction[], @@ -1374,7 +1374,7 @@ export function classifyProposalActions( * * @export * @param {ProposalActionTypes[]} actions - * @return {*} {boolean} + * @return {boolean} */ export function containsPluginUpdateActionBlockWithRootPermission( actions: ProposalActionTypes[], @@ -1392,7 +1392,7 @@ export function containsPluginUpdateActionBlockWithRootPermission( * * @export * @param {ProposalActionTypes[]} actions - * @return {*} {boolean} + * @return {boolean} */ export function containsPluginUpdateActionBlock( actions: ProposalActionTypes[], @@ -1409,7 +1409,7 @@ export function containsPluginUpdateActionBlock( * * @export * @param {ProposalActionTypes[]} actions - * @return {*} {boolean} + * @return {boolean} */ export function startsWithDaoUpdateAction( actions: ProposalActionTypes[], diff --git a/modules/client/src/multisig/client.ts b/modules/client/src/multisig/client.ts index 4e6d56319..401034582 100644 --- a/modules/client/src/multisig/client.ts +++ b/modules/client/src/multisig/client.ts @@ -37,7 +37,7 @@ export class MultisigClient extends ClientCore implements IMultisigClient { * * @param {MultisigPluginInstallParams} params * @param {Networkish} [network="mainnet"] - * @return {*} {PluginInstallItem} + * @return {PluginInstallItem} * @memberof MultisigClient */ diff --git a/modules/client/src/multisig/internal/client/decoding.ts b/modules/client/src/multisig/internal/client/decoding.ts index 13e591448..eb841cc91 100644 --- a/modules/client/src/multisig/internal/client/decoding.ts +++ b/modules/client/src/multisig/internal/client/decoding.ts @@ -20,7 +20,7 @@ export class MultisigClientDecoding extends ClientCore * Decodes a list of addresses from an encoded add members action * * @param {Uint8Array} data - * @return {*} {string[]} + * @return {string[]} * @memberof MultisigClientDecoding */ public addAddressesAction(data: Uint8Array): string[] { @@ -38,7 +38,7 @@ export class MultisigClientDecoding extends ClientCore * Decodes a list of addresses from an encoded remove members action * * @param {Uint8Array} data - * @return {*} {string[]} + * @return {string[]} * @memberof MultisigClientDecoding */ public removeAddressesAction(data: Uint8Array): string[] { @@ -57,7 +57,7 @@ export class MultisigClientDecoding extends ClientCore * Decodes a list of min approvals from an encoded update min approval action * * @param {Uint8Array} data - * @return {*} {MultisigVotingSettings} + * @return {MultisigVotingSettings} * @memberof MultisigClientDecoding */ public updateMultisigVotingSettings( @@ -81,7 +81,7 @@ export class MultisigClientDecoding extends ClientCore * Returns the decoded function info given the encoded data of an action * * @param {Uint8Array} data - * @return {*} {(InterfaceParams | null)} + * @return {(InterfaceParams | null)} * @memberof MultisigClientDecoding */ public findInterface(data: Uint8Array): InterfaceParams | null { diff --git a/modules/client/src/multisig/internal/client/encoding.ts b/modules/client/src/multisig/internal/client/encoding.ts index efa80c9b2..08ef6a48f 100644 --- a/modules/client/src/multisig/internal/client/encoding.ts +++ b/modules/client/src/multisig/internal/client/encoding.ts @@ -39,7 +39,7 @@ export class MultisigClientEncoding extends ClientCore * @param {MultisigPluginInstallParams} params * @param {Networkish} network * - * @return {*} {PluginInstallItem} + * @return {PluginInstallItem} * @memberof MultisigClientEncoding */ static getPluginInstallItem( @@ -71,7 +71,7 @@ export class MultisigClientEncoding extends ClientCore * Computes the parameters to be given when creating a proposal that updates the governance configuration * * @param {AddAddressesParams} params - * @return {*} {DaoAction[]} + * @return {DaoAction[]} * @memberof MultisigClientEncoding */ public addAddressesAction( @@ -102,7 +102,7 @@ export class MultisigClientEncoding extends ClientCore * Computes the parameters to be given when creating a proposal that adds addresses to address list * * @param {RemoveAddressesParams} params - * @return {*} {DaoAction[]} + * @return {DaoAction[]} * @memberof MultisigClientEncoding */ public removeAddressesAction( @@ -133,7 +133,7 @@ export class MultisigClientEncoding extends ClientCore * Computes the parameters to be given when creating a proposal updates multisig settings * * @param {UpdateMultisigVotingSettingsParams} params - * @return {*} {DaoAction} + * @return {DaoAction} * @memberof MultisigClientEncoding */ public updateMultisigVotingSettings( diff --git a/modules/client/src/multisig/internal/client/estimation.ts b/modules/client/src/multisig/internal/client/estimation.ts index bd2ea6f66..102f5a988 100644 --- a/modules/client/src/multisig/internal/client/estimation.ts +++ b/modules/client/src/multisig/internal/client/estimation.ts @@ -23,7 +23,7 @@ export class MultisigClientEstimation extends ClientCore * Estimates the gas fee of creating a proposal on the plugin * * @param {CreateMultisigProposalParams} params - * @return {*} {Promise} + * @return {Promise} * @memberof MultisigClientEstimation */ public async createProposal( @@ -63,7 +63,7 @@ export class MultisigClientEstimation extends ClientCore * Estimates the gas fee of approving a proposal * * @param {ApproveMultisigProposalParams} params - * @return {*} {Promise} + * @return {Promise} * @memberof MultisigClientEstimation */ public async approveProposal( @@ -89,7 +89,7 @@ export class MultisigClientEstimation extends ClientCore * Estimates the gas fee of executing a proposal * * @param {string} proposalId - * @return {*} {Promise} + * @return {Promise} * @memberof MultisigClientEstimation */ public async executeProposal( @@ -115,7 +115,7 @@ export class MultisigClientEstimation extends ClientCore * Estimates the gas fee of preparing an update * * @param {MultisigPluginPrepareUpdateParams} params - * @return {*} {Promise} + * @return {Promise} * @memberof MultisigClientEstimation */ public async prepareUpdate( diff --git a/modules/client/src/multisig/internal/client/methods.ts b/modules/client/src/multisig/internal/client/methods.ts index ef10f2a09..952dbba17 100644 --- a/modules/client/src/multisig/internal/client/methods.ts +++ b/modules/client/src/multisig/internal/client/methods.ts @@ -86,7 +86,7 @@ export class MultisigClientMethods extends ClientCore * Creates a new proposal on the given multisig plugin contract * * @param {CreateMultisigProposalParams} params - * @return {*} {AsyncGenerator} + * @return {AsyncGenerator} * @memberof MultisigClientMethods */ public async *createProposal( @@ -158,7 +158,7 @@ export class MultisigClientMethods extends ClientCore * Pins a metadata object into IPFS and retruns the generated hash * * @param {ProposalMetadata} params - * @return {*} {Promise} + * @return {Promise} * @memberof MultisigClientMethods */ public async pinMetadata(params: ProposalMetadata): Promise { @@ -174,7 +174,7 @@ export class MultisigClientMethods extends ClientCore * Allow a wallet in the multisig give approval to a proposal * * @param {ApproveMultisigProposalParams} params - * @return {*} {AsyncGenerator} + * @return {AsyncGenerator} * @memberof MultisigClientMethods */ public async *approveProposal( @@ -208,7 +208,7 @@ export class MultisigClientMethods extends ClientCore * Allow a wallet in the multisig give approval to a proposal * * @param {string} proposalId - * @return {*} {AsyncGenerator} + * @return {AsyncGenerator} * @memberof MultisigClientMethods */ public async *executeProposal( @@ -242,7 +242,7 @@ export class MultisigClientMethods extends ClientCore * Prepares the installation of a multisig plugin in a given dao * * @param {MultisigPluginPrepareInstallationParams} params - * @return {*} {AsyncGenerator} + * @return {AsyncGenerator} * @memberof MultisigClientMethods */ public async *prepareInstallation( @@ -276,7 +276,7 @@ export class MultisigClientMethods extends ClientCore * Prepares the update of a multisig plugin in a given dao * * @param {MultisigPluginPrepareUpdateParams} params - * @return {*} {AsyncGenerator} + * @return {AsyncGenerator} * @memberof MultisigClientMethods */ public async *prepareUpdate( @@ -297,7 +297,7 @@ export class MultisigClientMethods extends ClientCore * Checks whether the current proposal can be approved by the given address * * @param {string} addressOrEns - * @return {*} {Promise} + * @return {Promise} * @memberof MultisigClientMethods */ public async canApprove( @@ -320,7 +320,7 @@ export class MultisigClientMethods extends ClientCore * Checks whether the current proposal can be executed * * @param {string} proposalId - * @return {*} {Promise} + * @return {Promise} * @memberof MultisigClientMethods */ public async canExecute( @@ -342,7 +342,7 @@ export class MultisigClientMethods extends ClientCore * * @param {string} addressOrEns * @param {number} blockNumber - * @return {*} {Promise} + * @return {Promise} * @memberof MultisigClientMethods */ public async getVotingSettings( @@ -374,15 +374,14 @@ export class MultisigClientMethods extends ClientCore /** * returns the members of the multisig * - * @param {MembersQueryParams} { + * @param {MembersQueryParams} params * pluginAddress, * blockNumber, * limit = 10, * skip = 0, * direction = SortDirection.ASC, - * sortBy = MembersSortBy.ADDRESS, - * } - * @return {*} {Promise} + * sortBy = MembersSortBy.ADDRESS + * @return {Promise} * @memberof MultisigClientMethods */ public async getMembers({ @@ -421,7 +420,7 @@ export class MultisigClientMethods extends ClientCore * Returns the details of the given proposal * * @param {string} proposalId - * @return {*} {(Promise)} + * @return {(Promise)} * @memberof MultisigClientMethods */ public async getProposal( @@ -473,15 +472,14 @@ export class MultisigClientMethods extends ClientCore /** * Returns a list of proposals on the Plugin, filtered by the given criteria * - * @param {ProposalQueryParams} { + * @param {ProposalQueryParams} params * daoAddressOrEns, * limit = 10, * status, * skip = 0, * direction = SortDirection.ASC, - * sortBy = ProposalSortBy.CREATED_AT, - * } - * @return {*} {Promise} + * sortBy = ProposalSortBy.CREATED_AT + * @return {Promise} * @memberof MultisigClientMethods */ public async getProposals({ diff --git a/modules/client/src/tokenVoting/client.ts b/modules/client/src/tokenVoting/client.ts index f07615376..84d16ea1c 100644 --- a/modules/client/src/tokenVoting/client.ts +++ b/modules/client/src/tokenVoting/client.ts @@ -41,7 +41,7 @@ export class TokenVotingClient extends ClientCore * * @param {TokenVotingPluginInstall} params * @param {Networkish} [network="mainnet"] - * @return {*} {PluginInstallItem} + * @return {PluginInstallItem} * @memberof TokenVotingClient */ getPluginInstallItem: ( diff --git a/modules/client/src/tokenVoting/internal/client/decoding.ts b/modules/client/src/tokenVoting/internal/client/decoding.ts index f0629dae3..3e2013e96 100644 --- a/modules/client/src/tokenVoting/internal/client/decoding.ts +++ b/modules/client/src/tokenVoting/internal/client/decoding.ts @@ -23,7 +23,7 @@ export class TokenVotingClientDecoding extends ClientCore * Decodes a dao metadata from an encoded update metadata action * * @param {Uint8Array} data - * @return {*} {VotingSettings} + * @return {VotingSettings} * @memberof TokenVotingClientDecoding */ public updatePluginSettingsAction(data: Uint8Array): VotingSettings { @@ -33,7 +33,7 @@ export class TokenVotingClientDecoding extends ClientCore * Decodes the mint token params from an encoded mint token action * * @param {Uint8Array} data - * @return {*} {MintTokenParams} + * @return {MintTokenParams} * @memberof TokenVotingClientDecoding */ public mintTokenAction(data: Uint8Array): MintTokenParams { @@ -51,7 +51,7 @@ export class TokenVotingClientDecoding extends ClientCore * Returns the decoded function info given the encoded data of an action * * @param {Uint8Array} data - * @return {*} {(InterfaceParams | null)} + * @return {(InterfaceParams | null)} * @memberof TokenVotingClientDecoding */ public findInterface(data: Uint8Array): InterfaceParams | null { diff --git a/modules/client/src/tokenVoting/internal/client/encoding.ts b/modules/client/src/tokenVoting/internal/client/encoding.ts index e26425482..efd61b2c6 100644 --- a/modules/client/src/tokenVoting/internal/client/encoding.ts +++ b/modules/client/src/tokenVoting/internal/client/encoding.ts @@ -39,7 +39,7 @@ export class TokenVotingClientEncoding extends ClientCore * * @param {TokenVotingPluginInstall} params * @param {Networkish} network - * @return {*} {PluginInstallItem} + * @return {PluginInstallItem} * @memberof TokenVotingClientEncoding */ static getPluginInstallItem( @@ -66,7 +66,7 @@ export class TokenVotingClientEncoding extends ClientCore * * @param {string} pluginAddress * @param {VotingSettings} params - * @return {*} {DaoAction} + * @return {DaoAction} * @memberof TokenVotingClientEncoding */ public updatePluginSettingsAction( @@ -89,7 +89,7 @@ export class TokenVotingClientEncoding extends ClientCore * * @param {string} minterAddress * @param {MintTokenParams} params - * @return {*} {DaoAction} + * @return {DaoAction} * @memberof TokenVotingClientEncoding */ public mintTokenAction( diff --git a/modules/client/src/tokenVoting/internal/client/estimation.ts b/modules/client/src/tokenVoting/internal/client/estimation.ts index 38e5319c4..f655ee615 100644 --- a/modules/client/src/tokenVoting/internal/client/estimation.ts +++ b/modules/client/src/tokenVoting/internal/client/estimation.ts @@ -29,7 +29,7 @@ export class TokenVotingClientEstimation extends ClientCore * Estimates the gas fee of creating a proposal on the plugin * * @param {CreateMajorityVotingProposalParams} params - * @return {*} {Promise} + * @return {Promise} * @memberof TokenVotingClientEstimation */ public async createProposal( @@ -69,7 +69,7 @@ export class TokenVotingClientEstimation extends ClientCore * Estimates the gas fee of casting a vote on a proposal * * @param {VoteProposalParams} params - * @return {*} {Promise} + * @return {Promise} * @memberof TokenVotingClientEstimation */ public async voteProposal( @@ -98,7 +98,7 @@ export class TokenVotingClientEstimation extends ClientCore * Estimates the gas fee of executing a TokenVoting proposal * * @param {string} proposalId - * @return {*} {Promise} + * @return {Promise} * @memberof TokenVotingClientEstimation */ public async executeProposal( @@ -124,7 +124,7 @@ export class TokenVotingClientEstimation extends ClientCore * Estimates the gas fee of delegating voting power to a delegatee * * @param {DelegateTokensParams} params - * @return {*} {Promise} + * @return {Promise} * @memberof TokenVotingClientEstimation */ public async delegateTokens( @@ -145,7 +145,7 @@ export class TokenVotingClientEstimation extends ClientCore * Estimates the gas fee of undelegating voting power * * @param {string} tokenAddress - * @return {*} {Promise} + * @return {Promise} * @memberof TokenVotingClientEstimation */ public async undelegateTokens( @@ -161,7 +161,7 @@ export class TokenVotingClientEstimation extends ClientCore * Estimates the gas fee of preparing an update * * @param {TokenVotingPluginPrepareUpdateParams} params - * @return {*} {Promise} + * @return {Promise} * @memberof TokenVotingClientEstimation */ public async prepareUpdate( diff --git a/modules/client/src/tokenVoting/internal/client/methods.ts b/modules/client/src/tokenVoting/internal/client/methods.ts index f96f02940..2bf022f31 100644 --- a/modules/client/src/tokenVoting/internal/client/methods.ts +++ b/modules/client/src/tokenVoting/internal/client/methods.ts @@ -125,7 +125,7 @@ export class TokenVotingClientMethods extends ClientCore * Creates a new proposal on the given TokenVoting plugin contract * * @param {CreateMajorityVotingProposalParams} params - * @return {*} {AsyncGenerator} + * @return {AsyncGenerator} * @memberof TokenVotingClient */ public async *createProposal( @@ -191,7 +191,7 @@ export class TokenVotingClientMethods extends ClientCore * Pins a metadata object into IPFS and retruns the generated hash * * @param {ProposalMetadata} params - * @return {*} {Promise} + * @return {Promise} * @memberof ClientMethods */ public async pinMetadata(params: ProposalMetadata): Promise { @@ -208,7 +208,7 @@ export class TokenVotingClientMethods extends ClientCore * * @param {VoteProposalParams} params * @param {VoteValues} vote - * @return {*} {AsyncGenerator} + * @return {AsyncGenerator} * @memberof TokenVotingClient */ public async *voteProposal( @@ -242,7 +242,7 @@ export class TokenVotingClientMethods extends ClientCore * Executes the given proposal, provided that it has already passed * * @param {string} proposalId - * @return {*} {AsyncGenerator} + * @return {AsyncGenerator} * @memberof TokenVotingClient */ public async *executeProposal( @@ -272,7 +272,7 @@ export class TokenVotingClientMethods extends ClientCore * Prepares the installation of a token voting plugin in a given dao * * @param {TokenVotingPluginPrepareInstallationParams} params - * @return {*} {AsyncGenerator} + * @return {AsyncGenerator} * @memberof TokenVotingClientMethods */ public async *prepareInstallation( @@ -298,7 +298,7 @@ export class TokenVotingClientMethods extends ClientCore * Prepares the update of a token voting plugin in a given dao * * @param {TokenVotingPluginPrepareUpdateParams} params - * @return {*} {AsyncGenerator} + * @return {AsyncGenerator} * @memberof TokenVotingClientMethods */ public async *prepareUpdate( @@ -375,7 +375,7 @@ export class TokenVotingClientMethods extends ClientCore * Delegates all the signer's voting power to a delegatee * * @param {DelegateTokensParams} params - * @return {*} {AsyncGenerator} + * @return {AsyncGenerator} * @memberof TokenVotingClientMethods */ public async *delegateTokens( @@ -400,7 +400,7 @@ export class TokenVotingClientMethods extends ClientCore * Delegates all the signer's tokens back to itself * * @param {string} tokenAddress - * @return {*} {AsyncGenerator} + * @return {AsyncGenerator} * @memberof TokenVotingClientMethods */ public async *undelegateTokens( @@ -416,7 +416,7 @@ export class TokenVotingClientMethods extends ClientCore * Retrieves the current signer's delegatee for the given token * * @param {string} tokenAddress - * @return {*} {Promise} + * @return {Promise} * @memberof TokenVotingClientMethods */ public async getDelegatee(tokenAddress: string): Promise { @@ -434,7 +434,7 @@ export class TokenVotingClientMethods extends ClientCore * Checks if an user can vote in a proposal * * @param {CanVoteParams} params - * @returns {*} {Promise} + * @returns {Promise} */ public async canVote(params: CanVoteParams): Promise { const provider = this.web3.getProvider(); @@ -460,7 +460,7 @@ export class TokenVotingClientMethods extends ClientCore * Checks whether the current proposal can be executed * * @param {string} proposalId - * @return {*} {Promise} + * @return {Promise} * @memberof TokenVotingClientMethods */ public async canExecute( @@ -480,15 +480,14 @@ export class TokenVotingClientMethods extends ClientCore /** * Returns the list of wallet addresses holding tokens from the underlying Token contract used by the plugin * - * @param {MembersQueryParams} { + * @param {MembersQueryParams} params * pluginAddress, * blockNumber, * limit = 10, * skip = 0, * direction = SortDirection.ASC, - * sortBy = MembersSortBy.ADDRESS, - * } - * @return {*} {Promise} + * sortBy = MembersSortBy.ADDRESS + * @return {Promise} * @memberof TokenVotingClientMethods */ public async getMembers({ @@ -527,7 +526,7 @@ export class TokenVotingClientMethods extends ClientCore * Returns the details of the given proposal * * @param {string} proposalId - * @return {*} {Promise} + * @return {Promise} * @memberof TokenVotingClient */ public async getProposal( @@ -580,7 +579,7 @@ export class TokenVotingClientMethods extends ClientCore * Returns a list of proposals on the Plugin, filtered by the given criteria * * @param {ProposalQueryParams} params - * @return {*} {Promise} + * @return {Promise} * @memberof TokenVotingClient */ public async getProposals({ @@ -673,7 +672,7 @@ export class TokenVotingClientMethods extends ClientCore * * @param {string} pluginAddress * @param {number} blockNumber - * @return {*} {Promise} + * @return {Promise} * @memberof TokenVotingClient */ public async getVotingSettings( @@ -719,7 +718,7 @@ export class TokenVotingClientMethods extends ClientCore * Returns the details of the token used in a specific plugin instance * * @param {string} pluginAddress - * @return {*} {Promise} + * @return {Promise} * @memberof TokenVotingClient */ public async getToken( @@ -796,7 +795,7 @@ export class TokenVotingClientMethods extends ClientCore * Checks if the given token is compatible with the TokenVoting plugin * * @param {string} tokenAddress - * @return {*} {Promise} + * @return {Promise} * @memberof TokenVotingClientMethods */ public async isTokenVotingCompatibleToken( diff --git a/modules/client/src/tokenVoting/internal/utils.ts b/modules/client/src/tokenVoting/internal/utils.ts index f8b369449..03459d427 100644 --- a/modules/client/src/tokenVoting/internal/utils.ts +++ b/modules/client/src/tokenVoting/internal/utils.ts @@ -377,7 +377,7 @@ export function computeProposalStatusFilter(status: ProposalStatus) { * @export * @param {string} tokenAddress * @param {Signer} signer - * @return {*} {Promise} + * @return {Promise} */ export async function isERC20Token( tokenAddress: string, diff --git a/modules/common/src/encoding.ts b/modules/common/src/encoding.ts index 828f82072..72d7f0a26 100644 --- a/modules/common/src/encoding.ts +++ b/modules/common/src/encoding.ts @@ -70,7 +70,7 @@ export function strip0x(value: string): string { * @export * @param {number} ratio * @param {number} digits - * @return {*} {bigint} + * @return {bigint} */ export function encodeRatio(ratio: number, digits: number): number { if (ratio < 0 || ratio > 1) { @@ -88,7 +88,7 @@ export function encodeRatio(ratio: number, digits: number): number { * @export * @param {bigint} onChainValue * @param {number} digits - * @return {*} {number} + * @return {number} */ export function decodeRatio( onChainValue: bigint | number, @@ -117,7 +117,7 @@ export function encodeProposalId(pluginAddress: string, id: number) { /** Decodes a proposalId from subgraph and returns the original pluginAddress and the nonce */ export function decodeProposalId( proposalId: string, -): { pluginAddress: string; id: number } { +): { pluginAddress: string; id: number } params if (!isProposalId(proposalId)) { throw new Error("Invalid proposalId"); } diff --git a/modules/common/src/promises.ts b/modules/common/src/promises.ts index 2f5e3b4a1..0e748bfcf 100644 --- a/modules/common/src/promises.ts +++ b/modules/common/src/promises.ts @@ -16,7 +16,7 @@ export function allSettled( * * @template T * @param {Promise} prom - * @return {*} + * @return * @deprecated */ function reflect(prom: Promise) { diff --git a/modules/ipfs/src/internal/helpers.ts b/modules/ipfs/src/internal/helpers.ts index 7d6bce1ff..4501752ad 100644 --- a/modules/ipfs/src/internal/helpers.ts +++ b/modules/ipfs/src/internal/helpers.ts @@ -166,7 +166,7 @@ export namespace Helpers { function encodeParams( options: T, - ): { [K in keyof T]: Exclude } { + ): { [K in keyof T]: Exclude } params // @ts-ignore return Object.fromEntries( Object.entries(options).filter(([, v]) => v != null),