opentxs::OTPartyAccount Class Reference

#include <OTPartyAccount.hpp>

Public Member Functions
EXPORT void	RegisterForExecution (OTScript &theScript)
OTParty *	GetParty () const
void	SetParty (OTParty &theOwnerParty)
EXPORT const OTString &	GetName () const
const OTString &	GetAgentName () const
const OTString &	GetAcctID () const
const OTString &	GetAssetTypeID () const
void	SetAgentName (const OTString &strAgentName)
void	SetAcctID (const OTString &strAccountID)
EXPORT OTAgent *	GetAuthorizedAgent ()
OTAccount *	LoadAccount (OTPseudonym &theSignerNym, const OTString &strServerID)
bool	IsAccount (OTAccount &theAccount)
bool	IsAccountByID (const OTIdentifier &theAcctID) const
bool	VerifyOwnership () const
bool	VerifyAgency ()
int64_t	GetClosingTransNo () const
void	SetClosingTransNo (int64_t lTransNo)
bool	Compare (const OTPartyAccount &rhs) const
bool	DropFinalReceiptToInbox (mapOfNyms *pNymMap, const OTString &strServerID, OTPseudonym &theServerNym, OTSmartContract &theSmartContract, const int64_t &lNewTransactionNumber, const OTString &strOrigCronItem, OTString *pstrNote=nullptr, OTString *pstrAttachment=nullptr)
	OTPartyAccount ()
	OTPartyAccount (std::string str_account_name, const OTString &strAgentName, OTAccount &theAccount, int64_t lClosingTransNo)
	OTPartyAccount (const OTString &strName, const OTString &strAgentName, const OTString &strAcctID, const OTString &strAssetTypeID, int64_t lClosingTransNo)
virtual	~OTPartyAccount ()
void	Serialize (OTString &strAppend, bool bCalculatingID=false, bool bSpecifyAssetID=false) const
void	ClearTemporaryPointers ()

Detailed Description

Definition at line 185 of file OTPartyAccount.hpp.

Constructor & Destructor Documentation

opentxs::OTPartyAccount::OTPartyAccount

(

)

Definition at line 153 of file OTPartyAccount.cpp.

    : m_pForParty(nullptr)
    , m_pAccount(nullptr)
    , m_lClosingTransNo(0)
{
}

opentxs::OTPartyAccount::OTPartyAccount	(	std::string	str_account_name,
		const OTString &	strAgentName,
		OTAccount &	theAccount,
		int64_t	lClosingTransNo
	)

Definition at line 164 of file OTPartyAccount.cpp.

    : m_pForParty(nullptr)
    , // This gets set when this partyaccount is added to its party.
    m_pAccount(&theAccount)
    , m_lClosingTransNo(lClosingTransNo)
    , m_strName(str_account_name.c_str())
    , m_strAcctID(theAccount.GetRealAccountID())
    , m_strAssetTypeID(theAccount.GetAssetTypeID())
    , m_strAgentName(strAgentName)
{
}

opentxs::OTPartyAccount::OTPartyAccount	(	const OTString &	strName,
		const OTString &	strAgentName,
		const OTString &	strAcctID,
		const OTString &	strAssetTypeID,
		int64_t	lClosingTransNo
	)

Definition at line 178 of file OTPartyAccount.cpp.

    : m_pForParty(nullptr)
    , // This gets set when this partyaccount is added to its party.
    m_pAccount(nullptr)
    , m_lClosingTransNo(lClosingTransNo)
    , m_strName(strName)
    , m_strAcctID(strAcctID)
    , m_strAssetTypeID(strAssetTypeID)
    , m_strAgentName(strAgentName)
{
}

opentxs::OTPartyAccount::~OTPartyAccount ( )

virtual

Definition at line 222 of file OTPartyAccount.cpp.

{
    // m_pForParty and m_pAccount NOT cleaned up here. pointer is only for
    // convenience.
    m_pForParty = nullptr;
    m_pAccount = nullptr;
}

Member Function Documentation

void opentxs::OTPartyAccount::ClearTemporaryPointers ( )

inline

Definition at line 297 of file OTPartyAccount.hpp.

    {
        m_pAccount = nullptr;
    }

bool opentxs::OTPartyAccount::Compare

(

const OTPartyAccount &

rhs

)

const

Definition at line 464 of file OTPartyAccount.cpp.

