Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pools 1 5 1 #2203

Open
wants to merge 22 commits into
base: main
Choose a base branch
from
Open

pools 1 5 1 #2203

wants to merge 22 commits into from

Conversation

aelmanaa
Copy link
Collaborator

@aelmanaa aelmanaa commented Dec 2, 2024

No description provided.

Copy link

vercel bot commented Dec 2, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
documentation ✅ Ready (Inspect) Visit Preview Dec 3, 2024 4:35pm

Copy link
Collaborator

@thedriftofwords thedriftofwords left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Saving partial editorial review; feel free to apply now, or I can address in a follow-up PR


<CcipCommon callout="importCCIPPackage150" />

When invoking the `ccipSend` [function](/ccip/api-reference/v1.5.0/i-router-client#ccipsend), it is possible to encounter various errors. These might be thrown either by the CCIP router or by one of the downstream contracts called by the CCIP router. Below is a compiled list of potential errors you might encounter. Referencing this list will enable you to capture and handle these exceptions gracefully.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When invoking the `ccipSend` [function](/ccip/api-reference/v1.5.0/i-router-client#ccipsend), it is possible to encounter various errors. These might be thrown either by the CCIP router or by one of the downstream contracts called by the CCIP router. Below is a compiled list of potential errors you might encounter. Referencing this list will enable you to capture and handle these exceptions gracefully.
If you get errors when invoking the `ccipSend` [function](/ccip/api-reference/v1.5.0/i-router-client#ccipsend), the errors might be thrown either by the CCIP router or by one of the downstream contracts called by the CCIP router. Below is a compiled list of potential errors you might encounter. Referencing this list will enable you to capture and handle these exceptions gracefully.

function supportsInterface(bytes4 interfaceId) public pure returns (bool)
```

IERC165 supports an interfaceId. This allows CCIP to check if ccipReceive is available before calling it.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
IERC165 supports an interfaceId. This allows CCIP to check if ccipReceive is available before calling it.
[IERC165](https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/utils/introspection/IERC165.sol) supports an interfaceId. This allows CCIP to check if ccipReceive is available before calling it.

| ------------------- | ------- | -------------------------------------------------------------------------------- |
| receiver | bytes | The recipient of the tokens on the destination chain, abi encoded |
| remoteChainSelector | uint64 | The chain ID of the destination chain |
| originalSender | address | The original sender of the tx on the source chain |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| originalSender | address | The original sender of the tx on the source chain |
| originalSender | address | The original sender of the transaction on the source chain |


| Name | Type | Description |
| ------------------- | ------- | -------------------------------------------------------------------------------- |
| receiver | bytes | The recipient of the tokens on the destination chain, abi encoded |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| receiver | bytes | The recipient of the tokens on the destination chain, abi encoded |
| receiver | bytes | The recipient of the tokens on the destination chain, ABI encoded |


| Name | Type | Description |
| ---------------- | ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| destTokenAddress | bytes | The address of the destination token, abi encoded in the case of EVM chains. This value is UNTRUSTED as any pool owner can return whatever value they want. |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| destTokenAddress | bytes | The address of the destination token, abi encoded in the case of EVM chains. This value is UNTRUSTED as any pool owner can return whatever value they want. |
| destTokenAddress | bytes | The address of the destination token, ABI encoded in the case of EVM chains. This value is UNTRUSTED as any pool owner can return whatever value they want. |


| Name | Type | Description |
| ------------------- | ------- | ----------------------------------------------------------------------------------- |
| originalSender | bytes | The original sender of the tx on the source chain |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| originalSender | bytes | The original sender of the tx on the source chain |
| originalSender | bytes | The original sender of the transaction on the source chain |

uint128 is safe for rate limiter state: - For USD value rate limiting, it can adequately store USD value in 18
decimals - For ERC20 token amount rate limiting, all listed tokens will have at most a supply of uint128.max tokens -
In exceptional scenarios where tokens consumed may be larger than uint128 (e.g., compromised issuer), an enabled
RateLimiter will check and revert
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will check and revert ... the transaction?

error CanOnlySelfRegister(address admin, address token)
```

Thrown when someone tries to register an admin that isn't themselves.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Thrown when someone tries to register an admin that isn't themselves.
Thrown when someone tries to register an admin address that does not belong to them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants