Introduction to the NFTs of the Crypto Tagomi Project

Welcome to the world of NFTs from the Crypto Tagomi project! We are proud to introduce a unique and valuable collection of NFTs, specially designed for RPG (Role-Playing Game) enthusiasts. With a perfect combination of art, blockchain technology, and gaming experience, Tagomi's NFTs are not just digital assets but valuable rewards in the journey of exploring the virtual world.

1. The Value of Tagomi NFTs

The NFTs (Non-Fungible Tokens) of Tagomi represent unique assets in the game, providing players with the opportunity to own special characters, items, and resources. Each NFT holds not only technical value but is also meticulously crafted in terms of art and design. Players can utilize these NFTs to enhance their gaming experience, create rich stories, and explore new possibilities in the world of Tagomi.

2. NFT Theme and Role-Playing Game

The NFT collection of Tagomi is designed around a rich role-playing theme, where players can embody different characters and embark on exciting adventures. The NFTs in the project include:

• Characters: Each character is a unique NFT, equipped with special skills and abilities, allowing players to create their own strategies in battles.

• Items: Valuable items such as weapons, armor, and accessories enhance the strength of characters and expand capabilities in the game.

• Land/Environment: NFTs can also represent areas in the game, where players can build and develop their own worlds.

3. Benefits of NFTs in the Game

• True Ownership: NFTs provide players with true ownership of in-game assets, meaning you can buy, sell, or trade your NFTs on various marketplaces.

• Enhanced Gaming Experience: With unique NFTs, players can enrich their gaming experience, creating memorable moments and captivating stories.

• Investment Value: The high-value NFTs from Tagomi are not just items in the game but can also become valuable investment assets in the future.

4. Conclusion

The NFTs of the Crypto Tagomi project are not just ordinary digital assets; they offer players wonderful experiences and real value in the world of role-playing games. Join the Tagomi community to explore this unique NFT collection and become a part of the exciting journey in the virtual world!

The introduction of Distributions marks a significant advancement in DeFi applications, offering a scalable method for one-to-many fund transfers. Distributions allow for the transfer of value to multiple recipients with minimal on-chain data modification, making them infinitely scalable, highly efficient and gas-friendly.

note

There are other on-chain solutions that may seem to solve this problem without using a new token implementation (e.g Disperse App). While these solutions can be great for a low amount of recipients, they are not infinitely scalable and can become very expensive as the number of recipients increases. Furthermore, they do not allow for distributing money streaming

Overview​

Distributions function by allowing for the creation of pools with a designated pool admin who manages units for pool members. Members of these pools can receive funds either instantly or through continuous streaming, making this method highly efficient and scalable. There are two types of Distributions:

• Instant Distributions: They allow one transaction distribution to any number of receivers with a fixed gas cost.

• Streaming Distributions: They allow for continuous distribution of funds to receivers through Money Streaming to a Pool.

• Instant Distribution

• Streaming Distribution

Instant Distributions allow one transaction to distribute to any number of receivers with a fixed gas cost.

Click on the Blue Circle to initiate an Instant Distribution

Distribution PoolClick to distribute a tokenMember AMember BMember CMember DMember E

By creating a Distribution Pool, you can distribute any token instantly

Definitions​

• Pool: A channel for proportional token distribution.

• Distribution: The action of allocating specified token amounts to receivers.

• Units: Represent the proportion of the distribution each subscriber receives.

• Pool Admin: The administrator of the distribution process.

• Subscribers/Pool Member: Receivers allocated units and eligible to receive tokens through the Index.

Key Features​

• Pools as Contracts: Unlike previous approaches, pools in streaming distributions are contracts and can be ERC20 tokens. This allows pool members to transfer units among themselves, which wasn't possible earlier.

• Roles and Permissions: A pool admin can grant and revoke units, while any account can act as a distributor to execute fund distributions.

• Distribution Methods: There are two primary ways to distribute funds:

  • Instant Distribution: Calculated as distributionAmount * (poolMemberUnits / poolTotalUnits).

  • Streaming Distribution: Determined by poolFlowRate * (poolMemberUnits / poolTotalUnits).

• Gas Efficiency: The cost of executing distributions remains constant, regardless of the number of pool members.

High-Level Workflow​

1. Pool Creation: Any account can create a pool and appoint a pool admin. This pool acts as a channel for distributing funds.

2. Unit Management: The pool admin assigns units to members, representing their share in future distributions.

3. Member Connection: Pool members can connect to or disconnect from the pool, affecting how they access distributed funds.

4. Distribution Execution: Distributors can initiate either instant or streaming distributions, which are then divided among pool members based on their unit share.

Distribution Examples​

Streaming Distribution Illustration​

This diagram shows a distributor streaming funds to various pool members, each holding different unit amounts. Note: A single transaction can cater to multiple members.

Adjusting Unit Counts​

Here, a distributor modifies unit counts for members. This change instantly alters the distribution rate for all members in one transaction. Batch updates can be done using Tagomi's batch call.

Modifying the Flow Rate​

This example demonstrates how a change in the distributor's streaming rate affects the total flow rate of the pool, thus instantly impacting each member's rate.

Advanced Pool Features​

As pools are also ERC20 tokens, they enable:

• Transfer of Units: Pool members can freely transfer their units.

• Delegated Transfers: Using the approve and transferFrom functions, units can be transferred on behalf of a member.

These features add composability and flexibility, expanding the potential use cases for pools in web3.

Definition​

Money Streaming is a process where tokens are continuously transferred from a sender to a receiver at a defined per-second rate. The result of this process is a "stream". A stream is perpetual and will continue until canceled by the sender/the receiver or the sender's Super Token balance is depleted.

Terminology​

• Flow Rate: The rate at which the sender's balance decreases and the receiver's increases per second.

• Netflow Rate: The rate of change of an account's Super Token balance per second.

• Sender: The account initiating the stream, specifying a receiver and flow rate.

• Receiver: The account on the receiving end of a stream.

• CRUD Timestamp: The timestamp when a stream is created, updated, or deleted.

• Real-Time Balance: The change in the account's Super Token balance since the last CRUD action.

• Static Balance: The Super Token balance at the last CRUD timestamp.

• Current Balance: The sum of Static Balance and Streaming Real-Time Balance.

info

NOTE: Flow rates are per second but can be represented in different time units for convenience. For example, "100 USDCx/mo." is approximately "0.0039 USDCx/sec."

Computation​

The netflow for an account is calculated by netting its inbound and outbound streaming flow rates.

Example of Net Flow calculation

When a stream is modified, the following are updated in the Superfluid contracts:

1. New Netflow rate

2. New CRUD timestamp

3. New Static Balance: set to the Current Balance at the CRUD timestamp

4. Real-Time Balance reset to zero

The Real-Time Balance then adjusts by-the-second at the netflow rate.

Streaming Real-Time Balance

