DOCSEARCHbyAlgolia
Submit Docs

Colony SDK Documentation

website·Indexed 35 days ago

https://docs.colony.io

Documentation for the Colony SDK, featuring API references for MultisigPermissionsEvents, WhitelistEvents, and metadata management via IPFS. Includes guides on recovery mode, feature overviews for meritocratic organization protocols, and type aliases for task and token events.

Tokens
486.9K
Snippets
4.2K
Records
5.2K
Agent score
62%

What's inside Colony

  1. Overview of the Token Supplier extension

    The Token Supplier (TokenSupplier) is a Colony extension that enables a colony to automatically manage its token supply. It allows the colony to define a maximum supply ceiling and a daily issuance rate. Once configured, tokens can be continually minted and sent to the colony based on these parameters.

  2. Overview of OneTxPaymentClientV8 Interface

    The OneTxPaymentClientV8 interface extends AugmentedOneTxPayment<OneTxPayment>. It provides a structured way to interact with the OneTxPayment contract, including access to the contract address and internal state management for deployed promises and event emissions.

  3. Overview of the VotingReputation Extension

    The VotingReputation extension enables any colony member to propose a Motion to perform an Action (e.g., creating expenditures, managing funds, or managing teams). A motion will pass and execute after a security delay unless a member objects to it. This extension conforms to the standard Colony extension interface.

  4. Overview of the IColony interface

    The IColony interface represents the main body of functionality for a colony. It acts as the 'operating system' of the colony, providing essential system calls to manage underlying resources such as roles, permissions, the creation of new domains and expenditures, and the movement of resources. Extensions (which act as 'applications') interact with the colony by calling these functions, and authorized users can call them directly.

  5. Overview of One Transaction Payment Extension (OneTxPayment)

    The OneTxPayment extension allows a single authorized individual to create, fund, and finalize a payment within one transaction. Ordinarily, the payment lifecycle requires multiple transactions due to different permissioned roles. To use this extension, the caller must possess both Funding and Administration roles within the domain of the payment. If a Colony was deployed using the Dapp, this extension is installed by default.

  6. Overview of EvaluatedExpenditure extension

    The EvaluatedExpenditure extension allows the owner of an expenditure to update payout modifiers after the expenditure has been locked. This enables 'evaluation' functionality within Tasks flows. Without this extension, payout modifiers can only be modified by the Arbitration permission once locked.

  7. Overview of Staked Expenditure extension

    The Staked Expenditure extension enables users who lack Administration permissions to initiate expenditures by posting a small stake. If the expenditure is refined and finalized without issue, the stake is returned to the user. However, if the creator is found to have acted inappropriately, they risk losing their stake.

  8. Overview of the Colony DAO framework

    Colony is a DAO framework designed to provide organizations with on-chain operational tools including payments, team management, authority, governance, fundraising, revenue sharing, and arbitration. It allows organizations to interact with any other smart contract on Ethereum.

    Key architectural features include:

    • Lazy Consensus: A system designed to reduce the frequency of voting to increase organizational productivity.
    • Colony Core: Provides the fundamental primitives for finances, organizational structure, and authority.
    • Extensions: Plug-ins that build upon the Core to customize the organization's functionality based on specific needs.

  9. Overview of ColonyTxCreator

    The ColonyTxCreator class is an umbrella API used to handle various transaction types within a colony. It is typically instantiated via methods on base contracts (such as Colony) or extensions (such as VotingReputation). It provides four primary ways to initiate actions: standard transactions, gasless metatransactions, motions, and gasless motions.

  10. Overview of Streaming Payments (StreamingPayments)

    The StreamingPayments extension enables ongoing 'streaming' payments, which are ideal for implementing salaries. Users with Administration and Funding permissions can define the token type and amount to be transferred over a specific time interval. Recipients can then claim these tokens continually at their preferred frequency.

  11. Overview of the IRecovery interface

    The IRecovery internal contract provides recovery functionality to colonies and the Colony Network. Its primary purpose is to manage 'recovery roles' and a 'recovery mode'. When recovery mode is active, authorized users can perform direct writes to a colony's underlying storage to fix critical bugs or resolve security failures.