{
    if (!(GetName().Compare(rhs.GetName()))) {
        otOut << "OTPartyAccount::Compare: Names don't match: " << GetName()
              << " / " << rhs.GetName() << " \n";
        return false;
    }

    if ((GetClosingTransNo() > 0) && (rhs.GetClosingTransNo() > 0) &&
        (GetClosingTransNo() != rhs.GetClosingTransNo())) {
        otOut << "OTPartyAccount::Compare: Closing transaction numbers don't "
                 "match: " << GetName() << " \n";
        return false;
    }

    if ((GetAcctID().Exists()) && (rhs.GetAcctID().Exists()) &&
        (!GetAcctID().Compare(rhs.GetAcctID()))) {
        otOut << "OTPartyAccount::Compare: Asset account numbers don't match "
                 "for party account " << GetName() << ".\n( " << GetAcctID()
              << "  /  " << rhs.GetAcctID() << " ) \n";
        return false;
    }

    if ((GetAgentName().Exists()) && (rhs.GetAgentName().Exists()) &&
        (!GetAgentName().Compare(rhs.GetAgentName()))) {
        otOut << "OTPartyAccount::Compare: Agent names don't match for party "
                 "account " << GetName() << ".\n( " << GetAgentName() << "  /  "
              << rhs.GetAgentName() << " ) \n";
        return false;
    }

    if (!(GetAssetTypeID().Exists()) || !(rhs.GetAssetTypeID().Exists()) ||
        !(GetAssetTypeID().Compare(rhs.GetAssetTypeID()))) {
        otOut << "OTPartyAccount::Compare: Asset Type IDs don't exist, or "
                 "don't match ( " << GetAssetTypeID() << " / "
              << rhs.GetAssetTypeID() << " ) for party's account: " << GetName()
              << " \n";
        return false;
    }

    return true;
}

bool opentxs::OTPartyAccount::DropFinalReceiptToInbox	(	mapOfNyms *	pNymMap,
		const OTString &	strServerID,
		OTPseudonym &	theServerNym,
		OTSmartContract &	theSmartContract,
		const int64_t &	lNewTransactionNumber,
		const OTString &	strOrigCronItem,
		OTString *	pstrNote = nullptr,
		OTString *	pstrAttachment = nullptr
	)

Definition at line 345 of file OTPartyAccount.cpp.

{
    const char* szFunc = "OTPartyAccount::DropFinalReceiptToInbox";

    if (nullptr == m_pForParty) {
        otErr << szFunc << ": nullptr m_pForParty.\n";
        return false;
    }
    else if (!m_strAcctID.Exists()) {
        otErr << szFunc << ": Empty Acct ID.\n";
        return false;
    }
    else if (!m_strAgentName.Exists()) {
        otErr << szFunc << ": No agent named for this account.\n";
        return false;
    }

    // TODO: When entites and roles are added, this function may change a bit to
    // accommodate them.

    const std::string str_agent_name(m_strAgentName.Get());

    OTAgent* pAgent = m_pForParty->GetAgent(str_agent_name);

    if (nullptr == pAgent)
        otErr << szFunc << ": named agent wasn't found on party.\n";
    else {
        const OTIdentifier theAccountID(m_strAcctID);

        return pAgent->DropFinalReceiptToInbox(
            pNymMap, strServerID, theServerNym, theSmartContract,
            theAccountID,                             // acct ID from this.
            lNewTransactionNumber, m_lClosingTransNo, // closing_no from this.
            strOrigCronItem, pstrNote, pstrAttachment);
    }

    return false;
}

const OTString& opentxs::OTPartyAccount::GetAcctID ( ) const

inline

Definition at line 239 of file OTPartyAccount.hpp.

    {
        return m_strAcctID;
    } // account's ID as used internal to OT.

const OTString& opentxs::OTPartyAccount::GetAgentName ( ) const

inline

Definition at line 235 of file OTPartyAccount.hpp.

    {
        return m_strAgentName;
    } // agent's name as used in a script.

const OTString& opentxs::OTPartyAccount::GetAssetTypeID ( ) const

inline

Definition at line 243 of file OTPartyAccount.hpp.

    {
        return m_strAssetTypeID;
    } // asset type ID for the account.

OTAgent * opentxs::OTPartyAccount::GetAuthorizedAgent

(

)

Definition at line 198 of file OTPartyAccount.cpp.

{
    OT_ASSERT(nullptr != m_pForParty);

    if (!m_strAgentName.Exists()) {
        otErr << "OTPartyAccount::GetAuthorizedAgent: Error: Authorized agent "
                 "name (for this account) is blank!\n";
        return nullptr;
    }

    const std::string str_agent_name = m_strAgentName.Get();

    OTAgent* pAgent = m_pForParty->GetAgent(str_agent_name);

    return pAgent;
}

