v4.0.0

Release Highlights

This colonyJS release adds support for Extension Clients Versioning allowing for extensions themselves to be separated from the colony client all whilst having their own versions and upgrade paths.

The version work independently of the colony contract clients as long as the extension's version is supported by the current colony contract version, will work as expected.

As with the colony clients, the extensions have support for add-on methods that will help in cases where the method calls need permissioning proofs, in order to make development live easier.

As an example for this, you can look up createDomainMotionWithProofs, stakeMotionWithProofs, escalateMotionWithProofs and claimRewardWithProofs from the VotingReputation extension.

New Clients

• Colony version 7 client
• CoinMachine extension, version 2 client
• VotingReputation extension, version 2 client
• OneTxPayment extension, version 2 client

Fixes:

• #483 Fixed to the setUserRolesWithProofs helper -- by @alicjakujawa
• #485 getReputation helper now has a customRootHash prop -- by @ArmandoGraterol

Maintenance:

• #482 Automatically create versioned extension client files/folders based on the latest version(s)

v3.0.0

This release update the colony-js library to be able to use the latest lwss release of colonyNetwork.

Alongside the above, we have a couple of minor fixes and improvements:

• updated the way typechain generates the interfaces and factories
• v5 client now has access to all historic events
• minor fixes to the v2 colony client
• fixed the getColonyRoles helper function

🎊 The TypeScript release 🎊

Please welcome our biggest release yet! After months of effort and a total rewrite of colonyJS we are proud to announce the next version: v2.0.0!

It almost doesn't make any sense to post a changelog as virtually everything has changed.

Expect the following features:

• Everything is TypeScript now 🎉
• Versioned Colony clients (for all of the versions colonies can have)
• Just one package: npm install @colony/colony-js and you're done!
• All of the clients are just extended ethers contracts now
• Automatically generated documentation available under https://joincolony.github.io/colonyJS
• Convenient helper and utility functions

We hope you'll enjoy using it in your project when building with Colony.

v1.13.2

New Features

• Add verbose option to ContractClient (@colony/colony-js-contract-client)
• Add verbose option to getColonyClient method (@colony/colony-js-client)
• Add verbose option to getNetworkClient method (@colony/colony-js-client)

Bug Fixes

• Fix parameters in makeExecuteTaskRoleChange (@colony/colony-js-client)

v1.13.1

Bug fixes

• Do not supply a nonce value for outgoing transactions when using a MetaMask wallet (@colony/colony-js-client)

v1.13.0

New Features

• Add getColonyClient method (@colony/colony-js-client)
• Add mainnet option to getNetworkClient (@colony/colony-js-client)
• Add mainnet support to network loader (@colony/colony-js-contract-loader-network)
• Add version 2 deployment to network loader (@colony/colony-js-contract-loader-network)

Bug Fixes

• Fix DomainAuth sender to account for defaultValues (@colony/colony-js-client)
• Fix makeExecuteTaskRoleChange input to use address (@colony/colony-js-client)
• Patch lookupRegisteredENSDomain for testnets. Domains were previously being returned ending in .eth on networks where the deployed ENS uses the .test TLD (@colony/colony-js-client)
• Fix getLogs method to correctly format topic filters (@colony/colony-js-contract-client)

Maintenance

• Update getReputation method for use with mainnet and goerli (@colony/colony-js-client)

• Add ColonyRoleSet event, which replaces the existing role set events as the output of any methods which previously used them. The existing events remain in the client for the purpose of parsing logs which were created by previous versions of the contract (@colony/colony-js-client)

• Improve thrown error for DomainAuth sender methods when the current address does not have permission (@colony/colony-js-client)

• Remove rinkeby deployments from network loader, as they are no longer supported (@colony/colony-js-contract-loader-network)

• Remove unused network support from getNetworkClient (@colony/colony-js-client)

• Updated caller methods in TokenClient (@colony/colony-js-client)

  • Updated approve
    • Changed user input parameter to address
  • Updated burn
    • Changed user input parameter to address
  • Updated mint
    • Changed user input parameter to address

