Skip to content

Module: types

ArAddress = NewType('ArAddress', str) module-attribute

Type alias for Arweave addresses, represented as strings.

ArTransactionId = NewType('ArTransactionId', str) module-attribute

Type alias for Arweave transaction IDs, represented as strings.

Tags = Dict[str, str] module-attribute

Type alias for a dictionary of tags, where both keys and values are strings.

ArRepoId

Bases: BaseModel

A class representing a repository identifier on Arweave.

Attributes:

Name Type Description
owner ArAddress

The owner of the repository.
name str

The name of the repository.
Source code in src/ritual_arweave/types.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
class ArRepoId(BaseModel):
    """
    A class representing a repository identifier on Arweave.

    Attributes:
        owner (ArAddress): The owner of the repository.
        name (str): The name of the repository.
    """

    owner: ArAddress
    name: str

    @classmethod
    def from_str(cls, _id: str) -> ArRepoId:
        """
        Create a ArRepoId instance from a string.

        Args:
            _id (str): A string in the format 'owner/name'.

        Returns:
            ArRepoId: An instance of ArRepoId with the owner and name extracted from the
            input string.
        """
        owner, name = _id.split("/")
        return cls(owner=ArAddress(owner), name=name)

from_str(_id) classmethod

Create a ArRepoId instance from a string.

Parameters:

Name Type Description Default
_id str

A string in the format 'owner/name'.

 required

Returns:

Name Type Description
ArRepoId ArRepoId

An instance of ArRepoId with the owner and name extracted from the
ArRepoId

input string.
Source code in src/ritual_arweave/types.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
@classmethod
def from_str(cls, _id: str) -> ArRepoId:
    """
    Create a ArRepoId instance from a string.

    Args:
        _id (str): A string in the format 'owner/name'.

    Returns:
        ArRepoId: An instance of ArRepoId with the owner and name extracted from the
        input string.
    """
    owner, name = _id.split("/")
    return cls(owner=ArAddress(owner), name=name)

LargeFileManifest

Bases: BaseModel

A class to represent a manifest file for a large file uploaded in sections.

Attributes:

Name Type Description
files Dict[str, str]

A dictionary of file names and their transaction IDs.
size int

The total size of the file.
Source code in src/ritual_arweave/types.py 
48
49
50
51
52
53
54
55
56
57
58
class LargeFileManifest(BaseModel):
    """
    A class to represent a manifest file for a large file uploaded in sections.

    Attributes:
        files (Dict[str, str]): A dictionary of file names and their transaction IDs.
        size (int): The total size of the file.
    """

    size: int
    files: Dict[str, str]