Create

Posts are unique data entries. See more information Post object type.

---

Creating a post by calling create_post() function on the client.

Call this same function if you want to update / amend a post. see below for more information.

Usage

async def create_post(
        self,
        post_content,
        post_type: str,
        ref: Optional[str] = None,
        address: Optional[str] = None,
        channel: Optional[str] = None,
        inline: bool = True,
        storage_engine: StorageEnum = StorageEnum.storage,
        sync: bool = False,
) -> Tuple[PostMessage, MessageStatus]:

Arguments

Required arguments

Parameter	Description
post_content	The data to store as a dictionary. More information
post_type	An arbitrary content type that helps to describe the post_content. ex: ammend / blog / chat comment.

Optional arguments

Parameter	Description
ref	A searchable reference string of your choice to save to the item_content.ref. Can be the reference to another post, an address, transaction hash, etc. Mostly used with the ammend post_type.
address	Address the Post should be associated with or the address that submitted the Post.
channel	The channel where the message will be posted.
inline	Flag to indicate if the content should be inlined in the message or not.
storage_engine	The storage engine to use. ipfs or storage.
sync	Wait for a confirmation from the API in a blocking manner.

Example

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

async def main():
    account = get_fallback_account()
    async with AuthenticatedAlephHttpClient(account) as client:
        message, status = await client.create_post(
            {"hello": "world"},
            post_type="testtype",
            channel="MY_CHANNEL",
        )
        return message, status

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

outputs:

{'address': '0x...',
 'content': {'hello': 'world'},
 'ref': None,
 'time': 1709623431.41251,
 'type': 'testtype'}

Update / amending a post

Amending is similar to creating a new post, but with two differences:

• The post_type must be "amend"
• When calling create_post, you must pass the hash of the post you want to amend as ref

Example:

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.create_post(
            {"hello": "aleph"},
            post_type="amend",
            ref="02afdbf33ff2c6ddb46349298a4598a8801cec61dbaa8f3a17ba9d1ad6dd8cb1",
            channel="MY_CHANNEL",
        )
        return message, status

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

outputs:

{'address': '0x...',
 'content': {'hello': 'aleph'},
 'ref': '02afdbf33ff2c6ddb46349298a4598a8801cec61dbaa8f3a17ba9d1ad6dd8cb1',
 'time': 1709623543.108896,
 'type': 'amend'}