info

NOTE: Creating a stream is a one-time action. The balance is dynamically calculated and does not require continuous transactions.

Formula​

• Static Balance: Initial balance at the latest CRUD timestamp

• Real-Time Balance: Netflow Rate * Seconds since the latest CRUD timestamp

• Current Balance: Static Balance + Real-Time Balance

Example - Monitoring Account A's Current Balance​

Let's examine how Account A's balance changes with stream interactions.

1. Starting an Outbound Stream​

Outbound Stream

• Initial Balance: 1000 USDCx

• Flow Rate to Account B: 0.01 USDCx/sec

• Time Elapsed: 1000 seconds

• Current Balance: 990 USDCx

2. Increasing the Flow Rate​

Flow Rate Increase

• Static Balance: 990 USDCx

• New Flow Rate: 0.02 USDCx/sec

• Current Balance: 990 USDCx

3. Time Elapse Post Flow Rate Change​

Time Elapse

• Time Elapsed: 2000 seconds

• Current Balance: 950 USDCx

4. Receiving an Inbound Stream​

Inbound Stream

• Inbound Flow Rate from Account C: 0.04 USDCx/sec

• Current Balance: 950 USDCx

5. Post Inbound Stream Time Elapse​

Post Inbound Stream

• Time Elapsed: 1000 seconds

• Current Balance: 970 USDCx

6. Deleting the Outbound Stream​

*Deleting Inbound Stream

• Static Balance: 970 USDCx

• Current Balance: 970 USDCx

Other Considerations​

Discrete Actions and Active Streams​

Transferring, wrapping, or unwrapping Super Tokens, being lump-sum actions, only affect the Static Balance and not the Real-Time Balance.

Interaction with Distributions​

Actions within Distributions have their own Real-Time Balance and are added separately to the overall account balance.

Solvency and Sentinels​

Accounts with negative net flow rates reaching zero balance are considered critical. Superfluid handles this with buffer deposits and Sentinels.

Buffer​

Buffer deposits are taken when opening a stream, serving as a reserve in case of a critical balance. If a stream is closed before hitting critical, the buffer is refunded. In cases where the account becomes critical, the buffer is used to continue outbound streams until Sentinels intervene.

Sentinels​

Sentinels are external actors who monitor Constant Flow Agreements (Money Streaming), close streams of critical accounts, and earn buffer deposits.

For more details, see the Liquidations and Sentinels pages.

Introduction to the Mini Game of the Crypto Tagomi Project

Welcome to the mini game of the Crypto Tagomi project – a unique entertainment experience that combines blockchain technology with gaming! Specifically designed to provide fun and excitement, this mini game not only helps players relax but also offers opportunities to earn rewards and learn about the crypto world.

1. Introduction to Tagomi

Crypto Tagomi is an innovative blockchain platform aimed at optimizing trading and managing digital assets. With the mission to provide users with the best tools and experiences, we have developed an engaging mini game to create interaction and connection within the crypto community.

2. Mini Game Content

The Tagomi mini game is an exciting strategy game where players take on the role of savvy traders in the volatile crypto market. Players must make smart decisions and strategies to optimize their profits, thereby enhancing their trading skills.

• How to Play:

  • Players will receive a certain amount of tokens to start trading.

  • Participate in virtual trading sessions where the values of cryptocurrencies change in real time.

  • Compete against other players to see who can achieve the highest profit within a limited time.

• Key Features:

  • Attractive Rewards: Players with the best performances will receive rewards in project tokens, which can be used in other activities on the Tagomi platform.

  • Ranking System: Players can track their achievements through a leaderboard and receive additional rewards for those who rank at the top.

  • Learning from Failures: The game not only entertains but also provides valuable lessons about trading and asset management.

3. Benefits of Participation

• Entertainment and Education: The mini game not only helps players relax but also equips them with essential knowledge about crypto trading.

• Community Connection: Participating in the mini game helps players connect with the crypto community, sharing experiences and strategies.

• Earning Opportunities: With attractive rewards, players can earn tokens and increase the value of their assets just by participating in the game.

4. Conclusion

The mini game of Crypto Tagomi is a fantastic opportunity to experience the crypto world in a fun and enriching way. Join today to explore, learn, and earn rewards in a creative and connected environment. We hope this game will provide you with relaxing moments and memorable experiences on your crypto journey!

How to Stake TGM Tokens:

1. Access the Staking Platform: Go to the staking platform provided by Tagomi.

2. Connect Wallet: Connect your wallet that holds the TGM tokens to the staking platform.

3. Choose Pool: Select the pool you want to stake your TGM tokens in based on the amount you hold.

4. Enter Amount: Enter the amount of TGM tokens you wish to stake in the chosen pool.

5. Confirm Staking: Confirm the staking transaction and wait for it to be processed.

6. Staking Period: Your staked TGM tokens will be locked in the chosen pool for a period of 10 days.

7. Earn Rewards: During the staking period, you will start earning staking rewards based on the APR (Annual Percentage Rate) of the chosen pool.

Staking Pool Details and Benefits:

• Pool 1 - 1000 to 40,000 TGM:

  • APR: 20%

  • Benefit: Users staking between 1000 to 40,000 TGM tokens will receive an APR of 20%, meaning they will earn a 20% annualized return on their staked TGM tokens.

• Pool 2 - > 40,000 to 120,000 TGM:

  • APR: 40%

  • Benefit: Users staking between > 40,000 to 120,000 TGM tokens will receive an APR of approximately 40%, offering a higher annualized return compared to Pool 1.

• Pool 3 - > 120,000 to 400,000 TGM:

  • APR: 80%

  • Benefit: Users staking between > 120,000 to 400,000 TGM tokens will receive an APR of approximately 80%, offering the highest annualized return and significant rewards for staking a larger amount of TGM tokens.

Overall Benefits of Staking:

• Passive Income: Staking TGM tokens allows users to earn passive income through staking rewards without actively trading or participating in the market.

• Higher Returns: By staking larger amounts of TGM tokens, users can benefit from higher APRs, leading to potentially higher returns on their investment.

• Community Participation: Staking also contributes to the stability and security of the Tagomi network by incentivizing token holders to actively participate in securing the network.

By following these steps and understanding the benefits, users can effectively stake their TGM tokens and earn rewards while contributing to the Tagomi ecosystem.

Introduction to the Metaverse of the Crypto Tagomi Project

Welcome to the Metaverse of the Crypto Tagomi project! We are excited to introduce a creative virtual space where users can interact, explore, and engage in various exciting activities within the blockchain world. Tagomi's Metaverse is not just a game or a social platform; it is a rich ecosystem that connects people through advanced technology.

1. Concept of Tagomi Metaverse

The Tagomi Metaverse is an interactive 3D space where users can create personal avatars and participate in diverse activities. Here, you can explore different areas, engage in role-playing games, socialize with the community, and even take part in virtual events. We aim to create an immersive and enriching experience, allowing users to fully enjoy the crypto world.