int64_t opentxs::OTPartyAccount::GetClosingTransNo ( ) const

inline

Definition at line 267 of file OTPartyAccount.hpp.

    {
        return m_lClosingTransNo;
    }

EXPORT const OTString& opentxs::OTPartyAccount::GetName ( ) const

inline

Definition at line 231 of file OTPartyAccount.hpp.

    {
        return m_strName;
    } // account's name as used in a script.

OTParty* opentxs::OTPartyAccount::GetParty ( ) const

inline

Definition at line 223 of file OTPartyAccount.hpp.

    {
        return m_pForParty;
    }

bool opentxs::OTPartyAccount::IsAccount

(

OTAccount &

theAccount

)

Definition at line 255 of file OTPartyAccount.cpp.

{
    if (!m_strAcctID.Exists()) {
        otErr << "OTPartyAccount::IsAccount: Error: Empty m_strAcctID.\n";
        return false;
    }

    if (!m_strAssetTypeID.Exists()) {
        otErr << "OTPartyAccount::IsAccount: Error: Empty m_strAssetTypeID.\n";
        return false;
    }

    const OTIdentifier theAcctID(m_strAcctID);
    if (!(theAccount.GetRealAccountID() == theAcctID)) {
        OTString strRHS(theAccount.GetRealAccountID());
        otLog4 << "OTPartyAccount::IsAccount: Account IDs don't match: "
               << m_strAcctID << " / " << strRHS
               << " \n"; // I set output to 4 because it's normal to call
                         // IsAccount() even when they don't match.
        return false;
    }

    const OTIdentifier theAssetTypeID(m_strAssetTypeID);
    if (!(theAccount.GetAssetTypeID() == theAssetTypeID)) {
        OTString strRHS(theAccount.GetAssetTypeID());
        otOut << "OTPartyAccount::IsAccount: Asset Type IDs don't match ( "
              << m_strAssetTypeID << " / " << strRHS
              << " ) for Acct ID: " << m_strAcctID << " \n";
        return false;
    }

    m_pAccount = &theAccount;
    return true;
}

bool opentxs::OTPartyAccount::IsAccountByID

(

const OTIdentifier &

theAcctID

)

const

Definition at line 230 of file OTPartyAccount.cpp.

{
    if (!m_strAcctID.Exists()) {
        return false;
    }

    if (!m_strAssetTypeID.Exists()) {
        return false;
    }

    const OTIdentifier theMemberAcctID(m_strAcctID);
    if (!(theAcctID == theMemberAcctID)) {
        OTString strRHS(theAcctID);
        otLog4 << "OTPartyAccount::IsAccountByID: Account IDs don't match: "
               << m_strAcctID << " / " << strRHS << " \n";
        // I set output to 4 because it's normal to call IsAccountByID() even
        // when they don't match.
        return false;
    }

    // They  match!

    return true;
}

OTAccount * opentxs::OTPartyAccount::LoadAccount	(	OTPseudonym &	theSignerNym,
		const OTString &	strServerID
	)

Definition at line 394 of file OTPartyAccount.cpp.

{
    if (!m_strAcctID.Exists()) {
        otOut << "OTPartyAccount::LoadAccount: Bad: Acct ID is blank for "
                 "account: " << m_strName << " \n";
        return nullptr;
    }

    const OTIdentifier theAcctID(m_strAcctID), theServerID(strServerID);

    OTAccount* pAccount =
        OTAccount::LoadExistingAccount(theAcctID, theServerID);

    if (nullptr == pAccount) {
        otOut << "OTPartyAccount::LoadAccount: Failed trying to load account: "
              << m_strName << ", with AcctID: " << m_strAcctID << " \n";
        return nullptr;
    }
    // BELOW THIS POINT, You must delete pAccount if you don't return it!!
    //
    else if (!pAccount->VerifyAccount(theSignerNym)) {
        otOut
            << "OTPartyAccount::LoadAccount: Failed trying to verify account: "
            << m_strName << ", with AcctID: " << m_strAcctID << " \n";
        delete pAccount;
        return nullptr;
    }

    // This compares asset type ID, AND account ID on the actual loaded account,
    // to what is expected.
    else if (!IsAccount(*pAccount)) // It also sets the internal pointer
                                    // m_pAccount... FYI.
    {
        // IsAccount has plenty of logging already.
        delete pAccount;
        return nullptr;
    }
    // BELOW THIS POINT, pAccount is loaded and validated, in-and-of-itself, and
    // against the PartyAcct.
    // (But not against the party ownership and agent rights.)
    // It must be deleted or will leak.

    // (No need to set m_pAccount, as that happened already in IsAccount().)

    return pAccount;
}