• Updated sender methods in TokenClient (@colony/colony-js-client)

  • Updated getAllowance
    • Changed user input parameter to address

v1.12.0

This release implements significant changes and additions that enables support for the colonyNetwork glider-rc.1 release. Please do not hesitate to reach out to us on Discourse or Gitter if you are having any issues updating to this release.

Also, please note that colonyJS is currently using ethers version 3.0.27.

New Features

• Added goerli as a getNetworkClient option (@colony/colony-js-client)
• Added goerli to network loader (@colony/colony-js-contract-loader-network)

Types

• Added [number] param type (@colony/colony-js-contract-client)
• Renamed tokenAddress param type to anyAddress to better reflect its uses (@colony/colony-js-contract-client)

Maintenance

• Updated constants (@colony/colony-js-client)

  • Added COLONY_ROLE_ADMINISTRATION
  • Added COLONY_ROLE_ARBITRATION
  • Added COLONY_ROLE_ARCHITECTURE
  • Added COLONY_ROLE_ARCHITECTURE_SUBDOMAIN
  • Added COLONY_ROLE_FUNDING
  • Added COLONY_ROLE_RECOVERY
  • Added COLONY_ROLE_ROOT
  • Added COLONY_ROLES
  • Added ETHER_ADDRESS
  • Added FUNDING_POT_TYPE_DOMAIN
  • Added FUNDING_POT_TYPE_PAYMENT
  • Added FUNDING_POT_TYPE_TASK
  • Added FUNDING_POT_TYPE_UNASSIGNED
  • Added FUNDING_POT_TYPES
  • Added TASK_RATING_NONE
  • Added TASK_RATING_UNSATISFACTORY
  • Added TASK_RATING_SATISFACTORY
  • Added TASK_RATING_EXCELLENT
  • Added TASK_RATINGS
  • Added TASK_ROLE_EVALUATOR
  • Added TASK_ROLE_MANAGER
  • Added TASK_ROLE_WORKER
  • Added TASK_ROLES
  • Removed FOUNDER_ROLE
    • FOUNDER_ROLE has been deprecated in favor of the new colony roles. When using the setFounderRole method provided by the OldRoles.sol extension contract, the following colony roles will be applied:
      • COLONY_ROLE_ROOT
      • COLONY_ROLE_ARCHITECTURE
      • COLONY_ROLE_FUNDING
      • COLONY_ROLE_ADMINISTRATION
  • Removed ADMIN_ROLE
    • ADMIN_ROLE has been deprecated in favor of the new colony roles. When using the setAdminRole method provided by the OldRoles.sol extension contract, the following colony roles will be applied:
      • COLONY_ROLE_ARCHITECTURE
      • COLONY_ROLE_FUNDING
      • COLONY_ROLE_ADMINISTRATION
  • Removed AUTHORITY_ROLES
    • AUTHORITY_ROLES has been replaced by COLONY_ROLES
  • Removed MANAGER_ROLE
    • MANAGER_ROLE has been replaced with TASK_ROLE_MANAGER
  • Removed EVALUATOR_ROLE
    • EVALUATOR_ROLE has been replaced with TASK_ROLE_EVALUATOR
  • Removed WORKER_ROLE
    • WORKER_ROLE has been replaced with TASK_ROLE_WORKER
  • Removed ACTIVE_TASK_STATUS
    • ACTIVE_TASK_STATUS has been replaced with TASK_STATUS_ACTIVE
  • Removed CANCELLED_TASK_STATUS
    • CANCELLED_TASK_STATUS has been replaced with TASK_STATUS_CANCELLED
  • Removed FINALIZED_TASK_STATUS
    • FINALIZED_TASK_STATUS has been replaced with TASK_STATUS_FINALIZED
  • Updated TASK_ROLES
    • TASK_ROLES has been updated to use the following reformatted constants:
      • TASK_ROLE_MANAGER
      • TASK_ROLE_EVALUATOR
      • TASK_ROLE_WORKER

