-
Notifications
You must be signed in to change notification settings - Fork 374
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
### Description Adds StableTokenEUR and ExchangeEUR wrappers. * Adds `Erc20Wrapper`, which wraps the required functions of ERC20 tokens found in the `IERC20` interface * Adds `CeloTokenWrapper`, which extends `Erc20Wrapper` and wraps functions in the `ICeloToken` interface. Although `ICeloToken` itself doesn't extend `IERC20`, it's intended to be used alongside `IERC20`, and having `CeloTokenWrapper` extend `Erc20Wrapper` is easier to get around TypeScript not supporting multiple inheritance (eg `class StableTokenEURWrapper extends CeloTokenWrapper, Erc20Wrapper` isn't possible) * `StableTokenWrapper` is used for both cUSD and cEUR. * `ExchangeWrapper` is used for both cUSD and cEUR. Dollar-specific functions still exist but are deprecated and the generic functions are preferred. * Created the class `CeloTokens`, a helper class for interacting with CELO & stable tokens ### Other changes * Using a new version of `@celo/typechain-target-web3-v1-celo` to properly generate TS files for interfaces * Added `stableTokenEUR` to migration overrides for tests to work I did not update `packages/sdk/base/src/currencies.ts` to include cEUR as only Valora relies upon that, and adding cEUR there caused a bunch of build issues that can only be resolved with code changes to support cEUR in Valora. ### Tested * Ran tests * Ran against a testnet with cEUR ### Related issues - Fixes #6365 ### Backwards compatibility See Other Changes
- Loading branch information
Showing
22 changed files
with
821 additions
and
401 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| import Web3 from 'web3' | ||
| import { CeloContract } from './base' | ||
| import { CeloTokenInfo, CeloTokens, StableToken, Token } from './celo-tokens' | ||
| import { ContractKit, newKitFromWeb3 } from './kit' | ||
|
|
||
| describe('CeloTokens', () => { | ||
| let kit: ContractKit | ||
| let celoTokens: CeloTokens | ||
|
|
||
| beforeEach(() => { | ||
| kit = newKitFromWeb3(new Web3('http://localhost:8545')) | ||
| celoTokens = kit.celoTokens | ||
| }) | ||
|
|
||
| describe('forEachCeloToken()', () => { | ||
| it('returns an object with a key for each celo token and the value from a provided async fn', async () => { | ||
| const result = await celoTokens.forEachCeloToken(async (info: CeloTokenInfo) => | ||
| Promise.resolve(info.symbol) | ||
| ) | ||
| for (const [key, value] of Object.entries(result)) { | ||
| expect(key).toEqual(value) | ||
| } | ||
| }) | ||
|
|
||
| it('returns an object with a key for each celo token and the value from a provided non-async fn', async () => { | ||
| const result = await celoTokens.forEachCeloToken(async (info: CeloTokenInfo) => info.symbol) | ||
| for (const [key, value] of Object.entries(result)) { | ||
| expect(key).toEqual(value) | ||
| } | ||
| }) | ||
| }) | ||
|
|
||
| describe('isStableToken()', () => { | ||
| it('returns true if the token is a stable token', () => { | ||
| expect(celoTokens.isStableToken(StableToken.cUSD)).toEqual(true) | ||
| }) | ||
|
|
||
| it('returns false if the token is not a stable token', () => { | ||
| expect(celoTokens.isStableToken(Token.CELO)).toEqual(false) | ||
| }) | ||
| }) | ||
|
|
||
| describe('isStableTokenContract()', () => { | ||
| it('returns true if the contract is a stable token contract', () => { | ||
| expect(celoTokens.isStableTokenContract(CeloContract.StableToken)).toEqual(true) | ||
| }) | ||
|
|
||
| it('returns false if the contract is not a stable token contract', () => { | ||
| expect(celoTokens.isStableTokenContract(CeloContract.Exchange)).toEqual(false) | ||
| }) | ||
| }) | ||
| }) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,201 @@ | ||
| import { BigNumber } from 'bignumber.js' | ||
| import { CeloContract, CeloTokenContract, ExchangeContract, StableTokenContract } from './base' | ||
| import { ContractKit } from './kit' | ||
| import { GoldTokenWrapper } from './wrappers/GoldTokenWrapper' | ||
| import { StableTokenWrapper } from './wrappers/StableTokenWrapper' | ||
|
|
||
| export enum StableToken { | ||
| cUSD = 'cUSD', | ||
| cEUR = 'cEUR', | ||
| } | ||
|
|
||
| export enum Token { | ||
| CELO = 'CELO', | ||
| } | ||
|
|
||
| export type CeloTokenType = StableToken | Token | ||
|
|
||
| type CeloTokenWrapper = GoldTokenWrapper | StableTokenWrapper | ||
|
|
||
| export type EachCeloToken<T> = { | ||
| [key in CeloTokenType]: T | ||
| } | ||
|
|
||
| export interface CeloTokenInfo { | ||
| contract: CeloTokenContract | ||
| symbol: CeloTokenType | ||
| } | ||
|
|
||
| export interface StableTokenInfo extends CeloTokenInfo { | ||
| contract: StableTokenContract | ||
| exchangeContract: ExchangeContract | ||
| } | ||
|
|
||
| /** Basic info for each stable token */ | ||
| const stableTokenInfos: { | ||
| [key in StableToken]: StableTokenInfo | ||
| } = { | ||
| [StableToken.cUSD]: { | ||
| contract: CeloContract.StableToken, | ||
| exchangeContract: CeloContract.Exchange, | ||
| symbol: StableToken.cUSD, | ||
| }, | ||
| [StableToken.cEUR]: { | ||
| contract: CeloContract.StableTokenEUR, | ||
| exchangeContract: CeloContract.ExchangeEUR, | ||
| symbol: StableToken.cEUR, | ||
| }, | ||
| } | ||
|
|
||
| /** Basic info for each supported celo token, including stable tokens */ | ||
| const celoTokenInfos: { | ||
| [key in CeloTokenType]: CeloTokenInfo | ||
| } = { | ||
| [Token.CELO]: { | ||
| contract: CeloContract.GoldToken, | ||
| symbol: Token.CELO, | ||
| }, | ||
| ...stableTokenInfos, | ||
| } | ||
|
|
||
| /** | ||
| * A helper class to interact with all Celo tokens, ie CELO and stable tokens | ||
| */ | ||
| export class CeloTokens { | ||
| constructor(readonly kit: ContractKit) {} | ||
|
|
||
| /** | ||
| * Gets an address's balance for each celo token. | ||
| * @param address the address to look up the balances for | ||
| * @return a promise resolving to an object containing the address's balance | ||
| * for each celo token | ||
| */ | ||
| balancesOf(address: string): Promise<EachCeloToken<BigNumber>> { | ||
| return this.forEachCeloToken(async (info: CeloTokenInfo) => { | ||
| const wrapper = await this.kit.contracts.getContract(info.contract) | ||
| return wrapper.balanceOf(address) | ||
| }) | ||
| } | ||
|
|
||
| /** | ||
| * Gets the wrapper for each celo token. | ||
| * @return an promise resolving to an object containing the wrapper for each celo token. | ||
| */ | ||
| getWrappers(): Promise<EachCeloToken<CeloTokenWrapper>> { | ||
| return this.forEachCeloToken((info: CeloTokenInfo) => | ||
| this.kit.contracts.getContract(info.contract) | ||
| ) | ||
| } | ||
|
|
||
| /** | ||
| * Gets the address for each celo token proxy contract. | ||
| * @return an promise resolving to an object containing the address for each celo token proxy. | ||
| */ | ||
| getAddresses(): Promise<EachCeloToken<string>> { | ||
| return this.forEachCeloToken((info: CeloTokenInfo) => | ||
| this.kit.registry.addressFor(info.contract) | ||
| ) | ||
| } | ||
|
|
||
| /** | ||
| * Runs fn for each celo token found in celoTokenInfos, and returns the | ||
| * value of each call in an object keyed by the token. | ||
| * @param fn the function to be called for each CeloTokenInfo. | ||
| * @return an object containing the resolved value the call to fn for each | ||
| * celo token. | ||
| */ | ||
| async forEachCeloToken<T>( | ||
| fn: (info: CeloTokenInfo) => T | Promise<T> | ||
| ): Promise<EachCeloToken<T>> { | ||
| const wrapperInfos = await Promise.all( | ||
| Object.values(celoTokenInfos).map(async (info: CeloTokenInfo) => { | ||
| const fnResult = fn(info) | ||
| return { | ||
| symbol: info.symbol, | ||
| data: fnResult instanceof Promise ? await fnResult : fnResult, | ||
| } | ||
| }) | ||
| ) | ||
| return wrapperInfos.reduce( | ||
| ( | ||
| obj: { | ||
| [key in CeloTokenType]?: T | ||
| }, | ||
| wrapperInfo | ||
| ) => ({ | ||
| ...obj, | ||
| [wrapperInfo.symbol]: wrapperInfo.data, | ||
| }), | ||
| {} | ||
| ) as EachCeloToken<T> | ||
| } | ||
|
|
||
| /** | ||
| * Gets the wrapper for a given celo token. | ||
| * @param token the token to get the appropriate wrapper for | ||
| * @return an promise resolving to the wrapper for the token | ||
| */ | ||
| getWrapper(token: StableToken): Promise<StableTokenWrapper> | ||
| getWrapper(token: CeloTokenType): Promise<CeloTokenWrapper> { | ||
| return this.kit.contracts.getContract(celoTokenInfos[token].contract) | ||
| } | ||
|
|
||
| /** | ||
| * Gets the contract for the provided token | ||
| * @param token the token to get the contract of | ||
| * @return The contract for the token | ||
| */ | ||
| getContract(token: StableToken): StableTokenContract | ||
| getContract(token: CeloTokenType): CeloTokenContract { | ||
| return celoTokenInfos[token].contract | ||
| } | ||
|
|
||
| /** | ||
| * Gets the exchange contract for the provided stable token | ||
| * @param token the stable token to get exchange contract of | ||
| * @return The exchange contract for the token | ||
| */ | ||
| getExchangeContract(token: StableToken) { | ||
| return stableTokenInfos[token].exchangeContract | ||
| } | ||
|
|
||
| /** | ||
| * Gets the address of the contract for the provided token. | ||
| * @param token the token to get the (proxy) contract address for | ||
| * @return A promise resolving to the address of the token's contract | ||
| */ | ||
| getAddress(token: CeloTokenType) { | ||
| return this.kit.registry.addressFor(celoTokenInfos[token].contract) | ||
| } | ||
|
|
||
| /** | ||
| * Gets the address to use as the feeCurrency when paying for gas with the | ||
| * provided token. | ||
| * @param token the token to get the feeCurrency address for | ||
| * @return If not CELO, the address of the token's contract. If CELO, undefined. | ||
| */ | ||
| getFeeCurrencyAddress(token: CeloTokenType) { | ||
| if (token === Token.CELO) { | ||
| return undefined | ||
| } | ||
| return this.getAddress(token) | ||
| } | ||
|
|
||
| /** | ||
| * Returns if the provided token is a StableToken | ||
| * @param token the token | ||
| * @return if token is a StableToken | ||
| */ | ||
| isStableToken(token: CeloTokenType) { | ||
| // We cast token as StableToken to make typescript happy | ||
| return Object.values(StableToken).includes(token as StableToken) | ||
| } | ||
|
|
||
| isStableTokenContract(contract: CeloContract) { | ||
| const allStableTokenContracts = Object.values(StableToken).map( | ||
| (token) => stableTokenInfos[token].contract | ||
| ) | ||
| // We cast token as StableTokenContract to make typescript happy | ||
| return allStableTokenContracts.includes(contract as StableTokenContract) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.