2. Key Features of Tagomi Metaverse

• Social Interaction: Meet and connect with other crypto enthusiasts from around the world. Share ideas, strategies, and participate in lively discussions within the community.

• Games and Activities: Join engaging games and other entertainment activities where you can earn rewards and enhance your skills.

• NFT Marketplace: Explore and trade unique NFTs within the Metaverse, from characters and items to virtual real estate. This is an opportunity for you to invest and grow your assets in the virtual space.

3. Benefits of Participating in Tagomi Metaverse

• Rich Experience: The Tagomi Metaverse offers a diverse and enriching experience where you can discover new and exciting things.

• Connection Opportunities: Joining the Metaverse allows you to connect with a global crypto community, expanding your network and seeking collaboration opportunities.

• Earning Potential: Through activities in the Metaverse, users can earn money from games, NFT trading, and participating in special events.

4. Conclusion

The Metaverse of the Crypto Tagomi project is a unique virtual space that combines blockchain technology with entertainment experiences. We invite you to join us on a journey of exploration, interaction, and development in a vibrant and captivating virtual world. Let’s build the Tagomi community together and experience the wonderful things that the Metaverse has to offer!

TOKENOMIC:

• Ticker: TGM

• Token type: BEP-20

• IDO Token Price: 3,000 TGM = 1 BNB

• Total Tokens: 300,000,000

• Smart Contract:

TOKEN DISTRIBUTION:

• Advisors – 6%

• Liquidity (DEX & CEX) – 10%

• Liquidity mining – 5%

• Ecosystem – 12%

• Seed - 6%

• Strategic pertnership – 9%

• Community rewards – 5%

• Pre-sale – 8%

• Airdrop - 3%

• Public listing – 3%

• Reserve – 18%

• Team – 15%

FUNDS ALLOCATION:

• Operational – 16.7%

• General costs – 8.3%

• Initial liquidity – 15%

• Marketing – 10%

• Development – 50%

Tagomi ($TGM) Airdrop Announcement The Tagomi project is officially launching an exciting Airdrop program for the community with attractive rewards! To show our appreciation for the support, we are allocating 3% of the total supply of 300,000,000 $TGM, equivalent to 9,000,000 $TGM, as rewards for this Airdrop event.

1. Overview of the $TGM Airdrop

The Airdrop is a fantastic opportunity for users to participate and earn free $TGM tokens from the Tagomi project. Through this event, we aim to strengthen and grow our community.

2. How to Participate in the Airdrop

To join the Airdrop program, simply follow these steps:

• Follow Tagomi's Official X Account: Make sure you're following us on X to stay updated on all important news.

• Join the Official Telegram Community: Join our official Telegram group to stay in the loop about updates and events.

• Complete the Required Tasks: Airdrop tasks may include sharing project information, inviting friends to join, and interacting with Tagomi’s posts on social media platforms.

• Earn Points for Completing Tasks: Each completed task will earn participants points, and these points will later be converted into $TGM tokens based on the total number of points earned. The more tasks completed, the more points (and thus tokens) you can earn!

• Fill Out the Airdrop Participation Form: Once you've completed the above steps, submit your information through the registration form so we can contact you and verify your eligibility.

3. Airdrop Reward Rules and Guidelines

• Honesty: We ask all participants to be honest while participating in the Airdrop. Any form of cheating or creating fake accounts to gain an unfair advantage will result in disqualification.

• Point-to-Token Conversion: Points accumulated during the Airdrop will be converted into $TGM tokens. These tokens will be distributed once the project launches its IDO (Initial DEX Offering) for $TGM. The more points you earn, the more $TGM tokens you'll receive!

• Reward Announcement: The list of Airdrop reward recipients will be publicly announced on Tagomi’s official X account. Stay tuned so you don’t miss out!

• Reward Distribution Timeline: $TGM rewards will be sent to participants' wallets after the event concludes and the winners are announced. Please be patient as we ensure prompt reward distribution.

• Eligibility and Fairness: Everyone who participates has a chance to win, based on the number of tasks completed and the validity of the information provided.

4. Conclusion

Tagomi hopes that this Airdrop event will help the community grow and become stronger. It’s a great opportunity to earn valuable rewards and be a crucial part of the $TGM project. Complete tasks, earn points, and convert them into tokens when we launch our IDO!

Follow our X account and join the community channels for more details about this event. Thank you for your support, and get ready to join the Airdrop today!

Follow us on X for updates: @TAGOMI_Web3

Introduction to the Trading Feature on the Tagomi App

Welcome to the trading feature on the Tagomi app – a powerful tool designed to help you optimize your trading of digital assets. By utilizing the latest market analysis and price trend technologies, Tagomi not only provides users with a smooth trading experience but also offers essential insights for making informed decisions.

1. Cutting-Edge Trading Features The trading feature of Tagomi allows users to execute transactions quickly and efficiently. Users can easily buy and sell thousands of digital assets across multiple exchanges from a single interface. Notably, Tagomi supports large-volume trading, helping you maximize profits without impacting the market. Additionally, for every successful trade, users will earn 5 Points, enhancing the rewards for their trading activity.

2. Modern Market Analysis Technology

   • Technical Analysis: Tagomi provides advanced technical analysis tools, including real-time price charts, technical indicators (RSI, MACD, Bollinger Bands, etc.), and candlestick patterns, enabling users to accurately capture market trends.

   • Sentiment Analysis: The app integrates sentiment analysis technology that gathers data from news sources and social media to evaluate market psychology. By analyzing community reactions, users can make informed trading decisions.

   • Price Prediction: Utilizing AI and machine learning technology, Tagomi offers predictions on future price movements. Predictive models are trained on historical data and current indicators, providing users with deeper insights into market trends.

3. User-Friendly and Intuitive Interface Tagomi features a user-friendly interface that makes it easy for both beginners and experienced traders to navigate and use. Users can quickly access analysis tools, place trades, and monitor their assets with just a few clicks.

4. Security and Reliability Tagomi is committed to providing a safe trading environment. All transactions are encrypted and validated through multiple layers of security. Users can trade with peace of mind, knowing that their information and assets are well protected.

5. Conclusion The trading feature on the Tagomi app offers users a powerful and flexible tool for engaging in the crypto market. With advanced market analysis and price trend technology, Tagomi not only helps you make informed decisions but also optimizes your trading profits. Experience and explore the world of trading potential with Tagomi today, and don’t forget to earn 5 Points for every winning trade!

Tagomi Protocol introduces innovative methods for community engagement and social token incentives, fostering long-term loyalty and participation.

Gradual Social Token Incentives​

Rather than distributing social tokens in a single airdrop, Tagomi enables a gradual, by-the-second streaming of tokens to community members or creator audiences.

