factom_sdk.client package¶
Submodules¶
factom_sdk.client.api_info_client module¶
factom_sdk.client.chains_client module¶
-
class
factom_sdk.client.chains_client.ChainsClient(base_url: str, app_id: str, app_key: str, automatic_signing: bool)¶ Bases:
object-
create(content: str, external_ids: list = None, signer_private_key: str = '', signer_chain_id: str = '', callback_url: str = '', callback_stages: list = None)¶ Creates a new chain
- Args:
- content (str): This is the data that will make up the first entry in your new chain.
external_ids (
list, optional): Tags that can be used to identify your chain. signer_private_key (str, optional): base58 string in Idsec format. This parameter is optional for creating an unsigned chain. signer_chain_id (str, optional): The chain id of the signer identity. This parameter is optional for creating an unsigned chain. callback_url (str, optional): The URL where you would like to receive the callback from Connect. callback_stages (list, optional): The immutability stages you would like to be notified about. This list can include any or all of the three stages: replicated, factom, and anchored. - Returns:
- Chain created info object.
-
get(chain_id: str, signature_validation=None)¶ Gets information about a specific chain from Connect.
- Args:
- chain_id (str): The unique identifier created for each chain. signature_validation (bool | custom function)
- Returns:
- Chain object.
-
list(limit: int = -1, offset: int = -1, stages: list = None)¶ Gets all of the chains on Factom.
- Args:
- limit (
int, optional): The number of items you would like to return back in each stage. offset (int, optional): The offset parameter allows you to select which item you would like to start from when a list is returned from Connect. stages (list, optional): The immutability stages you want to restrict results to. You can choose any from replicated, factom, and anchored. - Returns:
- List chains object.
-
search(external_ids: factom_sdk.client.chains_client.ChainsClient.list, limit: int = -1, offset: int = -1)¶ Finds all of the chains with external_ids that match what you entered.
- Args:
- external_ids (list): A list of external IDs associated with the chains user would like to search by.
limit (
int, optional): The number of items you would like to return back in each stage. offset (int, optional): The offset parameter allows you to select which item you would like to start from when a list is returned from Connect. - Returns:
- List chains object.
-
factom_sdk.client.entries_client module¶
-
class
factom_sdk.client.entries_client.EntriesClient(base_url: str, app_id: str, app_key: str, automatic_signing: bool)¶ Bases:
object-
create(chain_id: str, content: str, external_ids: list = None, signer_private_key: str = '', signer_chain_id: str = '', callback_url: str = '', callback_stages: list = None)¶ Creates a new entry for the selected chain.
- Args:
- chain_id (str): The chain identifier.
content (str): This is the data that will be stored directly on the blockchain.
external_ids (
list, optional): Tags that can be used to identify your entry. signer_private_key (str, optional): base58 string in Idsec format. This parameter is optional for creating an unsigned entry. signer_chain_id (str, optional): The chain id of the signer identity. This parameter is optional for creating an unsigned entry. callback_url (str, optional): The URL where you would like to receive the callback from Connect. callback_stages (list, optional): The immutability stages you would like to be notified about. This list can include any or all of the three stages: replicated, factom, and anchored. - Returns:
- Entry created object.
-
get(chain_id: str, entry_hash: str, signature_validation=None)¶ Gets information about a specific entry on Connect.
- Args:
- chain_id (str): The chain identifier. entry_hash (str): The SHA256 hash of the entry. signature_validation (bool | custom function)
- Returns:
- Entry object.
-
get_first(chain_id: str, signature_validation=None)¶ Retrieves the first entry that has been saved to this chain.
- Args:
- chain_id (str): The chain identifier. signature_validation (bool | custom function)
- Returns:
- Entry object.
-
get_last(chain_id: str, signature_validation=None)¶ Gets the last entry that has been saved to this chain.
- Args:
- chain_id (str): The chain identifier. signature_validation (bool | custom function)
- Returns:
- Entry object.
-
list(chain_id: str, limit: int = -1, offset: int = -1, stages: list = None)¶ Gets list of all entries contained on a specified chain.
- Args:
- chain_id (str): The chain identifier.
limit (
int, optional): The number of items you would like to return back in each stage. offset (int, optional): The offset parameter allows you to select which item you would like to start from when a list is returned from Connect. stages (list, optional): The immutability stages you want to restrict results to. You can choose any from replicated, factom, and anchored. - Returns:
- List entry object.
-
search(chain_id: str, external_ids: factom_sdk.client.entries_client.EntriesClient.list, limit: int = -1, offset: int = -1)¶ Finds all of the entries with external_ids that match what you entered.
- Args:
- chain_id (str): The chain identifier.
external_ids (list): A list of external IDs.
limit (
int, optional): The number of items you would like to return back in each stage. offset (int, optional): The offset parameter allows you to select which item you would like to start from when a list is returned from Connect. - Returns:
- List entry object.
-
factom_sdk.client.factom_client module¶
factom_sdk.client.identities_client module¶
-
class
factom_sdk.client.identities_client.IdentitiesClient(base_url: str, app_id: str, app_key: str)¶ Bases:
object-
create(names: list, keys: list = None, callback_url: str = '', callback_stages: list = None)¶ Creates a new Identity chain.
- Args:
- names (list): The names array for your identity must be unique.
keys (
list, optional): An array of public key strings in base58 idpub format, ordered from the highest to the lowest priority. callback_url (str, optional): The URL where you would like to receive the callback from Connect. callback_stages (list, optional): The immutability stages you would like to be notified about. This list can include any or all of the three stages: replicated, factom, and anchored. - Returns:
- Identity chain created object.
-
get(identity_chain_id: str)¶ Gets a summary of the identity chain’s current state.
- Args:
- identity_chain_id (str): The unique identifier for the identity chain being requested.
- Returns:
- Identity chain object.
-