Skip to main content

addToBlacklist

Description​

The addToBlacklist function is an asynchronous method used to add a specified account to a blacklist. This function is part of a smart contract interface for managing user access and permissions.

Parameters​

  • _account: A string representing the account address to be blacklisted. This can also be an ENS name, which will be resolved to its corresponding address.
  • signer: An object representing the signer who is authorized to perform this action.

Returns​

The function returns a Promise that resolves to a string. This string represents the transaction result of adding the account to the blacklist.

Function Definition​

async addToBlacklist(_account: string, signer: any): Promise<any> {
    _account = await resolveENSOrReturnAddress(_account);
    let contract = this.getActionContractInstance(signer);
    let res = await contract.addToBlacklist(_account);
    return res.toString();
}

Usage​

This function is typically used in scenarios where certain accounts need to be restricted or banned from interacting with the contract. It requires proper authorization and is intended for use by contract administrators or authorized parties only.

Last updated on