Concept​

• Long-Term Engagement: This model rewards ongoing loyalty and engagement, as opposed to immediate lump-sum airdrops.

• Example: Consider the scenario where the longer an individual holds a community NFT, the more social tokens they accrue, discouraging immediate selling post-airdrop.

Explore this concept with the Reverb project, a platform that streams social tokens based on music listening habits.

Perpetual Conditional Rewards (PCR)​

The PCR model within the Tagomi Protocol offers a scalable way to incentivize community actions based on specific Key Performance Indicators (KPIs).

Mechanism​

• Reward Distribution: Rewards are streamed to participants based on progress towards a KPI metric.

• Funding and Execution: Funded through money streams and distributed using the Tagomi Instant Distribution Agreement, with KPI verification via UMA's KPI Options.

Perpetual Conditional Rewards

Use Cases​

• Community Incentives: Communities can incentivize members for activities like increasing Twitter followers or GitHub repo stars.

• Scalable Incentives: This system provides a method to reward members proportionally for contributing to communal goals.

For a deeper dive into the PCR concept, refer to this Twitter thread by UMAprotocol.

Tagomi's approach to social tokens and community incentives represents a shift towards more dynamic and engagement-focused reward systems in the digital space.

Tagomi Project Announces Pre-sale IDO for TGM Token!

Tagomi is excited to announce the upcoming Pre-sale IDO for our $TGM token, giving our valued partners, loyal customers, and supportive community an exclusive opportunity to purchase $TGM at an early stage. As part of this special event, we are allocating 8% of the total supply of 300,000,000 $TGM tokens, equivalent to 24,000,000 $TGM.

This Pre-sale IDO is a chance to become an early tor in the project and acquire tokens at a limited, discounted rate. Act fast, as token availability is limited, and the demand is high!

1. Pre-sale IDO Overview

The Pre-sale IDO (Initial DEX Offering) is an exclusive event that allows early access to $TGM tokens before they are fully listed on the public market. This is a golden opportunity for early supporters to own $TGM tokens and enjoy the long-term potential of the Tagomi project.

We are thrilled to reward our community and partners with this Pre-sale phase, as they have been instrumental in helping us build and shape Tagomi from the very beginning.

2. How to Purchase $TGM Tokens

To participate in the Pre-sale IDO and purchase $TGM tokens, please follow these steps on the official Tagomi website:

1. Visit the Official Tagomi Website:

   • Go to https://tagomi.tech/, the official platform for all information and updates on the Tagomi project.

2. Create an Account:

   • If you haven't already, register for an account on the Tagomi website. Ensure you provide accurate details and secure your account.

3. Connect Your Wallet:

   • Once logged in, link your cryptocurrency wallet (such as MetaMask, Trust Wallet, or others) to the Tagomi platform. Make sure your wallet is loaded with supported cryptocurrencies (ETH, BNB, USDT, etc.) to complete the transaction.

4. Access the Pre-sale IDO Section:

   • Navigate to the dedicated Pre-sale IDO section on the website. Here, you’ll find all the information regarding the token price, allocation limits, and current availability.

5. Select the Amount of $TGM Tokens:

   • Choose how many $TGM tokens you wish to purchase, keeping in mind that there may be individual purchase limits due to the limited supply.

6. Confirm and Complete the Purchase:

   • After selecting your desired amount, confirm the purchase. You will be prompted to approve the transaction from your wallet. Once the transaction is confirmed, you will receive your $TGM tokens directly in your linked wallet.

7. Stay Updated:

   • After purchasing, keep an eye on updates through our website and social media channels for important information regarding token listing and the next steps in the project’s roadmap.

3. Why Participate in the Pre-sale IDO?

• Exclusive Access: Get $TGM tokens before they are available to the public.

• Discounted Pricing: Early participants can buy tokens at a special pre-sale price, which may increase when $TGM is listed on exchanges.

• Limited Supply: Only 8% of the total token supply is available for the Pre-sale IDO, so don’t miss your chance to secure your share.

• Support the Project: By participating in this early phase, you are directly contributing to the growth and development of Tagomi and its ecosystem.

4. Join the Tagomi Movement

The Pre-sale IDO for $TGM is a significant milestone for the Tagomi project, and we want you to be a part of it! As we continue to innovate and grow, holding $TGM tokens will give you access to various future benefits within the Tagomi ecosystem, from governance to exclusive features.

Visit the official website now: https://tagomi.tech/ and secure your $TGM tokens before they run out. Thank you for your continued trust and support!

Follow Tagomi for Updates:

Stay informed by following our official channels:

• X: @TAGOMI_Web3

• Telegram: Tagomi Telegram

Don’t miss your opportunity to be an early investor in one of the most promising projects of the year!

Pre-sale IDO 6 round

Round 1: 1 BNB = 3000 $TGM

Round 2: 1 BNB = 2850 $TGM

Round 3: 1BNB = 2700 $TGM

Round 4: 1BNB = 2550 $TGM

Round 5: 1BNB = 2400 $TGM

Round 6: 1BNB = 2250 $TGM

Super Apps represents a class of smart contracts that interact seamlessly with the Tagomi Protocol, enabling dynamic responses to Money streaming or Distributions (Also called Super Agreements).

Definition

Super Apps are smart contracts registered with the Tagomi Protocol, designed to react to Super Agreements. These reactions are facilitated through callbacks, allowing Super Apps to engage dynamically with the creation, modification, and termination of Super Agreements.

Reacting to Super Agreements

The reactivity of Super Apps stems from callbacks. These are segments of code within the Super App that are triggered when a Super Agreement involving the Super App is created, updated, or deleted. Such callbacks can execute various actions, from minting NFTs to initiating new Streams (Constant Flow Agreements).

Example - Stream Consolidator Super App

Consider a Super App designed to consolidate all incoming flows into a single outgoing flow to a specific account (Account Z):

1. Incoming Flow from Account A: Account A initiates a Money Stream to the Super App (100 USDCx/mo). The Super App, in turn, starts an outbound Stream of the same rate to Account Z.

2. Multiple Flow Adjustments: If Account B starts a new Money Stream to the Super App (25 USDCx/mo) and Account A adjusts its flow (to 50 USDCx/mo), the Super App responds by updating its outbound Streams accordingly.

3. Ongoing Reactions: The Super App continues to adapt to new Money Streams or adjustments from various accounts, maintaining a reactive outbound flow.

info

NOTE: For a smart contract to qualify as a Super App, it must have defined callbacks to interact with Super Agreements.

Registering With The Protocol

Registration of a Super App with the Tagomi Protocol is crucial. This registration process involves coding the smart contract to be identifiable as a Super App within the protocol.

Purpose of Registration

• Protocol Recognition: When a stream is initiated towards a contract, the Tagomi Protocol checks if the recipient is a registered Super App.

