From 2a827ed4e03b8e750ab314148f909e7e546859f5 Mon Sep 17 00:00:00 2001 From: J M Rossy Date: Wed, 21 Dec 2022 11:01:51 -0500 Subject: [PATCH] Add chain logos to SDK (#1456) - Add chain logo images to SDK - Improve SDK Readme --- typescript/sdk/README.md | 33 ++++++++++++++++++++-- typescript/sdk/logos/black/arbitrum.svg | 1 + typescript/sdk/logos/black/avalanche.svg | 1 + typescript/sdk/logos/black/bsc.svg | 1 + typescript/sdk/logos/black/celo.svg | 1 + typescript/sdk/logos/black/ethereum.svg | 8 ++++++ typescript/sdk/logos/black/hyperlane.svg | 1 + typescript/sdk/logos/black/moonbeam.svg | 3 ++ typescript/sdk/logos/black/near.svg | 1 + typescript/sdk/logos/black/optimism.svg | 1 + typescript/sdk/logos/black/polygon.svg | 1 + typescript/sdk/logos/color/arbitrum.svg | 1 + typescript/sdk/logos/color/avalanche.svg | 1 + typescript/sdk/logos/color/bsc.svg | 1 + typescript/sdk/logos/color/celo.svg | 1 + typescript/sdk/logos/color/ethereum.svg | 1 + typescript/sdk/logos/color/hyperlane.svg | 1 + typescript/sdk/logos/color/moonbeam.svg | 1 + typescript/sdk/logos/color/optimism.svg | 1 + typescript/sdk/logos/color/polygon.svg | 1 + typescript/sdk/package.json | 3 +- typescript/sdk/src/consts/chainMetadata.ts | 3 ++ 22 files changed, 63 insertions(+), 4 deletions(-) create mode 100644 typescript/sdk/logos/black/arbitrum.svg create mode 100644 typescript/sdk/logos/black/avalanche.svg create mode 100644 typescript/sdk/logos/black/bsc.svg create mode 100644 typescript/sdk/logos/black/celo.svg create mode 100644 typescript/sdk/logos/black/ethereum.svg create mode 100644 typescript/sdk/logos/black/hyperlane.svg create mode 100644 typescript/sdk/logos/black/moonbeam.svg create mode 100644 typescript/sdk/logos/black/near.svg create mode 100644 typescript/sdk/logos/black/optimism.svg create mode 100644 typescript/sdk/logos/black/polygon.svg create mode 100644 typescript/sdk/logos/color/arbitrum.svg create mode 100644 typescript/sdk/logos/color/avalanche.svg create mode 100644 typescript/sdk/logos/color/bsc.svg create mode 100644 typescript/sdk/logos/color/celo.svg create mode 100644 typescript/sdk/logos/color/ethereum.svg create mode 100644 typescript/sdk/logos/color/hyperlane.svg create mode 100644 typescript/sdk/logos/color/moonbeam.svg create mode 100644 typescript/sdk/logos/color/optimism.svg create mode 100644 typescript/sdk/logos/color/polygon.svg diff --git a/typescript/sdk/README.md b/typescript/sdk/README.md index d68e7756f..3237a0b22 100644 --- a/typescript/sdk/README.md +++ b/typescript/sdk/README.md @@ -1,5 +1,32 @@ -# Hyperlane Application SDK +# Hyperlane SDK -The Hyperlane Application SDK help developers manage multichain Hyperlane applications. This requires a higher level API than dApp developers are familiar with which is namespaced by target chain. +The Hyperlane SDK helps developers create and manage interchain applications. -You can find the docs at https://docs.hyperlane.xyz/hyperlane-docs/developers/application-sdk +For details on how to use the various abstractions and utilities, [see the documentation](https://docs.hyperlane.xyz/hyperlane-docs-1/developers/building-applications) + +## Install + +`yarn install @hyperlane-xyz/sdk` + +## Contents + +### Constants + +The names and relevant metadata for all Hyperlane-supported chains are included in this SDK, including public RPC and Explorer urls. It also includes the addresses for all Hyperlane core contracts and middleware. + +### Deployment, testing, and development classes + +Classes for deploying, testing, and building applications using Hyperlane are included in the SDK. See [the docs](https://docs.hyperlane.xyz/hyperlane-docs-1/developers/building-applications/nodejs-sdk) for details. + +### Chain Logos + +The SDK contains SVG files for all Hyperlane-supported chains. They can be imported from the `/logos` folder. + +```js +import ArbitrumBlack from '@hyperlane-xyz/sdk/logos/black/arbitrum.svg'; +import ArbitrumColor from '@hyperlane-xyz/sdk/logos/color/arbitrum.svg'; +``` + +## License + +Apache 2.0 diff --git a/typescript/sdk/logos/black/arbitrum.svg b/typescript/sdk/logos/black/arbitrum.svg new file mode 100644 index 000000000..bdec7481a --- /dev/null +++ b/typescript/sdk/logos/black/arbitrum.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/typescript/sdk/logos/black/avalanche.svg b/typescript/sdk/logos/black/avalanche.svg new file mode 100644 index 000000000..441e026e3 --- /dev/null +++ b/typescript/sdk/logos/black/avalanche.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/typescript/sdk/logos/black/bsc.svg b/typescript/sdk/logos/black/bsc.svg new file mode 100644 index 000000000..212c1140d --- /dev/null +++ b/typescript/sdk/logos/black/bsc.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/typescript/sdk/logos/black/celo.svg b/typescript/sdk/logos/black/celo.svg new file mode 100644 index 000000000..429136492 --- /dev/null +++ b/typescript/sdk/logos/black/celo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/typescript/sdk/logos/black/ethereum.svg b/typescript/sdk/logos/black/ethereum.svg new file mode 100644 index 000000000..87320be62 --- /dev/null +++ b/typescript/sdk/logos/black/ethereum.svg @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/typescript/sdk/logos/black/hyperlane.svg b/typescript/sdk/logos/black/hyperlane.svg new file mode 100644 index 000000000..39b16cad7 --- /dev/null +++ b/typescript/sdk/logos/black/hyperlane.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/typescript/sdk/logos/black/moonbeam.svg b/typescript/sdk/logos/black/moonbeam.svg new file mode 100644 index 000000000..dd5bf6191 --- /dev/null +++ b/typescript/sdk/logos/black/moonbeam.svg @@ -0,0 +1,3 @@ + + + diff --git a/typescript/sdk/logos/black/near.svg b/typescript/sdk/logos/black/near.svg new file mode 100644 index 000000000..c50b8d814 --- /dev/null +++ b/typescript/sdk/logos/black/near.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/typescript/sdk/logos/black/optimism.svg b/typescript/sdk/logos/black/optimism.svg new file mode 100644 index 000000000..4d00e7448 --- /dev/null +++ b/typescript/sdk/logos/black/optimism.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/typescript/sdk/logos/black/polygon.svg b/typescript/sdk/logos/black/polygon.svg new file mode 100644 index 000000000..283521768 --- /dev/null +++ b/typescript/sdk/logos/black/polygon.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/typescript/sdk/logos/color/arbitrum.svg b/typescript/sdk/logos/color/arbitrum.svg new file mode 100644 index 000000000..aaa4de7cb --- /dev/null +++ b/typescript/sdk/logos/color/arbitrum.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/typescript/sdk/logos/color/avalanche.svg b/typescript/sdk/logos/color/avalanche.svg new file mode 100644 index 000000000..ec63dd2d8 --- /dev/null +++ b/typescript/sdk/logos/color/avalanche.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/typescript/sdk/logos/color/bsc.svg b/typescript/sdk/logos/color/bsc.svg new file mode 100644 index 000000000..a54c0a5cf --- /dev/null +++ b/typescript/sdk/logos/color/bsc.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/typescript/sdk/logos/color/celo.svg b/typescript/sdk/logos/color/celo.svg new file mode 100644 index 000000000..6b91ff8ca --- /dev/null +++ b/typescript/sdk/logos/color/celo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/typescript/sdk/logos/color/ethereum.svg b/typescript/sdk/logos/color/ethereum.svg new file mode 100644 index 000000000..c1e5aaba4 --- /dev/null +++ b/typescript/sdk/logos/color/ethereum.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/typescript/sdk/logos/color/hyperlane.svg b/typescript/sdk/logos/color/hyperlane.svg new file mode 100644 index 000000000..27fd9bf20 --- /dev/null +++ b/typescript/sdk/logos/color/hyperlane.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/typescript/sdk/logos/color/moonbeam.svg b/typescript/sdk/logos/color/moonbeam.svg new file mode 100644 index 000000000..dbc27cd50 --- /dev/null +++ b/typescript/sdk/logos/color/moonbeam.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/typescript/sdk/logos/color/optimism.svg b/typescript/sdk/logos/color/optimism.svg new file mode 100644 index 000000000..7b2c35cac --- /dev/null +++ b/typescript/sdk/logos/color/optimism.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/typescript/sdk/logos/color/polygon.svg b/typescript/sdk/logos/color/polygon.svg new file mode 100644 index 000000000..52f6d25f8 --- /dev/null +++ b/typescript/sdk/logos/color/polygon.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/typescript/sdk/package.json b/typescript/sdk/package.json index 614634e5b..61f3b91ed 100644 --- a/typescript/sdk/package.json +++ b/typescript/sdk/package.json @@ -30,7 +30,8 @@ "typescript": "^4.7.2" }, "files": [ - "/dist" + "/dist", + "/logos" ], "homepage": "https://www.hyperlane.xyz", "keywords": [ diff --git a/typescript/sdk/src/consts/chainMetadata.ts b/typescript/sdk/src/consts/chainMetadata.ts index 5180978dc..4295c9030 100644 --- a/typescript/sdk/src/consts/chainMetadata.ts +++ b/typescript/sdk/src/consts/chainMetadata.ts @@ -541,6 +541,9 @@ export const test3: ChainMetadata = { /** * Collection maps + * + * NOTE: When adding chains here, consider also adding the + * corresponding chain logo images in the /sdk/logos/* folders */ export const chainMetadata = { alfajores,