Forget

Deleting messages on aleph.im uses special FORGET messages. These messages are sent to the network, and are then propagated to all nodes. Once a node receives a FORGET message, it will delete the message from its database.

To delete any kind of messages (post, aggregate, ...), you must send a FORGET message to the network, with the hash of the post you want to delete. You may also forget multiple posts at a time.

Usage

async def forget(
        self,
        hashes: List[str],
        reason: Optional[str],
        storage_engine: StorageEnum = StorageEnum.storage,
        channel: Optional[str] = None,
        address: Optional[str] = None,
        sync: bool = False,
    ) -> Tuple[AlephMessage, MessageStatus]:

Arguments

Required arguments

Parameter	Description
hashes	The hashes of the messages to forget. Can put several hashes here.
reason	The reason for forgetting the message.
storage_engine	The storage engine to use. ipfs or storage

Optional arguments

Parameter	Description
channel	The channel of the message. If not provided, the default channel will be used.
address	The address of the message. If not provided, the address of the account will be used.
sync	Wait for a confirmation from the API in a blocking manner.

Example

Here is a simple example of how to use the forget for a post:

from aleph.sdk.chains.ethereum import get_fallback_account
from aleph.sdk.client import AuthenticatedAlephHttpClient
from pprint import pprint

async def main():
    account = get_fallback_account()
    async with AuthenticatedAlephHttpClient(account) as client:
        message, status = await client.forget(
            hashes=["f02cd3ae058ff144f633ae87942e34f9352698ebd3a25bdb1de44b682427c98b"],
            reason="I don't like this post",
            channel="MY_CHANNEL",
        )
        return message, status

import asyncio
message, status = asyncio.run(main())
pprint(message.content.dict())

output:

{'address': '0x...',
 'aggregates': [],
 'hashes': [<ItemHash value='f02cd3ae058ff144f633ae87942e34f9352698ebd3a25bdb1de44b682427c98b' item_type=<ItemType.storage: 'storage'>>],
 'reason': "I don't like this post",
 'time': 1709624985.403002}

Note

More information in the deleting message section.