void opentxs::OTPartyAccount::RegisterForExecution

(

OTScript &

theScript

)

Definition at line 457 of file OTPartyAccount.cpp.

{
    const std::string str_acct_name = m_strName.Get();
    theScript.AddAccount(str_acct_name, *this);
}

void opentxs::OTPartyAccount::Serialize	(	OTString &	strAppend,
		bool	bCalculatingID = false,
		bool	bSpecifyAssetID = false
	)		const

Definition at line 442 of file OTPartyAccount.cpp.

{
    strAppend.Concatenate(
        "<assetAccount\n name=\"%s\"\n"
        " acctID=\"%s\"\n"
        " assetTypeID=\"%s\"\n"
        " agentName=\"%s\"\n"
        " closingTransNo=\"%lld\" />\n\n",
        m_strName.Get(), bCalculatingID ? "" : m_strAcctID.Get(),
        (bCalculatingID && !bSpecifyAssetID) ? "" : m_strAssetTypeID.Get(),
        bCalculatingID ? "" : m_strAgentName.Get(),
        bCalculatingID ? 0 : m_lClosingTransNo);
}

void opentxs::OTPartyAccount::SetAcctID ( const OTString &  strAccountID )

inline

Definition at line 252 of file OTPartyAccount.hpp.

    {
        m_strAcctID = strAccountID;
    }

void opentxs::OTPartyAccount::SetAgentName ( const OTString &  strAgentName )

inline

Definition at line 248 of file OTPartyAccount.hpp.

    {
        m_strAgentName = strAgentName;
    }

void opentxs::OTPartyAccount::SetClosingTransNo ( int64_t  lTransNo )

inline

Definition at line 271 of file OTPartyAccount.hpp.

    {
        m_lClosingTransNo = lTransNo;
    }

void opentxs::OTPartyAccount::SetParty

(

OTParty &

theOwnerParty

)

Definition at line 217 of file OTPartyAccount.cpp.

{
    m_pForParty = &theOwnerParty;
}

bool opentxs::OTPartyAccount::VerifyAgency

(

)

Definition at line 317 of file OTPartyAccount.cpp.

{
    if (nullptr == m_pAccount) {
        otErr << "OTPartyAccount::VerifyAgency: Error: nullptr pointer to "
                 "account. (This function expects account to already be "
                 "loaded.) \n";
        return false;
    } // todo maybe turn the above into OT_ASSERT()s.

    OTAgent* pAgent = GetAuthorizedAgent();

    if (nullptr == pAgent) {
        otOut
            << "OTPartyAccount::VerifyAgency: Unable to find authorized agent ("
            << GetAgentName() << ") for this account: " << GetName() << " \n";
        return false;
    }

    if (!pAgent->VerifyAgencyOfAccount(*m_pAccount)) {
        otOut << "OTPartyAccount::VerifyAgency: Agent " << GetAgentName()
              << " doesn't verify as ACTUALLY having rights over account "
              << GetName() << " with ID: " << GetAcctID() << " \n";
        return false;
    }

    return true;
}

bool opentxs::OTPartyAccount::VerifyOwnership

(

)

const

Definition at line 292 of file OTPartyAccount.cpp.

{
    if (nullptr == m_pForParty) {
        otErr << "OTPartyAccount::VerifyOwnership: Error: nullptr pointer to "
                 "owner party. \n";
        return false;
    }
    if (nullptr == m_pAccount) {
        otErr << "OTPartyAccount::VerifyOwnership: Error: nullptr pointer to "
                 "account. (This function expects account to already be "
                 "loaded.) \n";
        return false;
    } // todo maybe turn the above into OT_ASSERT()s.

    if (!m_pForParty->VerifyOwnershipOfAccount(*m_pAccount)) {
        otOut << "OTPartyAccount::VerifyOwnership: Party %s doesn't verify as "
                 "the ACTUAL owner of account: " << m_strName << " \n";
        return false;
    }

    return true;
}

---

The documentation for this class was generated from the following files:

• /usr/local/src/opentxs/include/opentxs/core/script/OTPartyAccount.hpp
• /usr/local/src/opentxs/src/core/script/OTPartyAccount.cpp