• Updated caller methods in ColonyClient (@colony/colony-js-client)

  • Added getAuthorityAddress
  • Added getColonyNetworkAddress
  • Added getExtensionAddress
  • Added getFundingPotPayout
  • Added getOwnerAddress
  • Added getPayment
  • Added getPaymentCount
  • Added getTaskWorkRatingSecretsInfo
  • Added getTokenAddress
  • Added hasColonyRole
  • Added verifyReputationProof
  • Removed getAuthority
    • getAuthorityAddress has replaced getAuthority.
  • Removed getTaskWorkRatings
    • getTaskWorkRatingSecretsInfo has replaced getTaskWorkRatings.
  • Removed getToken
    • getTokenAddress has replaced getToken.
  • Removed getTotalTaskPayout
    • getFundingPotPayout has replaced getTotalTaskPayout.
  • Removed hasUserRole
    • hasColonyRole has replaced hasUserRole. hasColonyRole uses address instead of user as an input parameter and adds domainId.
  • Updated getDomain
    • Changed localSkillId output parameter to skillId.
  • Updated getFundingPot
    • Changed associatedType output parameter to type.
    • Changed associatedTypeId output parameter to typeId.
    • Added payoutsWeCannotMake output parameter.
  • Updated getRewardPayoutInfo
    • Updated output parameters based on the new RewardPayoutCycle struct.
  • Updated getTask
    • Removed payoutsWeCannotMake output parameter.

• Updated sender methods in ColonyClient (@colony/colony-js-client)

  • Added addExtension
  • Added addNetworkColonyVersion (MetaColony)
  • Added addPayment
  • Added addTask
  • Added claimPayment
  • Added claimTaskPayout
  • Added claimRewardPayout
  • Added deprecateGlobalSkill (MetaColony)
  • Added finalizePayment
  • Added removeExtension
  • Added setAdministrationRole
  • Added setArchitectureRole
  • Added setFundingRole
  • Added setPaymentDomain
  • Added setPaymentPayout
  • Added setPaymentRecipient
  • Added setPaymentSkill
  • Added setRootRole
  • Removed claimPayout
    • See claimPayment and claimTaskPayout for more information.
  • Removed createTask
    • addTask has replaced createTask for consistency.
  • Removed removeAdminRole (See setAdminRole)
  • Updated addGlobalSkill
    • Removed parentSkillId as an input parameter. Global skills no longer exist within a skills tree and always use 0 for the parentSkillId.
  • Updated bootstrapColony
    • Changed users input parameter to addresses.
  • Updated makePayment
    • Changed worker input parameter to recipient.
  • Updated removeRecoveryRole
    • Changed user input parameter to address.
  • Updated setRecoveryRole
    • Changed user input parameter to address.
  • Updated setAdminRole
    • setAdminRole is now connected to the OldRoles extension contract.
    • Changed user input parameter to address.
    • Added setTo input parameter.
  • Updated setFounderRole
    • setAdminRole is now connected to the OldRoles extension contract.
    • Changed user input parameter to address.
  • Updated setTaskEvaluatorRole
    • Changed user input parameter to address.
  • Updated setTaskManagerRole
    • Changed user input parameter to address.
  • Updated setTaskWorkerRole
    • Changed user input parameter to address.
  • Updated startNextRewardPayout
    • Added key input parameter.
    • Added value input parameter.
    • Added branchMask input parameter.
    • Added siblings input parameter.

