27 public docs for registry contracts #29
Conversation
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
Added mainnet address for registry contract, added explanation of external functions
Added documentation for Pool Regitry functions, still need to add in outputs for underlying pool functions
Added explanation for functions related to metapools.
hammeiam
reviewed
Mar 28, 2022
saddle-registry.md
Outdated
|
|
||
| ## Pool Registry | ||
|
|
||
| This contract holds the funtions to get deployment addresses and related info for all Saddle Pools |
There was a problem hiding this comment.
maybe also mention that they can get the latest address from the masterRegistry by looking up formatBytes32String('PoolRegistry')
saddle-registry.md
Outdated
|
|
||
| ### Pool Registry Public Variables: | ||
|
|
||
| * `poolsIndexOfPlusOne(address poolAddress)`: Resolves an address input to the current pool vitual price. |
|
I think we should use |
Added Master registry and pool registry auto generated pages as well as updated the registry page with more general info.
Changed all scripts from python to typescript, added example of filtering all emitted events from the contract by topic.
hammeiam
reviewed
Jun 30, 2022
|
|
||
| // Get PoolDataAtIndex for each pool index and append to list | ||
| let poolDataList = []; | ||
| for (let i = 0; i < registryLength; i++) { |
|
|
||
| ```typescript | ||
| const hre = require("hardhat"); | ||
| const { ethers } = require("@nomiclabs/hardhat-ethers"); |
There was a problem hiding this comment.
hardhat shouldn't be necessary in these demo scripts, we can just use ethers directly import ethers from 'ethers'
| ```typescript | ||
| const hre = require("hardhat"); | ||
| const { ethers } = require("@nomiclabs/hardhat-ethers"); | ||
| const toNumber = hre.ethers.utils.toNumber |
|
|
||
| ### Pool Registry Interactions | ||
|
|
||
| The Pool Registry's functions allow you to fetch pool data is, as well as listen for pool events: |
|
|
||
| ## Pool Registry <br> | ||
|
|
||
| This contract holds the funtions to get deployment addresses and related info for all Saddle Pools. It allows for listening to events related to registry actions such as removing/adding pools, as well as any updates to existing pools. <br> |
|
|
||
| } | ||
| ``` | ||
| * Get all events that the PoolRegistry has ever produced |
There was a problem hiding this comment.
We can omit this since fetching contract events isn't specific to any one contract.
|
Could this be good marketing material too? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For #27