Open-Transactions
0.93.0-ge03d287
|
#include <OpenTransactions.hpp>
Classes | |
class | Pid |
Public Member Functions | |
EXPORT | OT_API () |
EXPORT | ~OT_API () |
EXPORT bool | IsInitialized () const |
EXPORT bool | SetTransportCallback (TransportCallback *pTransportCallback) |
EXPORT TransportCallback * | GetTransportCallback () const |
EXPORT bool | TransportFunction (const OTServerContract &theServerContract, const OTEnvelope &theEnvelope) const |
EXPORT bool | GetWalletFilename (OTString &strPath) const |
EXPORT bool | SetWalletFilename (const OTString &strPath) |
EXPORT OTWallet * | GetWallet (const char *szFuncName=nullptr) const |
OTClient * | GetClient () const |
EXPORT bool | LoadConfigFile () |
EXPORT bool | SetWallet (const OTString &strFilename) |
EXPORT bool | WalletExists () const |
EXPORT bool | LoadWallet () const |
EXPORT time64_t | GetTime () const |
EXPORT bool | NumList_Add (OTNumList &theList, const OTNumList &theNewNumbers) const |
EXPORT bool | NumList_Remove (OTNumList &theList, const OTNumList &theOldNumbers) const |
EXPORT bool | NumList_VerifyQuery (const OTNumList &theList, const OTNumList &theQueryNumbers) const |
EXPORT bool | NumList_VerifyAll (const OTNumList &theList, const OTNumList &theQueryNumbers) const |
EXPORT int32_t | NumList_Count (const OTNumList &theList) const |
EXPORT int32_t | GetNymCount () const |
EXPORT int32_t | GetServerCount () const |
EXPORT int32_t | GetAssetTypeCount () const |
EXPORT int32_t | GetAccountCount () const |
EXPORT bool | GetNym (int32_t iIndex, OTIdentifier &NYM_ID, OTString &NYM_NAME) const |
EXPORT bool | GetServer (int32_t iIndex, OTIdentifier &THE_ID, OTString &THE_NAME) const |
EXPORT bool | GetAssetType (int32_t iIndex, OTIdentifier &THE_ID, OTString &THE_NAME) const |
EXPORT bool | GetAccount (int32_t iIndex, OTIdentifier &THE_ID, OTString &THE_NAME) const |
EXPORT OTPseudonym * | GetNym (const OTIdentifier &NYM_ID, const char *szFuncName=nullptr) const |
EXPORT OTServerContract * | GetServer (const OTIdentifier &THE_ID, const char *szFuncName=nullptr) const |
EXPORT OTAssetContract * | GetAssetType (const OTIdentifier &THE_ID, const char *szFuncName=nullptr) const |
EXPORT OTAccount * | GetAccount (const OTIdentifier &THE_ID, const char *szFuncName=nullptr) const |
EXPORT OTPseudonym * | GetNymByIDPartialMatch (const std::string PARTIAL_ID, const char *szFuncName=nullptr) const |
EXPORT OTServerContract * | GetServerContractPartialMatch (const std::string PARTIAL_ID, const char *szFuncName=nullptr) const |
EXPORT OTAssetContract * | GetAssetContractPartialMatch (const std::string PARTIAL_ID, const char *szFuncName=nullptr) const |
EXPORT OTAccount * | GetAccountPartialMatch (const std::string PARTIAL_ID, const char *szFuncName=nullptr) const |
EXPORT OTPseudonym * | GetOrLoadPublicNym (const OTIdentifier &NYM_ID, const char *szFuncName=nullptr) const |
EXPORT OTPseudonym * | GetOrLoadPrivateNym (const OTIdentifier &NYM_ID, bool bChecking=false, const char *szFuncName=nullptr, const OTPasswordData *pPWData=nullptr, const OTPassword *pImportPassword=nullptr) const |
EXPORT OTPseudonym * | GetOrLoadNym (const OTIdentifier &NYM_ID, bool bChecking=false, const char *szFuncName=nullptr, const OTPasswordData *pPWData=nullptr) const |
EXPORT OTAccount * | GetOrLoadAccount (const OTPseudonym &theNym, const OTIdentifier &ACCT_ID, const OTIdentifier &SERVER_ID, const char *szFuncName=nullptr) const |
EXPORT OTAccount * | GetOrLoadAccount (const OTIdentifier &NYM_ID, const OTIdentifier &ACCT_ID, const OTIdentifier &SERVER_ID, const char *szFuncName=nullptr) const |
EXPORT bool | SetNym_Name (const OTIdentifier &NYM_ID, const OTIdentifier &SIGNER_NYM_ID, const OTString &NYM_NEW_NAME) const |
EXPORT bool | SetAccount_Name (const OTIdentifier &ACCT_ID, const OTIdentifier &SIGNER_NYM_ID, const OTString &ACCT_NEW_NAME) const |
EXPORT bool | SetAssetType_Name (const OTIdentifier &ASSET_ID, const OTString &STR_NEW_NAME) const |
EXPORT bool | SetServer_Name (const OTIdentifier &SERVER_ID, const OTString &STR_NEW_NAME) const |
EXPORT OTPseudonym * | LoadPublicNym (const OTIdentifier &NYM_ID, const char *szFuncName=nullptr) const |
EXPORT OTPseudonym * | LoadPrivateNym (const OTIdentifier &NYM_ID, bool bChecking=false, const char *szFuncName=nullptr, const OTPasswordData *pPWData=nullptr, const OTPassword *pImportPassword=nullptr) const |
EXPORT OTPseudonym * | CreateNym (int32_t nKeySize=1024, const std::string str_id_source="", const std::string str_alt_location="") const |
EXPORT bool | IsNym_RegisteredAtServer (const OTIdentifier &NYM_ID, const OTIdentifier &SERVER_ID) const |
EXPORT bool | Wallet_ChangePassphrase () const |
EXPORT bool | Wallet_CanRemoveServer (const OTIdentifier &SERVER_ID) const |
EXPORT bool | Wallet_CanRemoveAssetType (const OTIdentifier &ASSET_ID) const |
EXPORT bool | Wallet_CanRemoveNym (const OTIdentifier &NYM_ID) const |
EXPORT bool | Wallet_CanRemoveAccount (const OTIdentifier &ACCOUNT_ID) const |
EXPORT bool | Wallet_RemoveServer (const OTIdentifier &SERVER_ID) const |
EXPORT bool | Wallet_RemoveAssetType (const OTIdentifier &ASSET_ID) const |
EXPORT bool | Wallet_RemoveNym (const OTIdentifier &NYM_ID) const |
EXPORT bool | Wallet_ExportNym (const OTIdentifier &NYM_ID, OTString &strOutput) const |
EXPORT bool | Wallet_ImportNym (const OTString &FILE_CONTENTS, OTIdentifier *pNymID=nullptr) const |
EXPORT bool | Wallet_ImportCert (const OTString &DISPLAY_NAME, const OTString &FILE_CONTENTS, OTIdentifier *pNymID=nullptr) const |
EXPORT bool | Wallet_ExportCert (const OTIdentifier &NYM_ID, OTString &strOutput) const |
bool | Wallet_ImportPurse (const OTIdentifier &SERVER_ID, const OTIdentifier &ASSET_TYPE_ID, const OTIdentifier &SIGNER_ID, const OTString &THE_PURSE, const OTString *pstrDisplay=nullptr) |
EXPORT bool | Encode (const OTString &strPlaintext, OTString &strOutput, bool bLineBreaks=true) const |
EXPORT bool | Decode (const OTString &strEncoded, OTString &strOutput, bool bLineBreaks=true) const |
EXPORT bool | Encrypt (const OTIdentifier &theRecipientNymID, const OTString &strPlaintext, OTString &strOutput) const |
EXPORT bool | Decrypt (const OTIdentifier &theRecipientNymID, const OTString &strCiphertext, OTString &strOutput) const |
bool | FlatSign (const OTIdentifier &theSignerNymID, const OTString &strInput, const OTString &strContractType, OTString &strOutput) const |
EXPORT bool | SignContract (const OTIdentifier &theSignerNymID, const OTString &strContract, OTString &strOutput) const |
EXPORT bool | AddSignature (const OTIdentifier &theSignerNymID, const OTString &strContract, OTString &strOutput) const |
EXPORT bool | VerifySignature (const OTString &strContract, const OTIdentifier &theSignerNymID, OTContract **ppContract=nullptr) const |
EXPORT bool | VerifyAndRetrieveXMLContents (const OTString &strContract, const OTIdentifier &theSignerNymID, OTString &strOutput) |
Verify and Retrieve XML Contents. More... | |
EXPORT bool | VerifyAccountReceipt (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &ACCOUNT_ID) const |
EXPORT OTCheque * | WriteCheque (const OTIdentifier &SERVER_ID, const int64_t &CHEQUE_AMOUNT, const time64_t &VALID_FROM, const time64_t &VALID_TO, const OTIdentifier &SENDER_ACCT_ID, const OTIdentifier &SENDER_USER_ID, const OTString &CHEQUE_MEMO, const OTIdentifier *pRECIPIENT_USER_ID=nullptr) const |
EXPORT bool | DiscardCheque (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &ACCT_ID, const OTString &THE_CHEQUE) const |
EXPORT OTPaymentPlan * | ProposePaymentPlan (const OTIdentifier &SERVER_ID, const time64_t &VALID_FROM, const time64_t &VALID_TO, const OTIdentifier &SENDER_ACCT_ID, const OTIdentifier &SENDER_USER_ID, const OTString &PLAN_CONSIDERATION, const OTIdentifier &RECIPIENT_ACCT_ID, const OTIdentifier &RECIPIENT_USER_ID, const int64_t &INITIAL_PAYMENT_AMOUNT, const time64_t &INITIAL_PAYMENT_DELAY, const int64_t &PAYMENT_PLAN_AMOUNT, const time64_t &PAYMENT_PLAN_DELAY, const time64_t &PAYMENT_PLAN_PERIOD, time64_t PAYMENT_PLAN_LENGTH=OT_TIME_ZERO, int32_t PAYMENT_PLAN_MAX_PAYMENTS=0) const |
EXPORT bool | ConfirmPaymentPlan (const OTIdentifier &SERVER_ID, const OTIdentifier &SENDER_USER_ID, const OTIdentifier &SENDER_ACCT_ID, const OTIdentifier &RECIPIENT_USER_ID, OTPaymentPlan &thePlan) const |
EXPORT Purse * | LoadPurse (const OTIdentifier &SERVER_ID, const OTIdentifier &ASSET_ID, const OTIdentifier &USER_ID, const OTString *pstrDisplay=nullptr) const |
EXPORT bool | SavePurse (const OTIdentifier &SERVER_ID, const OTIdentifier &ASSET_ID, const OTIdentifier &USER_ID, Purse &THE_PURSE) const |
EXPORT Purse * | CreatePurse (const OTIdentifier &SERVER_ID, const OTIdentifier &ASSET_ID, const OTIdentifier &OWNER_ID) const |
EXPORT Purse * | CreatePurse_Passphrase (const OTIdentifier &SERVER_ID, const OTIdentifier &ASSET_ID) const |
EXPORT OTNym_or_SymmetricKey * | LoadPurseAndOwnerFromString (const OTIdentifier &theServerID, const OTIdentifier &theAssetTypeID, const OTString &strPurse, Purse &thePurse, OTPassword &thePassword, bool bForEncrypting=true, const OTIdentifier *pOWNER_ID=nullptr, const OTString *pstrDisplay1=nullptr, const OTString *pstrDisplay2=nullptr) const |
EXPORT OTNym_or_SymmetricKey * | LoadPurseAndOwnerForMerge (const OTString &strPurse, Purse &thePurse, OTPassword &thePassword, bool bCanBePublic=false, const OTIdentifier *pOWNER_ID=nullptr, const OTString *pstrDisplay=nullptr) const |
EXPORT Token * | Purse_Peek (const OTIdentifier &SERVER_ID, const OTIdentifier &ASSET_TYPE_ID, const OTString &THE_PURSE, const OTIdentifier *pOWNER_ID=nullptr, const OTString *pstrDisplay=nullptr) const |
EXPORT Purse * | Purse_Pop (const OTIdentifier &SERVER_ID, const OTIdentifier &ASSET_TYPE_ID, const OTString &THE_PURSE, const OTIdentifier *pOWNER_ID=nullptr, const OTString *pstrDisplay=nullptr) const |
EXPORT Purse * | Purse_Empty (const OTIdentifier &SERVER_ID, const OTIdentifier &ASSET_TYPE_ID, const OTString &THE_PURSE, const OTString *pstrDisplay=nullptr) const |
EXPORT Purse * | Purse_Push (const OTIdentifier &SERVER_ID, const OTIdentifier &ASSET_TYPE_ID, const OTString &THE_PURSE, const OTString &THE_TOKEN, const OTIdentifier *pOWNER_ID=nullptr, const OTString *pstrDisplay=nullptr) const |
EXPORT Token * | Token_ChangeOwner (const OTIdentifier &SERVER_ID, const OTIdentifier &ASSET_TYPE_ID, const OTString &THE_TOKEN, const OTIdentifier &SIGNER_NYM_ID, const OTString &OLD_OWNER, const OTString &NEW_OWNER, const OTString *pstrDisplay=nullptr) const |
EXPORT Mint * | LoadMint (const OTIdentifier &SERVER_ID, const OTIdentifier &ASSET_ID) const |
EXPORT OTAssetContract * | LoadAssetContract (const OTIdentifier &ASSET_ID) const |
EXPORT OTServerContract * | LoadServerContract (const OTIdentifier &SERVER_ID) const |
EXPORT bool | IsBasketCurrency (const OTIdentifier &BASKET_ASSET_TYPE_ID) const |
EXPORT int64_t | GetBasketMinimumTransferAmount (const OTIdentifier &BASKET_ASSET_TYPE_ID) const |
EXPORT int32_t | GetBasketMemberCount (const OTIdentifier &BASKET_ASSET_TYPE_ID) const |
EXPORT bool | GetBasketMemberType (const OTIdentifier &BASKET_ASSET_TYPE_ID, int32_t nIndex, OTIdentifier &theOutputMemberType) const |
EXPORT int64_t | GetBasketMemberMinimumTransferAmount (const OTIdentifier &BASKET_ASSET_TYPE_ID, int32_t nIndex) const |
EXPORT OTAccount * | LoadAssetAccount (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &ACCOUNT_ID) const |
EXPORT OTLedger * | LoadNymbox (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID) const |
EXPORT OTLedger * | LoadNymboxNoVerify (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID) const |
EXPORT OTLedger * | LoadInbox (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &ACCOUNT_ID) const |
EXPORT OTLedger * | LoadInboxNoVerify (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &ACCOUNT_ID) const |
EXPORT OTLedger * | LoadOutbox (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &ACCOUNT_ID) const |
EXPORT OTLedger * | LoadOutboxNoVerify (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &ACCOUNT_ID) const |
EXPORT OTLedger * | LoadPaymentInbox (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID) const |
EXPORT OTLedger * | LoadPaymentInboxNoVerify (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID) const |
EXPORT OTLedger * | LoadRecordBox (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &ACCOUNT_ID) const |
EXPORT OTLedger * | LoadRecordBoxNoVerify (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &ACCOUNT_ID) const |
EXPORT bool | ClearRecord (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &ACCOUNT_ID, int32_t nIndex, bool bClearAll=false) const |
EXPORT OTLedger * | LoadExpiredBox (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID) const |
EXPORT OTLedger * | LoadExpiredBoxNoVerify (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID) const |
EXPORT bool | ClearExpired (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, int32_t nIndex, bool bClearAll=false) const |
EXPORT bool | RecordPayment (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, bool bIsInbox, int32_t nIndex, bool bSaveCopy) const |
EXPORT bool | DoesBoxReceiptExist (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &ACCOUNT_ID, int32_t nBoxType, const int64_t &lTransactionNum) const |
EXPORT OTMessage * | PopMessageBuffer (const int64_t &lRequestNumber, const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID) const |
void | FlushMessageBuffer () |
EXPORT OTMessage * | GetSentMessage (const int64_t &lRequestNumber, const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID) const |
EXPORT bool | RemoveSentMessage (const int64_t &lRequestNumber, const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID) const |
EXPORT void | FlushSentMessages (bool bHarvestingForRetry, const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTLedger &THE_NYMBOX) const |
EXPORT bool | HaveAlreadySeenReply (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const int64_t &lRequestNumber) const |
EXPORT bool | ResyncNymWithServer (OTPseudonym &theNym, const OTLedger &theNymbox, const OTPseudonym &theMessageNym) const |
EXPORT int32_t | checkServerID (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID) const |
EXPORT int32_t | createUserAccount (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID) const |
EXPORT int32_t | deleteUserAccount (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID) const |
EXPORT int32_t | checkUser (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &USER_ID_CHECK) const |
EXPORT int32_t | usageCredits (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &USER_ID_CHECK, int64_t lAdjustment=0) const |
EXPORT int32_t | getRequest (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID) const |
EXPORT int32_t | sendUserMessage (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &USER_ID_RECIPIENT, const OTString &RECIPIENT_PUBKEY, const OTString &THE_MESSAGE) const |
EXPORT int32_t | sendUserInstrument (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &USER_ID_RECIPIENT, const OTString &RECIPIENT_PUBKEY, const OTPayment &THE_INSTRUMENT, const OTPayment *pINSTRUMENT_FOR_SENDER=nullptr) const |
EXPORT int32_t | issueAssetType (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTString &THE_CONTRACT) const |
EXPORT int32_t | getContract (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &ASSET_ID) const |
EXPORT int32_t | getMint (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &ASSET_ID) const |
EXPORT int32_t | getBoxReceipt (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &ACCOUNT_ID, int32_t nBoxType, const int64_t &lTransactionNum) const |
EXPORT int32_t | queryAssetTypes (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTASCIIArmor &ENCODED_MAP) const |
EXPORT int32_t | createAssetAccount (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &ASSET_ID) const |
EXPORT int32_t | deleteAssetAccount (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &ACCOUNT_ID) const |
EXPORT int32_t | getAccount (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &ACCT_ID) const |
EXPORT int32_t | getAccountFiles (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &ACCT_ID) const |
EXPORT Basket * | GenerateBasketCreation (const OTIdentifier &USER_ID, int64_t MINIMUM_TRANSFER) const |
EXPORT bool | AddBasketCreationItem (const OTIdentifier &USER_ID, Basket &theBasket, const OTIdentifier &ASSET_TYPE_ID, int64_t MINIMUM_TRANSFER) const |
EXPORT int32_t | issueBasket (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTString &BASKET_INFO) const |
EXPORT Basket * | GenerateBasketExchange (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &BASKET_ASSET_TYPE_ID, const OTIdentifier &BASKET_ASSET_ACCT_ID, int32_t TRANSFER_MULTIPLE) const |
EXPORT bool | AddBasketExchangeItem (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, Basket &theBasket, const OTIdentifier &ASSET_TYPE_ID, const OTIdentifier &ASSET_ACCT_ID) const |
EXPORT int32_t | exchangeBasket (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &BASKET_ASSET_ID, const OTString &BASKET_INFO, bool bExchangeInOrOut) const |
EXPORT int32_t | getTransactionNumber (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID) const |
EXPORT int32_t | notarizeWithdrawal (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &ACCT_ID, const int64_t &AMOUNT) const |
EXPORT int32_t | notarizeDeposit (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &ACCT_ID, const OTString &THE_PURSE) const |
EXPORT int32_t | notarizeTransfer (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &ACCT_FROM, const OTIdentifier &ACCT_TO, const int64_t &AMOUNT, const OTString &NOTE) const |
EXPORT int32_t | getNymbox (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID) const |
EXPORT int32_t | getInbox (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &ACCT_ID) const |
EXPORT int32_t | getOutbox (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &ACCT_ID) const |
EXPORT int32_t | processNymbox (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID) const |
EXPORT int32_t | processInbox (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &ACCT_ID, const OTString &ACCT_LEDGER) const |
EXPORT int32_t | withdrawVoucher (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &ACCT_ID, const OTIdentifier &RECIPIENT_USER_ID, const OTString &CHEQUE_MEMO, const int64_t &AMOUNT) const |
EXPORT int32_t | payDividend (const OTIdentifier &SERVER_ID, const OTIdentifier &ISSUER_USER_ID, const OTIdentifier &DIVIDEND_FROM_ACCT_ID, const OTIdentifier &SHARES_ASSET_TYPE_ID, const OTString &DIVIDEND_MEMO, const int64_t &AMOUNT_PER_SHARE) const |
EXPORT int32_t | depositCheque (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &ACCT_ID, const OTString &THE_CHEQUE) const |
EXPORT int32_t | triggerClause (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const int64_t &lTransactionNum, const OTString &strClauseName, const OTString *pStrParam=nullptr) const |
EXPORT bool | Create_SmartContract (const OTIdentifier &SIGNER_NYM_ID, time64_t VALID_FROM, time64_t VALID_TO, OTString &strOutput) const |
EXPORT bool | SmartContract_AddBylaw (const OTString &THE_CONTRACT, const OTIdentifier &SIGNER_NYM_ID, const OTString &BYLAW_NAME, OTString &strOutput) const |
EXPORT bool | SmartContract_AddClause (const OTString &THE_CONTRACT, const OTIdentifier &SIGNER_NYM_ID, const OTString &BYLAW_NAME, const OTString &CLAUSE_NAME, const OTString &SOURCE_CODE, OTString &strOutput) const |
EXPORT bool | SmartContract_AddVariable (const OTString &THE_CONTRACT, const OTIdentifier &SIGNER_NYM_ID, const OTString &BYLAW_NAME, const OTString &VAR_NAME, const OTString &VAR_ACCESS, const OTString &VAR_TYPE, const OTString &VAR_VALUE, OTString &strOutput) const |
EXPORT bool | SmartContract_AddCallback (const OTString &THE_CONTRACT, const OTIdentifier &SIGNER_NYM_ID, const OTString &BYLAW_NAME, const OTString &CALLBACK_NAME, const OTString &CLAUSE_NAME, OTString &strOutput) const |
EXPORT bool | SmartContract_AddHook (const OTString &THE_CONTRACT, const OTIdentifier &SIGNER_NYM_ID, const OTString &BYLAW_NAME, const OTString &HOOK_NAME, const OTString &CLAUSE_NAME, OTString &strOutput) const |
EXPORT bool | SmartContract_AddParty (const OTString &THE_CONTRACT, const OTIdentifier &SIGNER_NYM_ID, const OTString &PARTY_NAME, const OTString &AGENT_NAME, OTString &strOutput) const |
EXPORT bool | SmartContract_AddAccount (const OTString &THE_CONTRACT, const OTIdentifier &SIGNER_NYM_ID, const OTString &PARTY_NAME, const OTString &ACCT_NAME, const OTString &ASSET_TYPE_ID, OTString &strOutput) const |
EXPORT int32_t | SmartContract_CountNumsNeeded (const OTString &THE_CONTRACT, const OTString &AGENT_NAME) const |
EXPORT bool | SmartContract_ConfirmAccount (const OTString &THE_CONTRACT, const OTIdentifier &SIGNER_NYM_ID, const OTString &PARTY_NAME, const OTString &ACCT_NAME, const OTString &AGENT_NAME, const OTString &ACCT_ID, OTString &strOutput) const |
EXPORT bool | SmartContract_ConfirmParty (const OTString &THE_CONTRACT, const OTString &PARTY_NAME, const OTIdentifier &NYM_ID, OTString &strOutput) const |
EXPORT bool | Msg_HarvestTransactionNumbers (const OTMessage &theMsg, const OTIdentifier &USER_ID, bool bHarvestingForRetry, bool bReplyWasSuccess, bool bReplyWasFailure, bool bTransactionWasSuccess, bool bTransactionWasFailure) const |
EXPORT bool | HarvestClosingNumbers (const OTIdentifier &SERVER_ID, const OTIdentifier &NYM_ID, const OTString &THE_CRON_ITEM) const |
EXPORT bool | HarvestAllNumbers (const OTIdentifier &SERVER_ID, const OTIdentifier &NYM_ID, const OTString &THE_CRON_ITEM) const |
EXPORT int32_t | activateSmartContract (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTString &THE_SMART_CONTRACT) const |
EXPORT int32_t | depositPaymentPlan (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTString &THE_PAYMENT_PLAN) const |
EXPORT int32_t | issueMarketOffer (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &ASSET_ACCT_ID, const OTIdentifier &CURRENCY_ACCT_ID, const int64_t &MARKET_SCALE, const int64_t &MINIMUM_INCREMENT, const int64_t &TOTAL_ASSETS_ON_OFFER, const int64_t &PRICE_LIMIT, bool bBuyingOrSelling, time64_t tLifespanInSeconds=OT_TIME_DAY_IN_SECONDS, char STOP_SIGN=0, int64_t ACTIVATION_PRICE=0) const |
EXPORT int32_t | getMarketList (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID) const |
EXPORT int32_t | getMarketOffers (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &MARKET_ID, const int64_t &lDepth) const |
EXPORT int32_t | getMarketRecentTrades (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &MARKET_ID) const |
EXPORT int32_t | getNym_MarketOffers (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID) const |
EXPORT int32_t | cancelCronItem (const OTIdentifier &SERVER_ID, const OTIdentifier &USER_ID, const OTIdentifier &ASSET_ACCT_ID, const int64_t &lTransactionNum) const |
EXPORT void | AddServerContract (const OTServerContract &pContract) const |
EXPORT void | AddAssetContract (const OTAssetContract &theContract) const |
Static Public Member Functions | |
static EXPORT bool | InitOTApp () |
static EXPORT bool | CleanupOTApp () |
Definition at line 179 of file OpenTransactions.hpp.
opentxs::OT_API::OT_API | ( | ) |
Definition at line 626 of file OpenTransactions.cpp.
opentxs::OT_API::~OT_API | ( | ) |
Definition at line 645 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::activateSmartContract | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTString & | THE_SMART_CONTRACT | ||
) | const |
Definition at line 11142 of file OpenTransactions.cpp.
void opentxs::OT_API::AddAssetContract | ( | const OTAssetContract & | theContract | ) | const |
Definition at line 14063 of file OpenTransactions.cpp.
bool opentxs::OT_API::AddBasketCreationItem | ( | const OTIdentifier & | USER_ID, |
Basket & | theBasket, | ||
const OTIdentifier & | ASSET_TYPE_ID, | ||
int64_t | MINIMUM_TRANSFER | ||
) | const |
Definition at line 8739 of file OpenTransactions.cpp.
bool opentxs::OT_API::AddBasketExchangeItem | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
Basket & | theBasket, | ||
const OTIdentifier & | ASSET_TYPE_ID, | ||
const OTIdentifier & | ASSET_ACCT_ID | ||
) | const |
Definition at line 8916 of file OpenTransactions.cpp.
void opentxs::OT_API::AddServerContract | ( | const OTServerContract & | pContract | ) | const |
Definition at line 14058 of file OpenTransactions.cpp.
bool opentxs::OT_API::AddSignature | ( | const OTIdentifier & | theSignerNymID, |
const OTString & | strContract, | ||
OTString & | strOutput | ||
) | const |
OT-Sign a CONTRACT. (Add a signature)
Tries to instantiate the contract object, based on the string passed in. Signs the contract, WITHOUT releasing any signatures that are already there. Returns the signed contract, or nullptr if failure.
OT-Sign a CONTRACT. (Add a signature)
const char * OT_API_AddSignature(const char * SIGNER_NYM_ID, const char * THE_CONTRACT);
Tries to instantiate the contract object, based on the string passed in. Signs the contract, without releasing any signatures that are already there. Returns the signed contract, or nullptr if failure.
NOTE: The actual OT functionality (Use Cases) NEVER requires you to sign via this function. Why not? because, anytime a signature is needed on something, the relevant OT API call will require you to pass in the Nym, and the API already signs internally wherever it deems appropriate. Thus, this function is only for advanced uses, for OT-Scripts, server operators, etc.
Definition at line 3462 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::cancelCronItem | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | ASSET_ACCT_ID, | ||
const int64_t & | lTransactionNum | ||
) | const |
CANCEL A SPECIFIC OFFER (THAT SAME NYM PLACED PREVIOUSLY ON SAME SERVER.) By transaction number as key.
Definition at line 11573 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::checkServerID | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID | ||
) | const |
Definition at line 14027 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::checkUser | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | USER_ID_CHECK | ||
) | const |
Definition at line 13587 of file OpenTransactions.cpp.
|
static |
Definition at line 595 of file OpenTransactions.cpp.
bool opentxs::OT_API::ClearExpired | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
int32_t | nIndex, | ||
bool | bClearAll = false |
||
) | const |
Definition at line 6758 of file OpenTransactions.cpp.
bool opentxs::OT_API::ClearRecord | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | ACCOUNT_ID, | ||
int32_t | nIndex, | ||
bool | bClearAll = false |
||
) | const |
Definition at line 8198 of file OpenTransactions.cpp.
bool opentxs::OT_API::ConfirmPaymentPlan | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | SENDER_USER_ID, | ||
const OTIdentifier & | SENDER_ACCT_ID, | ||
const OTIdentifier & | RECIPIENT_USER_ID, | ||
OTPaymentPlan & | thePlan | ||
) | const |
Definition at line 5170 of file OpenTransactions.cpp.
bool opentxs::OT_API::Create_SmartContract | ( | const OTIdentifier & | SIGNER_NYM_ID, |
time64_t | VALID_FROM, | ||
time64_t | VALID_TO, | ||
OTString & | strOutput | ||
) | const |
Definition at line 3653 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::createAssetAccount | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | ASSET_ID | ||
) | const |
Definition at line 13196 of file OpenTransactions.cpp.
OTPseudonym * opentxs::OT_API::CreateNym | ( | int32_t | nKeySize = 1024 , |
const std::string | str_id_source = "" , |
||
const std::string | str_alt_location = "" |
||
) | const |
Definition at line 1514 of file OpenTransactions.cpp.
Purse * opentxs::OT_API::CreatePurse | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | ASSET_ID, | ||
const OTIdentifier & | OWNER_ID | ||
) | const |
Definition at line 5333 of file OpenTransactions.cpp.
Purse * opentxs::OT_API::CreatePurse_Passphrase | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | ASSET_ID | ||
) | const |
Definition at line 5354 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::createUserAccount | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID | ||
) | const |
Definition at line 13965 of file OpenTransactions.cpp.
bool opentxs::OT_API::Decode | ( | const OTString & | strEncoded, |
OTString & | strOutput, | ||
bool | bLineBreaks = true |
||
) | const |
Decode an OT-encoded string (back to plaintext.)
This will base64-decode, uncompress, and unpack an OT-encoded string. Returns the plaintext string, or nullptr.
Decode an OT-encoded string (back to plaintext.)
const char * OT_API_Decode(const char * szEncoded);
This will base64-decode, uncompress, and unpack an OT-encoded string. Returns the plaintext string, or nullptr.
Internally: OTASCIIArmor ascEncoded(szEncoded); OTString strPlain(ascEncoded); // strPlain now contains the decoded plaintext string. return strPlain.Get(); // We return it.
Definition at line 3257 of file OpenTransactions.cpp.
bool opentxs::OT_API::Decrypt | ( | const OTIdentifier & | theRecipientNymID, |
const OTString & | strCiphertext, | ||
OTString & | strOutput | ||
) | const |
OT-DECRYPT an OT-encrypted string back to plaintext.
Decrypts the base64-encoded ciphertext back into a normal string plaintext. Returns the plaintext string, or nullptr.
OT-DECRYPT an OT-encrypted string back to plaintext.
const char * OT_API_Decrypt(const char * RECIPIENT_NYM_ID, const char * szCiphertext);
Decrypts the base64-encoded ciphertext back into a normal string plaintext. Returns the plaintext string, or nullptr.
Internally the C++ code is: OTEnvelope theEnvelope; // Here is the envelope object. (The ciphertext IS the data for an OTEnvelope.) OTASCIIArmor ascCiphertext(szCiphertext); // The base64-encoded ciphertext passed in. Next we'll try to attach it to envelope object... if (theEnvelope.SetAsciiArmoredData(ascCiphertext)) { // ...so that we can open it using the appropriate Nym, into a plain string object: OTString strServerReply; // This will contain the output when we're done. const bool bOpened = // Now we try to decrypt: theEnvelope.Open(RECIPIENT_NYM, strServerReply); if (bOpened) { return strServerReply.Get(); } }
Definition at line 3338 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::deleteAssetAccount | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | ACCOUNT_ID | ||
) | const |
Definition at line 13250 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::deleteUserAccount | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID | ||
) | const |
Definition at line 13996 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::depositCheque | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | ACCT_ID, | ||
const OTString & | THE_CHEQUE | ||
) | const |
Definition at line 10590 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::depositPaymentPlan | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTString & | THE_PAYMENT_PLAN | ||
) | const |
Definition at line 10885 of file OpenTransactions.cpp.
bool opentxs::OT_API::DiscardCheque | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | ACCT_ID, | ||
const OTString & | THE_CHEQUE | ||
) | const |
Definition at line 10514 of file OpenTransactions.cpp.
bool opentxs::OT_API::DoesBoxReceiptExist | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | ACCOUNT_ID, | ||
int32_t | nBoxType, | ||
const int64_t & | lTransactionNum | ||
) | const |
Definition at line 13304 of file OpenTransactions.cpp.
bool opentxs::OT_API::Encode | ( | const OTString & | strPlaintext, |
OTString & | strOutput, | ||
bool | bLineBreaks = true |
||
) | const |
OT-encode a plaintext string. This will pack, compress, and base64-encode a plain string. Returns the base64-encoded string, or nullptr.
OT-encode a plaintext string.
const char * OT_API_Encode(const char * szPlaintext);
This will pack, compress, and base64-encode a plain string. Returns the base64-encoded string, or nullptr.
Internally: OTString strPlain(szPlaintext); OTASCIIArmor ascEncoded(thePlaintext); // ascEncoded now contains the OT-encoded string. return ascEncoded.Get(); // We return it.
Definition at line 3229 of file OpenTransactions.cpp.
bool opentxs::OT_API::Encrypt | ( | const OTIdentifier & | theRecipientNymID, |
const OTString & | strPlaintext, | ||
OTString & | strOutput | ||
) | const |
OT-ENCRYPT a plaintext string.
This will encode, ENCRYPT, and encode a plain string. Returns the base64-encoded ciphertext, or nullptr.
OT-ENCRYPT a plaintext string.
const char * OT_API_Encrypt(const char * RECIPIENT_NYM_ID, const char * szPlaintext);
This will encode, ENCRYPT, and encode a plain string. Returns the base64-encoded ciphertext, or nullptr.
Internally the C++ code is: OTString strPlain(szPlaintext); OTEnvelope theEnvelope; if (theEnvelope.Seal(RECIPIENT_NYM, strPlain)) { // Now it's encrypted (in binary form, inside the envelope), to the recipient's nym. OTASCIIArmor ascCiphertext(theEnvelope); // ascCiphertext now contains the base64-encoded ciphertext (as a string.) return ascCiphertext.Get(); }
Definition at line 3292 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::exchangeBasket | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | BASKET_ASSET_ID, | ||
const OTString & | BASKET_INFO, | ||
bool | bExchangeInOrOut | ||
) | const |
Definition at line 9110 of file OpenTransactions.cpp.
bool opentxs::OT_API::FlatSign | ( | const OTIdentifier & | theSignerNymID, |
const OTString & | strInput, | ||
const OTString & | strContractType, | ||
OTString & | strOutput | ||
) | const |
OT-Sign a piece of flat text. (With no discernible bookends around it.) strType contains the OT type. For example, if you are trying to sign a ledger (which does not have any existing signatures on it) then you would pass LEDGER for strType, resulting in --—BEGIN OT SIGNED LEDGER--—
OT-Sign a piece of flat text. (With no discernible bookends around it.) strContractType contains, for example, if you are trying to sign a ledger (which does not have any existing signatures on it) then you would pass LEDGER for strContractType, resulting in --—BEGIN OT SIGNED LEDGER--—
Definition at line 3367 of file OpenTransactions.cpp.
void opentxs::OT_API::FlushMessageBuffer | ( | ) |
Definition at line 8326 of file OpenTransactions.cpp.
void opentxs::OT_API::FlushSentMessages | ( | bool | bHarvestingForRetry, |
const OTIdentifier & | SERVER_ID, | ||
const OTIdentifier & | USER_ID, | ||
const OTLedger & | THE_NYMBOX | ||
) | const |
Definition at line 8440 of file OpenTransactions.cpp.
Basket * opentxs::OT_API::GenerateBasketCreation | ( | const OTIdentifier & | USER_ID, |
int64_t | MINIMUM_TRANSFER | ||
) | const |
Definition at line 8714 of file OpenTransactions.cpp.
Basket * opentxs::OT_API::GenerateBasketExchange | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | BASKET_ASSET_TYPE_ID, | ||
const OTIdentifier & | BASKET_ASSET_ACCT_ID, | ||
int32_t | TRANSFER_MULTIPLE | ||
) | const |
Definition at line 8825 of file OpenTransactions.cpp.
bool opentxs::OT_API::GetAccount | ( | int32_t | iIndex, |
OTIdentifier & | THE_ID, | ||
OTString & | THE_NAME | ||
) | const |
Definition at line 1366 of file OpenTransactions.cpp.
OTAccount * opentxs::OT_API::GetAccount | ( | const OTIdentifier & | THE_ID, |
const char * | szFuncName = nullptr |
||
) | const |
Definition at line 1449 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::getAccount | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | ACCT_ID | ||
) | const |
Definition at line 13392 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::GetAccountCount | ( | ) | const |
Definition at line 1326 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::getAccountFiles | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | ACCT_ID | ||
) | const |
Definition at line 13447 of file OpenTransactions.cpp.
OTAccount * opentxs::OT_API::GetAccountPartialMatch | ( | const std::string | PARTIAL_ID, |
const char * | szFuncName = nullptr |
||
) | const |
Definition at line 1500 of file OpenTransactions.cpp.
OTAssetContract * opentxs::OT_API::GetAssetContractPartialMatch | ( | const std::string | PARTIAL_ID, |
const char * | szFuncName = nullptr |
||
) | const |
Definition at line 1489 of file OpenTransactions.cpp.
bool opentxs::OT_API::GetAssetType | ( | int32_t | iIndex, |
OTIdentifier & | THE_ID, | ||
OTString & | THE_NAME | ||
) | const |
Definition at line 1355 of file OpenTransactions.cpp.
OTAssetContract * opentxs::OT_API::GetAssetType | ( | const OTIdentifier & | THE_ID, |
const char * | szFuncName = nullptr |
||
) | const |
Definition at line 1430 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::GetAssetTypeCount | ( | ) | const |
Definition at line 1317 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::GetBasketMemberCount | ( | const OTIdentifier & | BASKET_ASSET_TYPE_ID | ) | const |
Definition at line 8570 of file OpenTransactions.cpp.
int64_t opentxs::OT_API::GetBasketMemberMinimumTransferAmount | ( | const OTIdentifier & | BASKET_ASSET_TYPE_ID, |
int32_t | nIndex | ||
) | const |
Definition at line 8640 of file OpenTransactions.cpp.
bool opentxs::OT_API::GetBasketMemberType | ( | const OTIdentifier & | BASKET_ASSET_TYPE_ID, |
int32_t | nIndex, | ||
OTIdentifier & | theOutputMemberType | ||
) | const |
Definition at line 8599 of file OpenTransactions.cpp.
int64_t opentxs::OT_API::GetBasketMinimumTransferAmount | ( | const OTIdentifier & | BASKET_ASSET_TYPE_ID | ) | const |
Definition at line 8684 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::getBoxReceipt | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | ACCOUNT_ID, | ||
int32_t | nBoxType, | ||
const int64_t & | lTransactionNum | ||
) | const |
Definition at line 13321 of file OpenTransactions.cpp.
|
inline |
Definition at line 232 of file OpenTransactions.hpp.
int32_t opentxs::OT_API::getContract | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | ASSET_ID | ||
) | const |
Definition at line 12956 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::getInbox | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | ACCT_ID | ||
) | const |
Definition at line 12554 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::getMarketList | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID | ||
) | const |
GET MARKET LIST
Connect to a specific server, as a specific Nym, and request the list of markets. (Flush the buffer before calling this. Then after you make this call, wait 50 ms and then pop the buffer and check the server reply for success. From there you can either read the reply data directly out of the reply message, or you can load it from storage (OT will probably auto-store the reply to storage, for your convenience.)
Definition at line 12072 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::getMarketOffers | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | MARKET_ID, | ||
const int64_t & | lDepth | ||
) | const |
GET ALL THE OFFERS ON A SPECIFIC MARKET
A specific Nym is requesting the Server to send a list of the offers on a specific Market ID– the bid/ask, and prices/amounts, basically–(up to lDepth or server Max)
Definition at line 12127 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::getMarketRecentTrades | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | MARKET_ID | ||
) | const |
GET RECENT TRADES FOR A SPECIFIC MARKET ID
Most likely, ticker data will be made available through a separate ZMQ instance, which will use the publisher/subscriber model to distribute ticker data. From there, those privileged subscribers can distribute it via RSS, store it for future analysis, display charts, etc.
(So this function is not here to usurp that purpose.)
Definition at line 12193 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::getMint | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | ASSET_ID | ||
) | const |
Definition at line 13006 of file OpenTransactions.cpp.
bool opentxs::OT_API::GetNym | ( | int32_t | iIndex, |
OTIdentifier & | NYM_ID, | ||
OTString & | NYM_NAME | ||
) | const |
Definition at line 1335 of file OpenTransactions.cpp.
OTPseudonym * opentxs::OT_API::GetNym | ( | const OTIdentifier & | NYM_ID, |
const char * | szFuncName = nullptr |
||
) | const |
Definition at line 1388 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::getNym_MarketOffers | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID | ||
) | const |
GET ALL THE ACTIVE (in Cron) MARKET OFFERS FOR A SPECIFIC NYM. (ON A SPECIFIC SERVER, OBVIOUSLY.) Remember to use Flush/Call/Wait/Pop to check the server reply for success or fail. Hmm for size reasons, this really will have to return a list of transaction #s, and then I request them one-by-one after that...
Definition at line 12251 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::getNymbox | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID | ||
) | const |
Definition at line 12507 of file OpenTransactions.cpp.
OTPseudonym * opentxs::OT_API::GetNymByIDPartialMatch | ( | const std::string | PARTIAL_ID, |
const char * | szFuncName = nullptr |
||
) | const |
Definition at line 1468 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::GetNymCount | ( | ) | const |
Definition at line 1299 of file OpenTransactions.cpp.
OTAccount * opentxs::OT_API::GetOrLoadAccount | ( | const OTPseudonym & | theNym, |
const OTIdentifier & | ACCT_ID, | ||
const OTIdentifier & | SERVER_ID, | ||
const char * | szFuncName = nullptr |
||
) | const |
Tries to get the account from the wallet. Otherwise loads it from local storage.
Definition at line 4839 of file OpenTransactions.cpp.
OTAccount * opentxs::OT_API::GetOrLoadAccount | ( | const OTIdentifier & | NYM_ID, |
const OTIdentifier & | ACCT_ID, | ||
const OTIdentifier & | SERVER_ID, | ||
const char * | szFuncName = nullptr |
||
) | const |
Tries to get the account from the wallet. Otherwise loads it from local storage.
Definition at line 4855 of file OpenTransactions.cpp.
OTPseudonym * opentxs::OT_API::GetOrLoadNym | ( | const OTIdentifier & | NYM_ID, |
bool | bChecking = false , |
||
const char * | szFuncName = nullptr , |
||
const OTPasswordData * | pPWData = nullptr |
||
) | const |
This function tries to load as public Nym first, then if it fails, it tries the private one next. (So as to avoid unnecessarily asking users for their passphrase.) Be sure to use GetOrLoadPublicNym() or GetOrLoadPrivateNym() if you want to force it one way or the other.
No need to cleanup the Nym returned here, since it's added to the wallet and the wallet takes ownership.
Definition at line 4814 of file OpenTransactions.cpp.
OTPseudonym * opentxs::OT_API::GetOrLoadPrivateNym | ( | const OTIdentifier & | NYM_ID, |
bool | bChecking = false , |
||
const char * | szFuncName = nullptr , |
||
const OTPasswordData * | pPWData = nullptr , |
||
const OTPassword * | pImportPassword = nullptr |
||
) | const |
This function only tries to load as a private Nym. No need to cleanup, since it adds the Nym to the wallet.
It is smart enough to Get the Nym from the wallet, and if it sees that it's only a public nym (no private key) then it reloads it as a private nym at that time.
Definition at line 4784 of file OpenTransactions.cpp.
OTPseudonym * opentxs::OT_API::GetOrLoadPublicNym | ( | const OTIdentifier & | NYM_ID, |
const char * | szFuncName = nullptr |
||
) | const |
This function only tries to load as a public Nym. No need to cleanup, since it adds the Nym to the wallet.
Definition at line 4760 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::getOutbox | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | ACCT_ID | ||
) | const |
Definition at line 12608 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::getRequest | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID | ||
) | const |
Definition at line 13502 of file OpenTransactions.cpp.
OTMessage * opentxs::OT_API::GetSentMessage | ( | const int64_t & | lRequestNumber, |
const OTIdentifier & | SERVER_ID, | ||
const OTIdentifier & | USER_ID | ||
) | const |
Definition at line 8348 of file OpenTransactions.cpp.
bool opentxs::OT_API::GetServer | ( | int32_t | iIndex, |
OTIdentifier & | THE_ID, | ||
OTString & | THE_NAME | ||
) | const |
Definition at line 1345 of file OpenTransactions.cpp.
OTServerContract * opentxs::OT_API::GetServer | ( | const OTIdentifier & | THE_ID, |
const char * | szFuncName = nullptr |
||
) | const |
Definition at line 1411 of file OpenTransactions.cpp.
OTServerContract * opentxs::OT_API::GetServerContractPartialMatch | ( | const std::string | PARTIAL_ID, |
const char * | szFuncName = nullptr |
||
) | const |
Definition at line 1478 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::GetServerCount | ( | ) | const |
Definition at line 1308 of file OpenTransactions.cpp.
time64_t opentxs::OT_API::GetTime | ( | ) | const |
TIME (in seconds, as int64_t)
This will return the current time in seconds, as a int64_t int32_t.
Todo: consider making this available on the server side as well, so the smart contracts can see what time it is.
Definition at line 3211 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::getTransactionNumber | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID | ||
) | const |
Definition at line 9343 of file OpenTransactions.cpp.
TransportCallback * opentxs::OT_API::GetTransportCallback | ( | ) | const |
Definition at line 819 of file OpenTransactions.cpp.
OTWallet * opentxs::OT_API::GetWallet | ( | const char * | szFuncName = nullptr | ) | const |
Definition at line 1377 of file OpenTransactions.cpp.
bool opentxs::OT_API::GetWalletFilename | ( | OTString & | strPath | ) | const |
Definition at line 786 of file OpenTransactions.cpp.
bool opentxs::OT_API::HarvestAllNumbers | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | NYM_ID, | ||
const OTString & | THE_CRON_ITEM | ||
) | const |
Definition at line 4728 of file OpenTransactions.cpp.
bool opentxs::OT_API::HarvestClosingNumbers | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | NYM_ID, | ||
const OTString & | THE_CRON_ITEM | ||
) | const |
Definition at line 4683 of file OpenTransactions.cpp.
bool opentxs::OT_API::HaveAlreadySeenReply | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const int64_t & | lRequestNumber | ||
) | const |
Definition at line 8520 of file OpenTransactions.cpp.
|
static |
Definition at line 556 of file OpenTransactions.cpp.
bool opentxs::OT_API::IsBasketCurrency | ( | const OTIdentifier & | BASKET_ASSET_TYPE_ID | ) | const |
Definition at line 8541 of file OpenTransactions.cpp.
|
inline |
Definition at line 219 of file OpenTransactions.hpp.
bool opentxs::OT_API::IsNym_RegisteredAtServer | ( | const OTIdentifier & | NYM_ID, |
const OTIdentifier & | SERVER_ID | ||
) | const |
Definition at line 1619 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::issueAssetType | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTString & | THE_CONTRACT | ||
) | const |
Definition at line 12839 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::issueBasket | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTString & | BASKET_INFO | ||
) | const |
Definition at line 8768 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::issueMarketOffer | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | ASSET_ACCT_ID, | ||
const OTIdentifier & | CURRENCY_ACCT_ID, | ||
const int64_t & | MARKET_SCALE, | ||
const int64_t & | MINIMUM_INCREMENT, | ||
const int64_t & | TOTAL_ASSETS_ON_OFFER, | ||
const int64_t & | PRICE_LIMIT, | ||
bool | bBuyingOrSelling, | ||
time64_t | tLifespanInSeconds = OT_TIME_DAY_IN_SECONDS , |
||
char | STOP_SIGN = 0 , |
||
int64_t | ACTIVATION_PRICE = 0 |
||
) | const |
Definition at line 11723 of file OpenTransactions.cpp.
OTAccount * opentxs::OT_API::LoadAssetAccount | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | ACCOUNT_ID | ||
) | const |
Definition at line 6359 of file OpenTransactions.cpp.
OTAssetContract * opentxs::OT_API::LoadAssetContract | ( | const OTIdentifier & | ASSET_ID | ) | const |
Definition at line 6316 of file OpenTransactions.cpp.
bool opentxs::OT_API::LoadConfigFile | ( | ) |
Definition at line 831 of file OpenTransactions.cpp.
OTLedger * opentxs::OT_API::LoadExpiredBox | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID | ||
) | const |
Definition at line 6700 of file OpenTransactions.cpp.
OTLedger * opentxs::OT_API::LoadExpiredBoxNoVerify | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID | ||
) | const |
Definition at line 6733 of file OpenTransactions.cpp.
OTLedger * opentxs::OT_API::LoadInbox | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | ACCOUNT_ID | ||
) | const |
Definition at line 6443 of file OpenTransactions.cpp.
OTLedger * opentxs::OT_API::LoadInboxNoVerify | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | ACCOUNT_ID | ||
) | const |
Definition at line 6481 of file OpenTransactions.cpp.
Mint * opentxs::OT_API::LoadMint | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | ASSET_ID | ||
) | const |
Definition at line 6245 of file OpenTransactions.cpp.
OTLedger * opentxs::OT_API::LoadNymbox | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID | ||
) | const |
Definition at line 6378 of file OpenTransactions.cpp.
OTLedger * opentxs::OT_API::LoadNymboxNoVerify | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID | ||
) | const |
Definition at line 6413 of file OpenTransactions.cpp.
OTLedger * opentxs::OT_API::LoadOutbox | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | ACCOUNT_ID | ||
) | const |
Definition at line 6513 of file OpenTransactions.cpp.
OTLedger * opentxs::OT_API::LoadOutboxNoVerify | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | ACCOUNT_ID | ||
) | const |
Definition at line 6555 of file OpenTransactions.cpp.
OTLedger * opentxs::OT_API::LoadPaymentInbox | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID | ||
) | const |
Definition at line 6585 of file OpenTransactions.cpp.
OTLedger * opentxs::OT_API::LoadPaymentInboxNoVerify | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID | ||
) | const |
Definition at line 6611 of file OpenTransactions.cpp.
OTPseudonym * opentxs::OT_API::LoadPrivateNym | ( | const OTIdentifier & | NYM_ID, |
bool | bChecking = false , |
||
const char * | szFuncName = nullptr , |
||
const OTPasswordData * | pPWData = nullptr , |
||
const OTPassword * | pImportPassword = nullptr |
||
) | const |
CALLER is responsible to delete the Nym that's returned here! (Low level.)
Definition at line 4538 of file OpenTransactions.cpp.
OTPseudonym * opentxs::OT_API::LoadPublicNym | ( | const OTIdentifier & | NYM_ID, |
const char * | szFuncName = nullptr |
||
) | const |
CALLER is responsible to delete this Nym! (Low level.)
Definition at line 4515 of file OpenTransactions.cpp.
Purse * opentxs::OT_API::LoadPurse | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | ASSET_ID, | ||
const OTIdentifier & | USER_ID, | ||
const OTString * | pstrDisplay = nullptr |
||
) | const |
Definition at line 5258 of file OpenTransactions.cpp.
OTNym_or_SymmetricKey * opentxs::OT_API::LoadPurseAndOwnerForMerge | ( | const OTString & | strPurse, |
Purse & | thePurse, | ||
OTPassword & | thePassword, | ||
bool | bCanBePublic = false , |
||
const OTIdentifier * | pOWNER_ID = nullptr , |
||
const OTString * | pstrDisplay = nullptr |
||
) | const |
Definition at line 5528 of file OpenTransactions.cpp.
OTNym_or_SymmetricKey * opentxs::OT_API::LoadPurseAndOwnerFromString | ( | const OTIdentifier & | theServerID, |
const OTIdentifier & | theAssetTypeID, | ||
const OTString & | strPurse, | ||
Purse & | thePurse, | ||
OTPassword & | thePassword, | ||
bool | bForEncrypting = true , |
||
const OTIdentifier * | pOWNER_ID = nullptr , |
||
const OTString * | pstrDisplay1 = nullptr , |
||
const OTString * | pstrDisplay2 = nullptr |
||
) | const |
Definition at line 5379 of file OpenTransactions.cpp.
OTLedger * opentxs::OT_API::LoadRecordBox | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | ACCOUNT_ID | ||
) | const |
Definition at line 6638 of file OpenTransactions.cpp.
OTLedger * opentxs::OT_API::LoadRecordBoxNoVerify | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | ACCOUNT_ID | ||
) | const |
Definition at line 6672 of file OpenTransactions.cpp.
OTServerContract * opentxs::OT_API::LoadServerContract | ( | const OTIdentifier & | SERVER_ID | ) | const |
Definition at line 6279 of file OpenTransactions.cpp.
bool opentxs::OT_API::LoadWallet | ( | ) | const |
Definition at line 1090 of file OpenTransactions.cpp.
bool opentxs::OT_API::Msg_HarvestTransactionNumbers | ( | const OTMessage & | theMsg, |
const OTIdentifier & | USER_ID, | ||
bool | bHarvestingForRetry, | ||
bool | bReplyWasSuccess, | ||
bool | bReplyWasFailure, | ||
bool | bTransactionWasSuccess, | ||
bool | bTransactionWasFailure | ||
) | const |
Definition at line 4628 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::notarizeDeposit | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | ACCT_ID, | ||
const OTString & | THE_PURSE | ||
) | const |
Definition at line 9643 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::notarizeTransfer | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | ACCT_FROM, | ||
const OTIdentifier & | ACCT_TO, | ||
const int64_t & | AMOUNT, | ||
const OTString & | NOTE | ||
) | const |
Definition at line 12302 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::notarizeWithdrawal | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | ACCT_ID, | ||
const int64_t & | AMOUNT | ||
) | const |
Definition at line 9392 of file OpenTransactions.cpp.
Definition at line 3140 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::NumList_Count | ( | const OTNumList & | theList | ) | const |
Definition at line 3199 of file OpenTransactions.cpp.
Definition at line 3155 of file OpenTransactions.cpp.
bool opentxs::OT_API::NumList_VerifyAll | ( | const OTNumList & | theList, |
const OTNumList & | theQueryNumbers | ||
) | const |
Definition at line 3193 of file OpenTransactions.cpp.
bool opentxs::OT_API::NumList_VerifyQuery | ( | const OTNumList & | theList, |
const OTNumList & | theQueryNumbers | ||
) | const |
Definition at line 3175 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::payDividend | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | ISSUER_USER_ID, | ||
const OTIdentifier & | DIVIDEND_FROM_ACCT_ID, | ||
const OTIdentifier & | SHARES_ASSET_TYPE_ID, | ||
const OTString & | DIVIDEND_MEMO, | ||
const int64_t & | AMOUNT_PER_SHARE | ||
) | const |
Definition at line 9917 of file OpenTransactions.cpp.
OTMessage * opentxs::OT_API::PopMessageBuffer | ( | const int64_t & | lRequestNumber, |
const OTIdentifier & | SERVER_ID, | ||
const OTIdentifier & | USER_ID | ||
) | const |
Definition at line 8311 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::processInbox | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | ACCT_ID, | ||
const OTString & | ACCT_LEDGER | ||
) | const |
Definition at line 12771 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::processNymbox | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID | ||
) | const |
Definition at line 12667 of file OpenTransactions.cpp.
OTPaymentPlan * opentxs::OT_API::ProposePaymentPlan | ( | const OTIdentifier & | SERVER_ID, |
const time64_t & | VALID_FROM, | ||
const time64_t & | VALID_TO, | ||
const OTIdentifier & | SENDER_ACCT_ID, | ||
const OTIdentifier & | SENDER_USER_ID, | ||
const OTString & | PLAN_CONSIDERATION, | ||
const OTIdentifier & | RECIPIENT_ACCT_ID, | ||
const OTIdentifier & | RECIPIENT_USER_ID, | ||
const int64_t & | INITIAL_PAYMENT_AMOUNT, | ||
const time64_t & | INITIAL_PAYMENT_DELAY, | ||
const int64_t & | PAYMENT_PLAN_AMOUNT, | ||
const time64_t & | PAYMENT_PLAN_DELAY, | ||
const time64_t & | PAYMENT_PLAN_PERIOD, | ||
time64_t | PAYMENT_PLAN_LENGTH = OT_TIME_ZERO , |
||
int32_t | PAYMENT_PLAN_MAX_PAYMENTS = 0 |
||
) | const |
Definition at line 4996 of file OpenTransactions.cpp.
Purse * opentxs::OT_API::Purse_Empty | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | ASSET_TYPE_ID, | ||
const OTString & | THE_PURSE, | ||
const OTString * | pstrDisplay = nullptr |
||
) | const |
Definition at line 5825 of file OpenTransactions.cpp.
Token * opentxs::OT_API::Purse_Peek | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | ASSET_TYPE_ID, | ||
const OTString & | THE_PURSE, | ||
const OTIdentifier * | pOWNER_ID = nullptr , |
||
const OTString * | pstrDisplay = nullptr |
||
) | const |
Returns the TOKEN on top of the stock (LEAVING it on top of the stack, but giving you a decrypted copy of it.)
USER_ID can be nullptr, if the purse is password-protected. (It's just ignored in that case.) Otherwise MUST contain the NymID for the Purse owner (necessary to decrypt the token.)
CALLER must delete!!
returns nullptr if failure.
Definition at line 5669 of file OpenTransactions.cpp.
Purse * opentxs::OT_API::Purse_Pop | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | ASSET_TYPE_ID, | ||
const OTString & | THE_PURSE, | ||
const OTIdentifier * | pOWNER_ID = nullptr , |
||
const OTString * | pstrDisplay = nullptr |
||
) | const |
Returns the PURSE after popping a single token off of it.
NOTE: Caller must delete! NOTE: Caller must sign/save in order to effect the change.
OWNER_ID can be nullptr, if the purse is password-protected. (It's just ignored in that case.) Otherwise MUST contain the NymID for the Purse owner (necessary to decrypt the token.)
The reason you don't see a signer being passed here (to save the purse again, after popping) is because OTAPI.cpp Purse_Pop does the saving. (That's the function that calls this one.) So IT has a signer ID passed in, in addition to the owner ID–but we don't need that here.)
returns nullptr if failure.
Definition at line 5751 of file OpenTransactions.cpp.
Purse * opentxs::OT_API::Purse_Push | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | ASSET_TYPE_ID, | ||
const OTString & | THE_PURSE, | ||
const OTString & | THE_TOKEN, | ||
const OTIdentifier * | pOWNER_ID = nullptr , |
||
const OTString * | pstrDisplay = nullptr |
||
) | const |
Returns the PURSE after pushing a single token onto it.
NOTE: Caller must delete! NOTE: Caller must sign/save in order to effect the change.
USER_ID can be nullptr, if the purse is password-protected. (It's just ignored in that case.) Otherwise MUST contain the NymID for the Purse owner (necessary to encrypt the token.)
returns nullptr if failure.
Definition at line 5860 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::queryAssetTypes | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTASCIIArmor & | ENCODED_MAP | ||
) | const |
Definition at line 13071 of file OpenTransactions.cpp.
bool opentxs::OT_API::RecordPayment | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
bool | bIsInbox, | ||
int32_t | nIndex, | ||
bool | bSaveCopy | ||
) | const |
Definition at line 7029 of file OpenTransactions.cpp.
bool opentxs::OT_API::RemoveSentMessage | ( | const int64_t & | lRequestNumber, |
const OTIdentifier & | SERVER_ID, | ||
const OTIdentifier & | USER_ID | ||
) | const |
Definition at line 8363 of file OpenTransactions.cpp.
bool opentxs::OT_API::ResyncNymWithServer | ( | OTPseudonym & | theNym, |
const OTLedger & | theNymbox, | ||
const OTPseudonym & | theMessageNym | ||
) | const |
Definition at line 8274 of file OpenTransactions.cpp.
bool opentxs::OT_API::SavePurse | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | ASSET_ID, | ||
const OTIdentifier & | USER_ID, | ||
Purse & | THE_PURSE | ||
) | const |
Definition at line 5300 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::sendUserInstrument | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | USER_ID_RECIPIENT, | ||
const OTString & | RECIPIENT_PUBKEY, | ||
const OTPayment & | THE_INSTRUMENT, | ||
const OTPayment * | pINSTRUMENT_FOR_SENDER = nullptr |
||
) | const |
Definition at line 13743 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::sendUserMessage | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | USER_ID_RECIPIENT, | ||
const OTString & | RECIPIENT_PUBKEY, | ||
const OTString & | THE_MESSAGE | ||
) | const |
Definition at line 13637 of file OpenTransactions.cpp.
bool opentxs::OT_API::SetAccount_Name | ( | const OTIdentifier & | ACCT_ID, |
const OTIdentifier & | SIGNER_NYM_ID, | ||
const OTString & | ACCT_NEW_NAME | ||
) | const |
Definition at line 4478 of file OpenTransactions.cpp.
bool opentxs::OT_API::SetAssetType_Name | ( | const OTIdentifier & | ASSET_ID, |
const OTString & | STR_NEW_NAME | ||
) | const |
Definition at line 1570 of file OpenTransactions.cpp.
bool opentxs::OT_API::SetNym_Name | ( | const OTIdentifier & | NYM_ID, |
const OTIdentifier & | SIGNER_NYM_ID, | ||
const OTString & | NYM_NEW_NAME | ||
) | const |
Definition at line 4435 of file OpenTransactions.cpp.
bool opentxs::OT_API::SetServer_Name | ( | const OTIdentifier & | SERVER_ID, |
const OTString & | STR_NEW_NAME | ||
) | const |
Definition at line 1597 of file OpenTransactions.cpp.
bool opentxs::OT_API::SetTransportCallback | ( | TransportCallback * | pTransportCallback | ) |
Definition at line 809 of file OpenTransactions.cpp.
bool opentxs::OT_API::SetWallet | ( | const OTString & | strFilename | ) |
Definition at line 1000 of file OpenTransactions.cpp.
bool opentxs::OT_API::SetWalletFilename | ( | const OTString & | strPath | ) |
Definition at line 799 of file OpenTransactions.cpp.
bool opentxs::OT_API::SignContract | ( | const OTIdentifier & | theSignerNymID, |
const OTString & | strContract, | ||
OTString & | strOutput | ||
) | const |
OT-Sign a CONTRACT. (First signature)
Tries to instantiate the contract object, based on the string passed in. Then it releases ALL signatures, and then signs the contract. Returns the signed contract, or nullptr if failure.
OT-Sign a CONTRACT. (First signature)
const char * OT_API_SignContract(const char * SIGNER_NYM_ID, const char * THE_CONTRACT);
Tries to instantiate the contract object, based on the string passed in. Releases all signatures, and then signs the contract. Returns the signed contract, or nullptr if failure.
NOTE: The actual OT functionality (Use Cases) NEVER requires you to sign via this function. Why not? because, anytime a signature is needed on something, the relevant OT API call will require you to pass in the Nym, and the API already signs internally wherever it deems appropriate. Thus, this function is only for advanced uses, for OT-Scripts, server operators, etc.
Definition at line 3407 of file OpenTransactions.cpp.
bool opentxs::OT_API::SmartContract_AddAccount | ( | const OTString & | THE_CONTRACT, |
const OTIdentifier & | SIGNER_NYM_ID, | ||
const OTString & | PARTY_NAME, | ||
const OTString & | ACCT_NAME, | ||
const OTString & | ASSET_TYPE_ID, | ||
OTString & | strOutput | ||
) | const |
Definition at line 3741 of file OpenTransactions.cpp.
bool opentxs::OT_API::SmartContract_AddBylaw | ( | const OTString & | THE_CONTRACT, |
const OTIdentifier & | SIGNER_NYM_ID, | ||
const OTString & | BYLAW_NAME, | ||
OTString & | strOutput | ||
) | const |
Definition at line 4093 of file OpenTransactions.cpp.
bool opentxs::OT_API::SmartContract_AddCallback | ( | const OTString & | THE_CONTRACT, |
const OTIdentifier & | SIGNER_NYM_ID, | ||
const OTString & | BYLAW_NAME, | ||
const OTString & | CALLBACK_NAME, | ||
const OTString & | CLAUSE_NAME, | ||
OTString & | strOutput | ||
) | const |
Definition at line 4202 of file OpenTransactions.cpp.
bool opentxs::OT_API::SmartContract_AddClause | ( | const OTString & | THE_CONTRACT, |
const OTIdentifier & | SIGNER_NYM_ID, | ||
const OTString & | BYLAW_NAME, | ||
const OTString & | CLAUSE_NAME, | ||
const OTString & | SOURCE_CODE, | ||
OTString & | strOutput | ||
) | const |
Definition at line 4262 of file OpenTransactions.cpp.
bool opentxs::OT_API::SmartContract_AddHook | ( | const OTString & | THE_CONTRACT, |
const OTIdentifier & | SIGNER_NYM_ID, | ||
const OTString & | BYLAW_NAME, | ||
const OTString & | HOOK_NAME, | ||
const OTString & | CLAUSE_NAME, | ||
OTString & | strOutput | ||
) | const |
Definition at line 4147 of file OpenTransactions.cpp.
bool opentxs::OT_API::SmartContract_AddParty | ( | const OTString & | THE_CONTRACT, |
const OTIdentifier & | SIGNER_NYM_ID, | ||
const OTString & | PARTY_NAME, | ||
const OTString & | AGENT_NAME, | ||
OTString & | strOutput | ||
) | const |
Definition at line 3683 of file OpenTransactions.cpp.
bool opentxs::OT_API::SmartContract_AddVariable | ( | const OTString & | THE_CONTRACT, |
const OTIdentifier & | SIGNER_NYM_ID, | ||
const OTString & | BYLAW_NAME, | ||
const OTString & | VAR_NAME, | ||
const OTString & | VAR_ACCESS, | ||
const OTString & | VAR_TYPE, | ||
const OTString & | VAR_VALUE, | ||
OTString & | strOutput | ||
) | const |
Definition at line 4322 of file OpenTransactions.cpp.
bool opentxs::OT_API::SmartContract_ConfirmAccount | ( | const OTString & | THE_CONTRACT, |
const OTIdentifier & | SIGNER_NYM_ID, | ||
const OTString & | PARTY_NAME, | ||
const OTString & | ACCT_NAME, | ||
const OTString & | AGENT_NAME, | ||
const OTString & | ACCT_ID, | ||
OTString & | strOutput | ||
) | const |
Definition at line 3835 of file OpenTransactions.cpp.
bool opentxs::OT_API::SmartContract_ConfirmParty | ( | const OTString & | THE_CONTRACT, |
const OTString & | PARTY_NAME, | ||
const OTIdentifier & | NYM_ID, | ||
OTString & | strOutput | ||
) | const |
Definition at line 3995 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::SmartContract_CountNumsNeeded | ( | const OTString & | THE_CONTRACT, |
const OTString & | AGENT_NAME | ||
) | const |
Definition at line 3806 of file OpenTransactions.cpp.
Token * opentxs::OT_API::Token_ChangeOwner | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | ASSET_TYPE_ID, | ||
const OTString & | THE_TOKEN, | ||
const OTIdentifier & | SIGNER_NYM_ID, | ||
const OTString & | OLD_OWNER, | ||
const OTString & | NEW_OWNER, | ||
const OTString * | pstrDisplay = nullptr |
||
) | const |
Definition at line 6086 of file OpenTransactions.cpp.
bool opentxs::OT_API::TransportFunction | ( | const OTServerContract & | theServerContract, |
const OTEnvelope & | theEnvelope | ||
) | const |
Definition at line 1140 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::triggerClause | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const int64_t & | lTransactionNum, | ||
const OTString & | strClauseName, | ||
const OTString * | pStrParam = nullptr |
||
) | const |
Definition at line 11074 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::usageCredits | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | USER_ID_CHECK, | ||
int64_t | lAdjustment = 0 |
||
) | const |
Definition at line 13532 of file OpenTransactions.cpp.
bool opentxs::OT_API::VerifyAccountReceipt | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | ACCOUNT_ID | ||
) | const |
=== Verify Account Receipt === Returns bool. Verifies any asset account (intermediary files) against its own last signed receipt. Obviously this will fail for any new account that hasn't done any transactions yet, and thus has no receipts.
=== Verify Account Receipt === Returns bool. Verifies any asset account (intermediary files) against its own last signed receipt. Obviously this will fail for any new account that hasn't done any transactions yet (and thus has no receipts.)
Definition at line 3630 of file OpenTransactions.cpp.
bool opentxs::OT_API::VerifyAndRetrieveXMLContents | ( | const OTString & | strContract, |
const OTIdentifier & | theSignerNymID, | ||
OTString & | strOutput | ||
) |
Verify and Retrieve XML Contents.
Definition at line 3600 of file OpenTransactions.cpp.
bool opentxs::OT_API::VerifySignature | ( | const OTString & | strContract, |
const OTIdentifier & | theSignerNymID, | ||
OTContract ** | ppContract = nullptr |
||
) | const |
OT-Verify the signature on a CONTRACT. Returns true/false (success/fail)
OT-Verify the signature on a CONTRACT. Returns true/false (success/fail)
NOTICE that ppContract can be set, EVEN WHEN THIS RETURNS FALSE! Therefore, if you are low-level enough to actually be passing ppContract in here, then you had better check it, after the call, whether it returns success or fail! Either way, that pointer could be set, in which case YOU are responsible to clean it up! Check that pointer for nullptr!
if (!pContract->VerifyContract()) // This calls
VerifyContractID(), then GetContractPublicNym(), then VerifySignature() (with that Nym)
Definition at line 3513 of file OpenTransactions.cpp.
bool opentxs::OT_API::Wallet_CanRemoveAccount | ( | const OTIdentifier & | ACCOUNT_ID | ) | const |
Definition at line 2332 of file OpenTransactions.cpp.
bool opentxs::OT_API::Wallet_CanRemoveAssetType | ( | const OTIdentifier & | ASSET_ID | ) | const |
Definition at line 2200 of file OpenTransactions.cpp.
bool opentxs::OT_API::Wallet_CanRemoveNym | ( | const OTIdentifier & | NYM_ID | ) | const |
Definition at line 2247 of file OpenTransactions.cpp.
bool opentxs::OT_API::Wallet_CanRemoveServer | ( | const OTIdentifier & | SERVER_ID | ) | const |
Definition at line 2135 of file OpenTransactions.cpp.
bool opentxs::OT_API::Wallet_ChangePassphrase | ( | ) | const |
Definition at line 1696 of file OpenTransactions.cpp.
bool opentxs::OT_API::Wallet_ExportCert | ( | const OTIdentifier & | NYM_ID, |
OTString & | strOutput | ||
) | const |
Definition at line 3092 of file OpenTransactions.cpp.
bool opentxs::OT_API::Wallet_ExportNym | ( | const OTIdentifier & | NYM_ID, |
OTString & | strOutput | ||
) | const |
Definition at line 2543 of file OpenTransactions.cpp.
bool opentxs::OT_API::Wallet_ImportCert | ( | const OTString & | DISPLAY_NAME, |
const OTString & | FILE_CONTENTS, | ||
OTIdentifier * | pNymID = nullptr |
||
) | const |
Definition at line 3018 of file OpenTransactions.cpp.
bool opentxs::OT_API::Wallet_ImportNym | ( | const OTString & | FILE_CONTENTS, |
OTIdentifier * | pNymID = nullptr |
||
) | const |
Definition at line 2701 of file OpenTransactions.cpp.
bool opentxs::OT_API::Wallet_ImportPurse | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | ASSET_TYPE_ID, | ||
const OTIdentifier & | SIGNER_ID, | ||
const OTString & | THE_PURSE, | ||
const OTString * | pstrDisplay = nullptr |
||
) |
Definition at line 5944 of file OpenTransactions.cpp.
bool opentxs::OT_API::Wallet_RemoveAssetType | ( | const OTIdentifier & | ASSET_ID | ) | const |
Definition at line 2450 of file OpenTransactions.cpp.
bool opentxs::OT_API::Wallet_RemoveNym | ( | const OTIdentifier & | NYM_ID | ) | const |
Definition at line 2487 of file OpenTransactions.cpp.
bool opentxs::OT_API::Wallet_RemoveServer | ( | const OTIdentifier & | SERVER_ID | ) | const |
Definition at line 2399 of file OpenTransactions.cpp.
bool opentxs::OT_API::WalletExists | ( | ) | const |
Definition at line 1085 of file OpenTransactions.cpp.
int32_t opentxs::OT_API::withdrawVoucher | ( | const OTIdentifier & | SERVER_ID, |
const OTIdentifier & | USER_ID, | ||
const OTIdentifier & | ACCT_ID, | ||
const OTIdentifier & | RECIPIENT_USER_ID, | ||
const OTString & | CHEQUE_MEMO, | ||
const int64_t & | AMOUNT | ||
) | const |
Definition at line 10250 of file OpenTransactions.cpp.
OTCheque * opentxs::OT_API::WriteCheque | ( | const OTIdentifier & | SERVER_ID, |
const int64_t & | CHEQUE_AMOUNT, | ||
const time64_t & | VALID_FROM, | ||
const time64_t & | VALID_TO, | ||
const OTIdentifier & | SENDER_ACCT_ID, | ||
const OTIdentifier & | SENDER_USER_ID, | ||
const OTString & | CHEQUE_MEMO, | ||
const OTIdentifier * | pRECIPIENT_USER_ID = nullptr |
||
) | const |
Definition at line 4874 of file OpenTransactions.cpp.