• Callback Activation: If identified as a Super App, the protocol activates the Super App's callbacks, enabling its reactive capabilities.

Super App Registration

Why Are Super Apps Needed?

Super Apps introduce a layer of programmability to Super Agreements, enhancing the potential for innovative decentralized applications (dApps).

Potential Use Cases

• Lending Applications: Automate loan repayments through Streams, eliminating the need for manual transactions.

• Subscription Services: Enable on-chain subscriptions paid via Streams, incorporating features like automatic affiliate payouts.

Super Apps open up a realm of possibilities, combining custom logic with the functionalities of Super Agreements to craft unique and scalable dApps.

For further inspiration, explore the following examples of Super Apps:

Explore Super App Examples

Super Tokens extend the BEP20 token standard with additional functionalities like Money Streaming or Distributions, formerly known as Super Agreements. There are two types of Super Tokens: wrapper and custom.

Super Tokens can perform all the functions of a traditional BEP20 token, plus additional value transfer methods enabled by Tagomi, such as money streaming.

Wrapper Super Tokens

Wrapper Super Tokens are existing tokens wrapped to gain Tagomi functionalities. Wrapping converts the underlying token into its Super Token version, while unwrapping reverses the process.

Drag the tokens together to create a SUPER TOKEN!Your TokenWrapper Super TokenYour token is normal - drag it to give it superpowers!

By wrapping the original token you obtain a SUPER TOKEN

For more informations, about the wrapping process, please refer to our Developers Section.

Pure Super Tokens

Pure Super Tokens are natively Tagomi-enabled without an underlying token. They offer inherent ERC20 functionalities plus Tagomi's Super Agreement capabilities.

Click as quickly as possible on the Pure Super Token to create your first stream!Pure Super Token

A Pure Super Token has inherent superpowers such as Money Streaming and Distributions

Real-Time Balance

Super Tokens track an account's balance dynamically, factoring in both regular transfers and impacts from Money Streaming and Distributions.

• Static Balance: The standard BEP20 balance affected by lump-sum transfers.

• Real-Time Balances: The ongoing impact of each Super Agreement on an account's balance, which can be positive or negative.

The actual current balance is a sum of these components.

Current Balance Formula: Current Balance = Real-Time Balances + Static Balance

Example Calculation

• Account A's Static Balance: 1,000 USDCx

• Account A's Stream Out: -100 USDCx

• Account A's Instant Distribution Receipts: +200 USDCx

Current Balance: 1000 - 100 + 200 = 1100 USDCx

About Super Tokens balanceOf()

If you are familiar with the BEP20 standard, you are certainly familiar with balanceOf(). A Super Token balanceOf() function reflects this dynamic balance, unlike a regular BEP20's static approach.

Token-Cost-Averaging* (TCA) is one possible application designed to leverage the power of Tagomi streams. This application could allow the user to swap tokens in continuous real-time streams: stream in your Sell token and receive back the Buy token periodically.

What is Token-Cost-Averaging (TCA)?