• Updated events in ColonyClient (@colony/colony-js-client)

  • Added ColonyAdministrationRoleSet
  • Added ColonyArchitectureRoleSet
  • Added ColonyFundingRoleSet
  • Added ColonyRootRoleSet
  • Added ColonyVersionAdded
  • Added PaymentAdded
  • Added PayoutClaimed
  • Removed ColonyAdminRoleRemoved
    • ColonyAdministrationRoleSet has replaced ColonyAdminRoleRemoved.
    • ColonyAdministrationRoleSet changes user parameter to address.
    • ColonyAdministrationRoleSet adds setTo parameter.
  • Removed ColonyAdminRoleSet
    • ColonyAdministrationRoleSet has replaced ColonyAdminRoleRemoved.
    • ColonyAdministrationRoleSet changes user parameter to address.
    • ColonyAdministrationRoleSet adds setTo parameter.
  • Removed ColonyFounderRoleSet
    • ColonyRootRoleSet has replaced ColonyFounderRoleSet.
    • ColonyRootRoleSet changes user parameter to address.
    • ColonyRootRoleSet adds setTo parameter.
  • Removed TaskPayoutClaimed
    • PayoutClaimed has replaced TaskPayoutClaimed.
  • Updated ColonyBootstrapped
    • Changed users parameter to addresses.
  • Updated ColonyInitialised
    • Added token parameter.

• Updated caller methods in ColonyNetworkClient (@colony/colony-js-client)

  • Added calculateMinerWeight
  • Added getENSRegistrarAddress
  • Added getMiningResolverAddress
  • Added getReplacementReputationUpdateLogEntry
  • Added getReputationMiningCycle
  • Added getReputationMiningSkillId
  • Added getReputationRootHash
  • Added getReputationRootHashNodeCount
  • Added getTokenLockingAddress
  • Removed getRootGlobalSkillId
    • getReputationMiningSkillId has replaced getRootGlobalSkillId.
  • Removed getTokenLocking
    • getTokenLockingAddress has replaced getTokenLocking.
    • getTokenLockingAddress changes lockingAddress parameter to address.
  • Updated getSkill
    • Added parents output parameter.
    • Added children output parameter.

• Updated sender methods in ColonyNetworkClient (@colony/colony-js-client)

  • Added appendReputationUpdateLog
  • Added deprecateSkill
  • Added initialiseReputationMining
  • Added registerColonyLabel
  • Added setMiningResolver
  • Added setReplacementReputationUpdateLogEntry
  • Added setReputationRootHash
  • Added startNextMiningCycle
  • Updated addSkill
    • Removed globalSkill input parameter.
  • Updated removeRecoveryRole
    • Changed user input parameter to address.
  • Updated setRecoveryRole
    • Changed user input parameter to address.

• Updated events in ColonyNetworkClient (@colony/colony-js-client)

  • Added ColonyVersionAdded

• Updated caller methods in TokenClient (@colony/colony-js-client)

  • Added isLocked

• Updated sender methods in TokenClient (@colony/colony-js-client)

  • Added createTokenAuthority
  • Added unlock
  • Updated `create...

v1.11.2

Bug Fixes

• Fix transaction retrieval after sending in EthersWrappedWallet (@colony/colony-js-client)

Types

• Add missing event definitions to ColonyClient (@colony/colony-js-client)
  • ColonyAdminRoleSet
  • ColonyFounderRoleSet

v1.11.1

Bug Fixes

• Fix ethers wallet being passed to getNetworkClient (@colony/colony-js-client)
• Fix address depth when using EthersWrappedWallet (@colony/colony-js-client)
• Fix gasLimit based on estimate in EthersWrappedWallet (@colony/colony-js-client)
• Fix amount type for send in EthersWrappedWallet (@colony/colony-js-client)

v1.11.0

New Features

• Add getNetworkClient method (@colony/colony-js-client)
• Add getFundingPot and getFundingPotCount (@colony/colony-js-client)
• Add temporary makePayment method (@colony/colony-js-client)
• Add versioned contracts for rinkeby-v3 (@colony/colony-js-contract-loader-network)

Maintenance

• Update TokenClient to use DSToken contract (@colony/colony-js-client)
• Update getPotBalance to getFundingPotBalance (@colony/colony-js-client)
• Update PotAdded to FundingPotAdded (@colony/colony-js-client)