Clarify cross-chain applications as examples

[minghinmatthewlam]

Why this should be merged

Fixes #134

How this works

• Updates to clarify in documentation that cross-chain applications are examples
• Adds @teleporter in remappings, and used for cross-chain apps
• Update other READMEs, like adding one for example messenger

How this was tested

CI

How is this documented

READMEs

[openzeppelin-code]

Clarify cross-chain applications as examples

Generated at commit: a15e7d2fe10fd668e9ef70b56230d1017e63f351

🚨 Report Summary

	Severity Level	Results
Contracts	Critical High Medium Low Note Total	0 0 0 5 23 28
Dependencies	Critical High Medium Low Note Total	0 0 0 0 0 0

---

For more details view the full report in OpenZeppelin Code Inspector

[geoff-vball]

I see there are some formatting changes here, which are good - but it would be helpful if we had some way to enforce uniform formatting as we do now with our .go files. I think we can use forge fmt, we would just have to add the formatting rules to foundry.toml. We could add forge fmt to abi bindings script (and probably rename it) and then also check it in ci.

[michaelkaplan13]

In each of the example contract .sol files, can we add a comment towards the top stating that it is example code and do not use it in production? Something similar to how Chainlink has it for CCIP examples here.

[minghinmatthewlam]

I see there are some formatting changes here, which are good - but it would be helpful if we had some way to enforce uniform formatting as we do now with our .go files. I think we can use forge fmt, we would just have to add the formatting rules to foundry.toml. We could add forge fmt to abi bindings script (and probably rename it) and then also check it in ci.

Deferring this to a new issue #198.

[michaelkaplan13]

Can we add an additional note here that all contracts under /examples are included solely for demonstration purpose and not intended for production use?

Probably also in GETTING_STARTED.md. It will be slight overkill, but I'd definitely prefer to be on the "over communicated point" side here.

[cam-schultz]

Two tiny nits, and I agree with Michael's comment about adding comments wherever we can indicating the contracts are not production worthy.

[cam-schultz]

Could we also add a remapping for the Mocks directory?

[cam-schultz]

LGTM/. One question about vm.stopPrank in the tests.