{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["code-page-name","admonition","not-enabled"]},"type":"markdown"},"seo":{"title":"Sponsorship","siteUrl":"https://opensource.ripple.com/","meta":[{"name":"google-site-verification","content":"bLwyBi1imklcIuQxZ7JeI_kRF5Mg7yfr6arpEQV2nsE"}],"llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]},"description":"A Sponsorship object represents a sponsoring relationship between two accounts."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"sponsorship","__idx":0},"children":["Sponsorship"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://github.com/tequdev/rippled/blob/sponsor/include/xrpl/protocol/detail/ledger_entries.macro#L611-L624","title":"Source"},"children":["[Source]"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"CodePageName","attributes":{"name":"Sponsorship"},"children":[]}," ledger entry represents a sponsoring relationship between a sponsor and a sponsee. This allows sponsors to ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["pre-fund"]}," sponsees, if they so desire."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This object does not need to be created in order to sponsor accounts. It is an offered convenience, so that sponsors do not have to co-sign every sponsored transaction if they don't want to, especially for transaction fees. It also allows sponsors to set a maximum balance even if they still want to co-sign transactions."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["(Requires the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://xls.xrpl.org/xls/XLS-0068-sponsored-fees-and-reserves.html"},"children":["Sponsor amendment"]}," ",{"$$mdtype":"Tag","name":"NotEnabled","attributes":{},"children":[]},")"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"example-json","__idx":1},"children":["Example JSON"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"LedgerEntryType\": \"Sponsorship\",\n  \"Flags\": 0,\n  \"Owner\": \"rN7n7otQDd6FczFgLdlqtyMVrn3HMfXpf\",\n  \"Sponsee\": \"rfkDkFai4jUfCvAJiZ5Vm7XvvWjYvDqeYo\",\n  \"FeeAmount\": \"1000000\",\n  \"MaxFee\": \"1000\",\n  \"ReserveCount\": 5,\n  \"OwnerNode\": \"0000000000000000\",\n  \"SponseeNode\": \"0000000000000000\",\n  \"PreviousTxnID\": \"1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF\",\n  \"PreviousTxnLgrSeq\": 12345678\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"sponsorship-fields","__idx":2},"children":["Sponsorship"," Fields"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In addition to the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/xls-68-sponsored-fees-and-reserves/references/ledger-entries/updated-ledger-entries#common-ledger-entry-updates#common-ledger-entry-fields"},"children":["common ledger entry fields"]},", a ",{"$$mdtype":"Tag","name":"CodePageName","attributes":{"name":"Sponsorship"},"children":[]}," entry has the following fields:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Field Name"},"children":["Field Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"JSON Type"},"children":["JSON Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://xrpl.org/docs/references/protocol/binary-format/"},"children":["Internal Type"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Required?"},"children":["Required?"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FeeAmount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Amount"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The remaining amount of XRP that the sponsor has provided for the sponsee to use for transaction fees."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MaxFee"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Amount"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The maximum fee per transaction that the sponsor will cover. This field helps prevent excessive draining of the pre-funded fee pool. If the sponsee submits a transaction with a fee exceeding this value, the transaction fails."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Owner"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["AccountID"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The address of the sponsor account. This account pays the reserve for this object."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OwnerNode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["UInt64"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["A hint indicating which page of the sponsor's owner directory links to this object, in case the directory consists of multiple pages."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PreviousTxnID"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Hash256"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The identifying hash of the transaction that most recently modified this entry."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PreviousTxnLgrSeq"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Number"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["UInt32"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://xrpl.org/docs/references/protocol/data-types/basic-data-types#ledger-index"},"children":["ledger index"]}," of the ledger that contains the transaction that most recently modified this object."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ReserveCount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Number"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["UInt32"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The remaining number of owner reserves the sponsor has pre-funded for the sponsee."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sponsee"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["AccountID"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The address of the sponsee account associated with this relationship."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SponseeNode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["UInt64"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["A hint indicating which page of the sponsee's owner directory links to this object, in case the directory consists of multiple pages."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"sponsorship-flags","__idx":3},"children":["Sponsorship"," Flags"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"CodePageName","attributes":{"name":"Sponsorship"},"children":[]}," entry can have the following flags:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Flag Name"},"children":["Flag Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Flag Value"},"children":["Flag Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lsfSponsorshipRequireSignForFee"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["0x00010000"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["If enabled, every transaction that uses this sponsorship for fees requires a signature from the sponsor. If disabled, no signature is necessary, as the existence of the ",{"$$mdtype":"Tag","name":"CodePageName","attributes":{"name":"Sponsorship"},"children":[]}," object is sufficient."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lsfSponsorshipRequireSignForReserve"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["0x00020000"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["If enabled, every transaction that uses this sponsorship for reserves requires a signature from the sponsor. If disabled, no signature is necessary, as the existence of the ",{"$$mdtype":"Tag","name":"CodePageName","attributes":{"name":"Sponsorship"},"children":[]}," object is sufficient."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"deleting-a-sponsorship-object","__idx":4},"children":["Deleting a Sponsorship Object"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Either the sponsor or the sponsee can delete a ",{"$$mdtype":"Tag","name":"CodePageName","attributes":{"name":"Sponsorship"},"children":[]}," object using the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/xls-68-sponsored-fees-and-reserves/references/transactions/sponsorshipset"},"children":["SponsorshipSet transaction"]}," with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tfDeleteObject"]}," flag enabled."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"CodePageName","attributes":{"name":"Sponsorship"},"children":[]}," object is a ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://xrpl.org/docs/concepts/accounts/deleting-accounts#requirements"},"children":["deletion blocker"]},". A sponsor cannot delete their account until all their ",{"$$mdtype":"Tag","name":"CodePageName","attributes":{"name":"Sponsorship"},"children":[]}," objects are removed."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"sponsorship-id-format","__idx":5},"children":["Sponsorship ID Format"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ID of a ",{"$$mdtype":"Tag","name":"CodePageName","attributes":{"name":"Sponsorship"},"children":[]}," entry is the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://xrpl.org/docs/references/protocol/data-types/basic-data-types#hashes"},"children":["SHA-512Half"]}," of the following values, concatenated in order:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The Sponsorship space key (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["0x003E"]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The AccountID of the sponsor (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Owner"]}," field)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The AccountID of the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sponsee"]}]}]}]},"headings":[{"value":"Sponsorship","id":"sponsorship","depth":1},{"value":"Example JSON","id":"example-json","depth":2},{"value":"Sponsorship Fields","id":"sponsorship-fields","depth":2},{"value":"Sponsorship Flags","id":"sponsorship-flags","depth":2},{"value":"Deleting a Sponsorship Object","id":"deleting-a-sponsorship-object","depth":2},{"value":"Sponsorship ID Format","id":"sponsorship-id-format","depth":2}],"frontmatter":{"seo":{"description":"A Sponsorship object represents a sponsoring relationship between two accounts.","title":"Sponsorship"},"labels":["Fees","Accounts","Sponsorship"],"status":"not_enabled"},"editPage":{"to":"https://github.com/ripple/opensource.ripple.com/tree/main/docs/xls-68-sponsored-fees-and-reserves/references/ledger-entries/sponsorship.md"},"lastModified":"2026-04-10T16:11:18.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/xls-68-sponsored-fees-and-reserves/references/ledger-entries/sponsorship","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}