Token-Cost-Averaging (TCA) is an investment strategy where an investor divides up the total amount to be invested across periodic purchases of a target asset (just like Dollar-Cost-Averaging but it's asset agnostic). This strategy gives users the best results over time by swapping tokens in continuous real-time streams: stream in your Sell token and receive back the Buy token periodically.

How does it work?

This application could be a new trading app powered by Tagomi. It could be designed to provide a more efficient and accessible way to perform Token-Cost-Averaging (TCA) by leveraging the power of Tagomi's streaming technology. Under the hood, the app would perform swaps time-continuously using a Time-Weighted Average Price (TWAP) oracle for liquidity source aggregation and a fair price over time.

The Tagomi Advantage

Compared to existing TCA or DCA (Dollar-Cost-Averaging) dApps built on other protocols, Tagomi offers several advantages:

• Efficiency and Accessibility: Building on Money Streams makes TCA more efficient and accessible. By using Tagomi's streaming technology, it allows for continuous and automated investment flows, reducing the need for manual intervention and making investment more seamless and user-friendly.

• Reduced Volatility Impact: The core idea of TCA is to mitigate the risks associated with volatile market conditions. Tagomi enhances this approach by allowing for more frequent and smaller investments, thereby further reducing the potential impact of sudden market changes.

• Innovation in DeFi: By leveraging Tagomi's groundbreaking streaming technology, this TCA app stands at the forefront of innovation in decentralized finance, offering a unique approach to cryptocurrency investments.

The Tagomi Host Contract is a central element of the Tagomi Protocol, acting as a hub connecting Super Tokens, Super Agreements, and Super Apps

Tagomi Host Contract

Let's explore how the Host Contract interacts with different components of the Tagomi Protocol.

Super Agreements 🔗 Host Contract

Super Agreements, each with their unique contracts, interface with the Host Contract. Interaction with a Super Agreement is typically done by calling callAgreement() on the Host Contract, specifying the agreement and parameters.

Key Points

• Upgradeability and Expansion: Super Agreements can be updated or new ones can be added and registered with the Host Contract.

info

NOTE: Direct interactions with Super Token contracts are not required for invoking Super Agreements. Instead, these agreements are accessed via the Host Contract, which then manages the Super Token balances involved.

Super Tokens 🔗 Host Contract

Super Tokens form the foundational layer of the Tagomi Protocol, where all Super Agreement data for an account is compiled.

Functionality

• Aggregated Balance Calculation: The impact of each Super Agreement on an account's balance is cumulatively calculated to determine the Super Token balance.

• Data Sourcing: Super Token contracts obtain necessary data through the Host Contract by iterating over the registered Super Agreements.

Super Apps 🔗 Host Contract

Registration of Super Apps with the Tagomi Host is essential to enable their callback functionalities.

Interaction Mechanics

• Registration Requirement: Super Apps must be registered with the Host to function correctly.

• Callback Activation: When a Super Agreement is engaged with a Super App, the Host Contract triggers the Super App's callbacks.

Super Apps and Host Contract

In summary, the Tagomi Host Contract is integral to the Tagomi Protocol, facilitating seamless interactions and integrations among Super Tokens, Super Agreements, and Super Apps.

Introduction

Tagomi is a revolutionary asset streaming and distribution protocol bringing subscriptions, salaries, vesting, and rewards to DAOs and crypto-native businesses worldwide. This is made possible by the protocol’s smart contract framework which introduces the Super Token - an extension to the BEP-20 standard enabling the transfer of value in completely novel ways.

Super Tokens

The Tagomi protocol is designed to be a "token-centric" protocol, in that all of its functionalities revolve around the concept of Super Tokens. The framework & Super Token standard can be used to add dynamic balances to tokens on chain, describing cash flows and executing them automatically over time in a non-interactive way. Any token can be transferred in Tagomi streams or distributions, which are programmable, composable, and modular. No capital is locked up, and all inflows and outflows are netted in real-time at every block without consuming any gas. The code is fully open source, while the protocol is non-custodial and permissionless.

The Tagomi Protocol has currently two main pillars that define its interactions with Super Tokens. These pillars (formerly called Agreements) are the following:

• Money Streaming - A set of features that enable the creation of money streams between two parties.

• Distributions - A set of features that enables the creation of a pool of funds that can be distributed to multiple recipients.

We go in further details about these two pillars in the next sections.

Money Streaming

Definition

Money Streaming is a continuous transfer of tokens from a sender to a receiver at a defined per-second rate, resulting in a "stream". This stream is perpetual and persists until it's canceled by either the sender or the receiver, or until the sender's Super Token balance is depleted.

Explanation

Money Streaming is a novel approach to token transfers, offering a dynamic way of sending funds. Instead of one-time transactions, tokens flow from the sender to the receiver continuously, creating a stream. This method provides real-time financial transactions, enabling a more fluid movement of assets over time, reflecting real-world economic activities more closely.

Example

A visualization of money streaming from the Tagomi dashboard

Consider Alice wants to pay Bob a salary of 1200 USDCx per year using Money Streaming. She sets up a stream with a flow rate of 0.038 USDCx per second. Bob's balance starts increasing every second, and Alice's decreases, ensuring a steady transfer of salary.

Distributions

Definition

Distributions in Tagomi refer to a scalable one-to-many fund transfer method. It involves creating pools with a pool admin managing units for members, who can receive funds instantly or through continuous streaming.

Explanation

Distributions are a significant advancement in decentralized finance, enabling efficient and scalable fund transfers among multiple recipients. This method is especially useful for scenarios where funds need to be distributed among many parties, like dividends or rewards, ensuring equitable and automated distribution based on predefined units.

Example

Imagine a DeFi project creating a reward pool for liquidity providers. The project sets up a distribution pool with a total of 1000 units. If a liquidity provider has 100 units, they receive 10% of the total funds distributed through the pool, either instantly or as a continuous stream, depending on the distribution method.

Library for Token Centric Interface

The SuperTokenV1Library is a solidity library that allows you to interact with the Tagomi Protocol. It is a comprehensive library for Tagomi protocol. It includes all the functions that are required to interact with the Tagomi protocol. It includes functions for interacting with Money Streaming and Distributions. In order to have access to the library, you need to:

• Import the library in your contract as such:

  import "@Tagomi-finance/bsc-contracts/contracts/apps/SuperTokenV1Library.sol";

• Make sure that you include the using statement in your contract:

  using SuperTokenV1Library for ISuperToken;

Note 1

In the case of interacting with Native Super Tokens you should use using SuperTokenV1Library for ISETH; instead.

Note 2

It is important to "warm up" the cache and cache the host, cfa, gda before calling, this is only applicable to Foundry tests where the vm.expectRevert() will not work as expected. You must use vm.startPrank(account) instead of vm.prank when executing functions if the cache isn't "warmed up" yet. vm.prank impersonates the account only for the first call, which will be used for caching.

Fn createFlow​

function createFlow(
    contract ISuperToken token,
    address receiver,
    int96 flowRate
) 
    internal 
    returns (bool)

Create flow without userData

Parameters​

Fn createFlow​

function createFlow(
    contract ISuperToken token,
    address receiver,
    int96 flowRate,
    bytes userData
) 
    internal 
    returns (bool)

Create flow with userData

Parameters​

Fn updateFlow​

function updateFlow(
    contract ISuperToken token,
    address receiver,
    int96 flowRate
) 
    internal 
    returns (bool)

Update flow without userData

Parameters​

Fn updateFlow (w/userData)​

function updateFlow(
    contract ISuperToken token,
    address receiver,
    int96 flowRate,
    bytes userData
) 
    internal 
    returns (bool)

Update flow with userData

Parameters​

Fn deleteFlow​

function deleteFlow(
    contract ISuperToken token,
    address sender,
    address receiver
) 
    internal 
    returns (bool)

Delete flow without userData

Parameters​

Fn deleteFlow (w/userData)​

function deleteFlow(
    contract ISuperToken token,
    address sender,
    address receiver,
    bytes userData
) 
    internal 
    returns (bool)

Delete flow with userData

Parameters​

Fn setFlowPermissions​

function setFlowPermissions(
    contract ISuperToken token,
    address flowOperator,
    bool allowCreate,
    bool allowUpdate,
    bool allowDelete,
    int96 flowRateAllowance
) 
    internal 
    returns (bool)

Update permissions for flow operator

Parameters​

Fn setMaxFlowPermissions​

function setMaxFlowPermissions(
    contract ISuperToken token,
    address flowOperator
) 
    internal 
    returns (bool)

Update permissions for flow operator - give operator max permissions

Parameters​

Fn revokeFlowPermissions​

function revokeFlowPermissions(
    contract ISuperToken token,
    address flowOperator
) 
    internal 
    returns (bool)

Update permissions for flow operator - revoke all permission

Parameters​

Fn increaseFlowRateAllowance​

function increaseFlowRateAllowance(
    contract ISuperToken token,
    address flowOperator,
    int96 addedFlowRateAllowance
) 
    internal 
    returns (bool)

Increases the flow rate allowance for flow operator

Parameters​

allowing userData to be a parameter here triggered stack too deep error

Fn increaseFlowRateAllowance (w/userData)​

function increaseFlowRateAllowance(
    contract ISuperToken token,
    address flowOperator,
    int96 addedFlowRateAllowance,
    bytes userData
) 
    internal 
    returns (bool)

Increases the flow rate allowance for flow operator

Parameters​

allowing userData to be a parameter here triggered stack too deep error

Fn decreaseFlowRateAllowance​

function decreaseFlowRateAllowance(
    contract ISuperToken token,
    address flowOperator,
    int96 subtractedFlowRateAllowance
) 
    internal 
    returns (bool)

Decreases the flow rate allowance for flow operator

Parameters​

allowing userData to be a parameter here triggered stack too deep error

Fn decreaseFlowRateAllowance (w/userData)​

function decreaseFlowRateAllowance(
    contract ISuperToken token,
    address flowOperator,
    int96 subtractedFlowRateAllowance,
    bytes userData
) 
    internal 
    returns (bool)

Decreases the flow rate allowance for flow operator

Parameters​

allowing userData to be a parameter here triggered stack too deep error

Fn increaseFlowRateAllowanceWithPermissions​

function increaseFlowRateAllowanceWithPermissions(
    contract ISuperToken token,
    address flowOperator,
    uint8 permissionsToAdd,
    int96 addedFlowRateAllowance
) 
    internal 
    returns (bool)

Increases the flow rate allowance for flow operator and adds the permissions

Parameters​

allowing userData to be a parameter here triggered stack too deep error

Fn increaseFlowRateAllowanceWithPermissions (w/userData)​

function increaseFlowRateAllowanceWithPermissions(
    contract ISuperToken token,
    address flowOperator,
    uint8 permissionsToAdd,
    int96 addedFlowRateAllowance,
    bytes userData
) 
    internal 
    returns (bool)

Increases the flow rate allowance for flow operator and adds the permissions

Parameters​

allowing userData to be a parameter here triggered stack too deep error

Fn decreaseFlowRateAllowanceWithPermissions​

function decreaseFlowRateAllowanceWithPermissions(
    contract ISuperToken token,
    address flowOperator,
    uint8 permissionsToRemove,
    int96 subtractedFlowRateAllowance
) 
    internal 
    returns (bool)

Decreases the flow rate allowance for flow operator and removes the permissions

Parameters​

allowing userData to be a parameter here triggered stack too deep error

Fn decreaseFlowRateAllowanceWithPermissions (w/userData)​

function decreaseFlowRateAllowanceWithPermissions(
    contract ISuperToken token,
    address flowOperator,
    uint8 permissionsToRemove,
    int96 subtractedFlowRateAllowance,
    bytes userData
) 
    internal 
    returns (bool)

Decreases the flow rate allowance for flow operator and removes the permissions

Parameters​

allowing userData to be a parameter here triggered stack too deep error

Fn setFlowPermissionsWithCtx​

function setFlowPermissionsWithCtx(
    contract ISuperToken token,
    address flowOperator,
    bool allowCreate,
    bool allowUpdate,
    bool allowDelete,
    int96 flowRateAllowance,
    bytes ctx
) 
    internal 
    returns (bytes newCtx)

Update permissions for flow operator in callback

Parameters​

Return Values​

allowing userData to be a parameter here triggered stack too deep error

Fn setMaxFlowPermissionsWithCtx​

function setMaxFlowPermissionsWithCtx(
    contract ISuperToken token,
    address flowOperator,
    bytes ctx
) 
    internal 
    returns (bytes newCtx)

Update permissions for flow operator - give operator max permissions

Parameters​

Return Values​

Fn revokeFlowPermissionsWithCtx​

function revokeFlowPermissionsWithCtx(
    contract ISuperToken token,
    address flowOperator,
    bytes ctx
) 
    internal 
    returns (bytes newCtx)

Update permissions for flow operator - revoke all permission

Parameters​

Return Values​

Fn createFlowFrom​

function createFlowFrom(
    contract ISuperToken token,
    address sender,
    address receiver,
    int96 flowRate
) 
    internal 
    returns (bool)

Creates flow as an operator without userData

Parameters​

Fn createFlowFrom (w/userData)​

function createFlowFrom(
    contract ISuperToken token,
    address sender,
    address receiver,
    int96 flowRate,
    bytes userData
) 
    internal 
    returns (bool)

Creates flow as an operator with userData

Parameters​

Fn updateFlowFrom​

function updateFlowFrom(
    contract ISuperToken token,
    address sender,
    address receiver,
    int96 flowRate
) 
    internal 
    returns (bool)

Updates flow as an operator without userData

Parameters​

Fn updateFlowFrom (w/userData)​

function updateFlowFrom(
    contract ISuperToken token,
    address sender,
    address receiver,
    int96 flowRate,
    bytes userData
) 
    internal 
    returns (bool)

Updates flow as an operator with userData

Parameters​

Fn deleteFlowFrom​

function deleteFlowFrom(
    contract ISuperToken token,
    address sender,
    address receiver
) 
    internal 
    returns (bool)

Deletes flow as an operator without userData

Parameters​

Fn deleteFlowFrom (w/userData)​

function deleteFlowFrom(
    contract ISuperToken token,
    address sender,
    address receiver,
    bytes userData
) 
    internal 
    returns (bool)

Deletes flow as an operator with userData

Parameters​

Fn createFlowWithCtx​

function createFlowWithCtx(
    contract ISuperToken token,
    address receiver,
    int96 flowRate,
    bytes ctx
) 
    internal 
    returns (bytes newCtx)

Create flow with context and userData

Parameters​

Return Values​

Fn createFlowFromWithCtx​

function createFlowFromWithCtx(
    contract ISuperToken token,
    address sender,
    address receiver,
    int96 flowRate,
    bytes ctx
) 
    internal 
    returns (bytes newCtx)

Create flow by operator with context

Parameters​

Return Values​

Fn updateFlowWithCtx​

function updateFlowWithCtx(
    contract ISuperToken token,
    address receiver,
    int96 flowRate,
    bytes ctx
) 
    internal 
    returns (bytes newCtx)

Update flow with context

Parameters​

Return Values​

Fn updateFlowFromWithCtx​

function updateFlowFromWithCtx(
    contract ISuperToken token,
    address sender,
    address receiver,
    int96 flowRate,
    bytes ctx
) 
    internal 
    returns (bytes newCtx)

Update flow by operator with context

Parameters​

Return Values​

Fn deleteFlowWithCtx​

function deleteFlowWithCtx(
    contract ISuperToken token,
    address sender,
    address receiver,
    bytes ctx
) 
    internal 
    returns (bytes newCtx)

Delete flow with context

Parameters​

Return Values​

Fn deleteFlowFromWithCtx​

function deleteFlowFromWithCtx(
    contract ISuperToken token,
    address sender,
    address receiver,
    bytes ctx
) 
    internal 
    returns (bytes newCtx)

Delete flow by operator with context

Parameters​

Return Values​

Fn getFlowRate​

function getFlowRate(
    contract ISuperToken token,
    address sender,
    address receiver
) 
    internal 
    returns (int96 flowRate)

get flow rate between two accounts for given token

Parameters​

Return Values​

Fn getFlowInfo​

function getFlowInfo(
    contract ISuperToken token,
    address sender,
    address receiver
) 
    internal 
    returns (uint256 lastUpdated, int96 flowRate, uint256 deposit, uint256 owedDeposit)

get flow info between two accounts for given token

Parameters​

Return Values​

Fn getNetFlowRate​

function getNetFlowRate(
    contract ISuperToken token,
    address account
) 
    internal 
    returns (int96 flowRate)

get net flow rate for given account for given token (CFA + GDA)

Parameters​

Return Values​

Fn getCFANetFlowRate​

function getCFANetFlowRate(
    contract ISuperToken token,
    address account
) 
    internal 
    returns (int96 flowRate)

get CFA net flow rate for given account for given token

Parameters​

Return Values​

Fn getGDANetFlowRate​

function getGDANetFlowRate(
    contract ISuperToken token,
    address account
) 
    internal 
    returns (int96 flowRate)

get GDA net flow rate for given account for given token

Parameters​

Return Values​

Fn getNetFlowInfo​

function getNetFlowInfo(
    contract ISuperToken token,
    address account
) 
    internal 
    returns (uint256 lastUpdated, int96 flowRate, uint256 deposit, uint256 owedDeposit)

get the aggregated flow info of the account

Parameters​

Return Values​

Fn getBufferAmountByFlowRate​

function getBufferAmountByFlowRate(
    contract ISuperToken token,
    int96 flowRate
) 
    internal 
    returns (uint256 bufferAmount)

calculate buffer for a flow rate

Parameters​

Return Values​

Fn getFlowPermissions​

function getFlowPermissions(
    contract ISuperToken token,
    address sender,
    address flowOperator
) 
    internal 
    returns (bool allowCreate, bool allowUpdate, bool allowDelete, int96 flowRateAllowance)

get existing flow permissions

Parameters​

Return Values​

Fn getIndex​

function getIndex(
    contract ISuperToken token,
    address publisher,
    uint32 indexId
) 
    internal 
    returns (bool exist, uint128 indexValue, uint128 totalUnitsApproved, uint128 totalUnitsPending)

Gets an index by its ID and publisher.

Parameters​

Return Values​

Fn calculateDistribution​

function calculateDistribution(
    contract ISuperToken token,
    address publisher,
    uint32 indexId,
    uint256 amount
) 
    internal 
    returns (uint256 actualAmount, uint128 newIndexValue)

Calculates the distribution amount based on the amount of tokens desired to distribute.

Parameters​

Return Values​

Fn listSubscriptions​

function listSubscriptions(
    contract ISuperToken token,
    address subscriber
) 
    internal 
    returns (address[] publishers, uint32[] indexIds, uint128[] unitsList)

List all subscriptions of an address

Parameters​

Return Values​

Fn getSubscription​

function getSubscription(
    contract ISuperToken token,
    address publisher,
    uint32 indexId,
    address subscriber
) 
    internal 
    returns (bool exist, bool approved, uint128 units, uint256 pendingDistribution)

Gets subscription by publisher, index id, and subscriber.

Parameters​

Return Values​

Fn getSubscriptionByID​

function getSubscriptionByID(
    contract ISuperToken token,
    bytes32 agreementId
) 
    internal 
    returns (address publisher, uint32 indexId, bool approved, uint128 units, uint256 pendingDistribution)

Parameters​

Fn getFlowDistributionFlowRate​

function getFlowDistributionFlowRate(
    contract ISuperToken token,
    address from,
    contract ITagomiPool to
) 
    internal 
    returns (int96)

Parameters​

GDA VIEW FUNCTIONS *************************************

Fn estimateFlowDistributionActualFlowRate​

function estimateFlowDistributionActualFlowRate(
    contract ISuperToken token,
    address from,
    contract ITagomiPool to,
    int96 requestedFlowRate
) 
    internal 
    returns (int96 actualFlowRate, int96 totalDistributionFlowRate)

Parameters​

Fn estimateDistributionActualAmount​

function estimateDistributionActualAmount(
    contract ISuperToken token,
    address from,
    contract ITagomiPool to,
    uint256 requestedAmount
) 
    internal 
    returns (uint256 actualAmount)

Parameters​

Fn isMemberConnected​

function isMemberConnected(
    contract ISuperToken token,
    address pool,
    address member
) 
    internal 
    returns (bool)

Parameters​

Fn createIndex​

function createIndex(
    contract ISuperToken token,
    uint32 indexId
) 
    internal 
    returns (bool)

Creates a new index.

Parameters​

Fn createIndex​

function createIndex(
    contract ISuperToken token,
    uint32 indexId,
    bytes userData
) 
    internal 
    returns (bool)

Creates a new index with userData.

Parameters​

Fn updateIndexValue​

function updateIndexValue(
    contract ISuperToken token,
    uint32 indexId,
    uint128 indexValue
) 
    internal 
    returns (bool)

Updates an index value. This distributes an amount of tokens equal to indexValue - lastIndexValue. See distribute for another way to distribute.

Parameters​

Fn updateIndexValue​

function updateIndexValue(
    contract ISuperToken token,
    uint32 indexId,
    uint128 indexValue,
    bytes userData
) 
    internal 
    returns (bool)

Updates an index value with userData. This distributes an amount of tokens equal to indexValue - lastIndexValue. See distribute for another way to distribute.

Parameters​

Fn distribute​

function distribute(
    contract ISuperToken token,
    uint32 indexId,
    uint256 amount
) 
    internal 
    returns (bool)

Distributes tokens in a more developer friendly way than updateIndex. Instead of passing the new total index value, you pass the amount of tokens desired to be distributed.

Parameters​

Fn distribute (w/userData)​

function distribute(
    contract ISuperToken token,
    uint32 indexId,
    uint256 amount,
    bytes userData
) 
    internal 
    returns (bool)

Distributes tokens in a more developer friendly way than updateIndex (w user data). Instead of passing the new total index value, this function will increase the index value by amount. This takes arbitrary user data.

Parameters​

Fn approveSubscription​

function approveSubscription(
    contract ISuperToken token,
    address publisher,
    uint32 indexId
) 
    internal 
    returns (bool)

Approves a subscription to an index. The subscriber's real time balance will not update until the subscription is approved, but once approved, the balance will be updated with prior distributions.

Parameters​

Fn approveSubscription (w/userData)​

function approveSubscription(
    contract ISuperToken token,
    address publisher,
    uint32 indexId,
    bytes userData
) 
    internal 
    returns (bool)

Approves a subscription to an index with user data. The subscriber's real time balance will not update until the subscription is approved, but once approved, the balance will be updated with prior distributions.

Parameters​

Fn revokeSubscription​

function revokeSubscription(
    contract ISuperToken token,
    address publisher,
    uint32 indexId
) 
    internal 
    returns (bool)

Revokes a previously approved subscription.

Parameters​

Fn revokeSubscription (w/userData)​

function revokeSubscription(
    contract ISuperToken token,
    address publisher,
    uint32 indexId,
    bytes userData
) 
    internal 
    returns (bool)

Revokes a previously approved subscription. This takes arbitrary user data.

Parameters​

Fn updateSubscriptionUnits​

function updateSubscriptionUnits(
    contract ISuperToken token,
    uint32 indexId,
    address subscriber,
    uint128 units
) 
    internal 
    returns (bool)

Updates the units of a subscription. This changes the number of shares the subscriber holds

Parameters​

Fn updateSubscriptionUnits (w/userData)​

function updateSubscriptionUnits(
    contract ISuperToken token,
    uint32 indexId,
    address subscriber,
    uint128 units,
    bytes userData
) 
    internal 
    returns (bool)

Updates the units of a subscription. This changes the number of shares the subscriber holds. This takes arbitrary user data.

Parameters​

Fn deleteSubscription​

function deleteSubscription(
    contract ISuperToken token,
    address publisher,
    uint32 indexId,
    address subscriber
) 
    internal 
    returns (bool)

Deletes a subscription, setting a subcriber's units to zero

Parameters​