diff --git a/docs/build/authentication.md b/docs/build/authentication.md index 404ef09e0..680d9740e 100644 --- a/docs/build/authentication.md +++ b/docs/build/authentication.md @@ -243,26 +243,26 @@ Set the `env` client option to `dev` while developing. Set it to `production` be -| Parameter | Default | Description | -| ------------------------- | --------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Parameter | Default | Description | +| ------------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | appVersion | `undefined` | Add a client app version identifier that's included with API requests. **Production apps are strongly encouraged to set this value.**
For example, you can use the following format: `appVersion: APP_NAME + '/' + APP_VERSION`.
Setting this value provides telemetry that shows which apps are using the XMTP client SDK. This information can help XMTP developers provide app support, especially around communicating important SDK updates, including deprecations and required upgrades. | -| env | `dev` | Connect to the specified XMTP network environment. Valid values include `dev`, `production`, or `local`. For important details about working with these environments, see [XMTP `production` and `dev` network environments](#xmtp-production-and-dev-network-environments). | -| apiUrl | `undefined` | Manually specify an API URL to use. If specified, value of `env` will be ignored. | -| keystoreProviders | `[StaticKeystoreProvider, NetworkKeystoreProvider, KeyGeneratorKeystoreProvider]` | Override the default behavior of how the Client creates a Keystore with a custom provider. This can be used to get the user's private keys from a different storage mechanism. | -| persistConversations | `true` | Maintain a cache of previously seen V2 conversations in the storage provider (defaults to `LocalStorage`). | -| skipContactPublishing | `false` | Do not publish the user's contact bundle to the network on Client creation. Designed to be used in cases where the Client session is short-lived (for example, decrypting a push notification), and where it is known that a Client instance has been instantiated with this flag set to false at some point in the past. | -| codecs | `[TextCodec]` | Add codecs to support additional content types. | -| maxContentSize | `100M` | Maximum message content size in bytes. | -| preCreateIdentityCallback | `undefined` | `preCreateIdentityCallback` is a function that will be called immediately before a [Create Identity](/docs/concepts/account-signatures#sign-to-create-an-xmtp-identity) wallet signature is requested from the user. | -| preEnableIdentityCallback | `undefined` | `preEnableIdentityCallback` is a function that will be called immediately before an [Enable Identity](/docs/concepts/account-signatures#sign-to-enable-an-xmtp-identity) wallet signature is requested from the user. | +| env | `dev` | Connect to the specified XMTP network environment. Valid values include `dev`, `production`, or `local`. For important details about working with these environments, see [XMTP `production` and `dev` network environments](#xmtp-production-and-dev-network-environments). | +| apiUrl | `undefined` | Manually specify an API URL to use. If specified, value of `env` will be ignored. | +| keystoreProviders | `[StaticKeystoreProvider, NetworkKeystoreProvider, KeyGeneratorKeystoreProvider]` | Override the default behavior of how the Client creates a Keystore with a custom provider. This can be used to get the user's private keys from a different storage mechanism. | +| persistConversations | `true` | Maintain a cache of previously seen V2 conversations in the storage provider (defaults to `LocalStorage`). | +| skipContactPublishing | `false` | Do not publish the user's contact bundle to the network on Client creation. Designed to be used in cases where the Client session is short-lived (for example, decrypting a push notification), and where it is known that a Client instance has been instantiated with this flag set to false at some point in the past. | +| codecs | `[TextCodec]` | Add codecs to support additional content types. | +| maxContentSize | `100M` | Maximum message content size in bytes. | +| preCreateIdentityCallback | `undefined` | `preCreateIdentityCallback` is a function that will be called immediately before a [Create Identity](/docs/concepts/account-signatures#sign-to-create-an-xmtp-identity) wallet signature is requested from the user. | +| preEnableIdentityCallback | `undefined` | `preEnableIdentityCallback` is a function that will be called immediately before an [Enable Identity](/docs/concepts/account-signatures#sign-to-enable-an-xmtp-identity) wallet signature is requested from the user. | -| Parameter | Default | Description | -| --------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| appVersion | `undefined` | Add a client app version identifier that's included with API requests. **Production apps are strongly encouraged to set this value.**
For example, you can use the following format: `appVersion: APP_NAME + '/' + APP_VERSION`.
Setting this value provides telemetry that shows which apps are using the XMTP client SDK. This information can help XMTP developers provide app support, especially around communicating important SDK updates, including deprecations and required upgrades. | -| env | `dev` | Connect to the specified XMTP network environment. Valid values include `.dev`, `.production`, or `.local`. For important details about working with these environments, see [XMTP `production` and `dev` network environments](#xmtp-production-and-dev-network-environments). | +| Parameter | Default | Description | +| ---------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| appVersion | `undefined` | Add a client app version identifier that's included with API requests. **Production apps are strongly encouraged to set this value.**
For example, you can use the following format: `appVersion: APP_NAME + '/' + APP_VERSION`.
Setting this value provides telemetry that shows which apps are using the XMTP client SDK. This information can help XMTP developers provide app support, especially around communicating important SDK updates, including deprecations and required upgrades. | +| env | `dev` | Connect to the specified XMTP network environment. Valid values include `.dev`, `.production`, or `.local`. For important details about working with these environments, see [XMTP `production` and `dev` network environments](#xmtp-production-and-dev-network-environments). | **Configure `env`** @@ -284,10 +284,10 @@ For important details about connecting to environments, see [XMTP `production` a -| Parameter | Default | Description | -| ---------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Parameter | Default | Description | +| ---------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | appVersion | `undefined` | Add a client app version identifier that's included with API requests. **Production apps are strongly encouraged to set this value.**
For example, you can use the following format: `appVersion: APP_NAME + '/' + APP_VERSION`.
Setting this value provides telemetry that shows which apps are using the XMTP client SDK. This information can help XMTP developers provide app support, especially around communicating important SDK updates, including deprecations and required upgrades. | -| env | `DEV` | Connect to the specified XMTP network environment. Valid values include `DEV`, `.PRODUCTION`, or `LOCAL`. For important details about working with these environments, see [XMTP `production` and `dev` network environments](#xmtp-production-and-dev-network-environments). | +| env | `DEV` | Connect to the specified XMTP network environment. Valid values include `DEV`, `.PRODUCTION`, or `LOCAL`. For important details about working with these environments, see [XMTP `production` and `dev` network environments](#xmtp-production-and-dev-network-environments). | **Configure `env`** @@ -309,26 +309,26 @@ The `apiUrl`, `keyStoreType`, `codecs`, and `maxContentSize` parameters from the -| Parameter | Default | Description | -| ------------------------- | --------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Parameter | Default | Description | +| ------------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | appVersion | `undefined` | Add a client app version identifier that's included with API requests. **Production apps are strongly encouraged to set this value.**
For example, you can use the following format: `appVersion: APP_NAME + '/' + APP_VERSION`.
Setting this value provides telemetry that shows which apps are using the XMTP client SDK. This information can help XMTP developers provide app support, especially around communicating important SDK updates, including deprecations and required upgrades. | -| env | `dev` | Connect to the specified XMTP network environment. Valid values include `dev`, `production`, or `local`. For important details about working with these environments, see [XMTP `production` and `dev` network environments](#xmtp-production-and-dev-network-environments). | -| apiUrl | `undefined` | Manually specify an API URL to use. If specified, value of `env` will be ignored. | -| keystoreProviders | `[StaticKeystoreProvider, NetworkKeystoreProvider, KeyGeneratorKeystoreProvider]` | Override the default behavior of how the Client creates a Keystore with a custom provider. This can be used to get the user's private keys from a different storage mechanism. | -| persistConversations | `true` | Maintain a cache of previously seen V2 conversations in the storage provider (defaults to `LocalStorage`). | -| skipContactPublishing | `false` | Do not publish the user's contact bundle to the network on Client creation. Designed to be used in cases where the Client session is short-lived (for example, decrypting a push notification), and where it is known that a Client instance has been instantiated with this flag set to false at some point in the past. | -| codecs | `[TextCodec]` | Add codecs to support additional content types. | -| maxContentSize | `100M` | Maximum message content size in bytes. | -| preCreateIdentityCallback | `undefined` | `preCreateIdentityCallback` is a function that will be called immediately before a [Create Identity](/docs/concepts/account-signatures#sign-to-create-an-xmtp-identity) wallet signature is requested from the user. | -| preEnableIdentityCallback | `undefined` | `preEnableIdentityCallback` is a function that will be called immediately before an [Enable Identity](/docs/concepts/account-signatures#sign-to-enable-an-xmtp-identity) wallet signature is requested from the user. | +| env | `dev` | Connect to the specified XMTP network environment. Valid values include `dev`, `production`, or `local`. For important details about working with these environments, see [XMTP `production` and `dev` network environments](#xmtp-production-and-dev-network-environments). | +| apiUrl | `undefined` | Manually specify an API URL to use. If specified, value of `env` will be ignored. | +| keystoreProviders | `[StaticKeystoreProvider, NetworkKeystoreProvider, KeyGeneratorKeystoreProvider]` | Override the default behavior of how the Client creates a Keystore with a custom provider. This can be used to get the user's private keys from a different storage mechanism. | +| persistConversations | `true` | Maintain a cache of previously seen V2 conversations in the storage provider (defaults to `LocalStorage`). | +| skipContactPublishing | `false` | Do not publish the user's contact bundle to the network on Client creation. Designed to be used in cases where the Client session is short-lived (for example, decrypting a push notification), and where it is known that a Client instance has been instantiated with this flag set to false at some point in the past. | +| codecs | `[TextCodec]` | Add codecs to support additional content types. | +| maxContentSize | `100M` | Maximum message content size in bytes. | +| preCreateIdentityCallback | `undefined` | `preCreateIdentityCallback` is a function that will be called immediately before a [Create Identity](/docs/concepts/account-signatures#sign-to-create-an-xmtp-identity) wallet signature is requested from the user. | +| preEnableIdentityCallback | `undefined` | `preEnableIdentityCallback` is a function that will be called immediately before an [Enable Identity](/docs/concepts/account-signatures#sign-to-enable-an-xmtp-identity) wallet signature is requested from the user. | -| Parameter | Default | Description | -| ---------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Parameter | Default | Description | +| ---------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | appVersion | `undefined` | Add a client app version identifier that's included with API requests. **Production apps are strongly encouraged to set this value.**
For example, you can use the following format: `appVersion: APP_NAME + '/' + APP_VERSION`.
Setting this value provides telemetry that shows which apps are using the XMTP client SDK. This information can help XMTP developers provide app support, especially around communicating important SDK updates, including deprecations and required upgrades. | -| env | `dev` | Connect to the specified XMTP network environment. Valid values include `dev`, `production`, or `local`. For important details about working with these environments, see [XMTP `production` and `dev` network environments](#xmtp-production-and-dev-network-environments). | +| env | `dev` | Connect to the specified XMTP network environment. Valid values include `dev`, `production`, or `local`. For important details about working with these environments, see [XMTP `production` and `dev` network environments](#xmtp-production-and-dev-network-environments). | @@ -339,6 +339,14 @@ XMTP identity on `dev` network is completely distinct from its XMTP identity on - `production`: This network is used in production and is configured to store messages indefinitely. + - Try the web inbox at [https://xmtp.chat/](https://xmtp.chat/). + + - Send a message to our `gm` bot to get started. `gm.xmtp.eth` + - `dev`: XMTP may occasionally delete messages and keys from this network + - Try the web dev inbox at [https://dev.xmtp.chat/](https://xmtp.chat/). + + - Send a message to our `gm` bot to get started. `0x8DC925338C1eE1fE62c0C43404371deb701BfB55` + - `local`: Use to have a client communicate with an XMTP node you are running locally. For example, an XMTP node developer can set `env` to `local` to generate client traffic to test a node running locally. diff --git a/docs/build/img/bello.png b/docs/build/img/bello.png new file mode 100644 index 000000000..92086cd76 Binary files /dev/null and b/docs/build/img/bello.png differ diff --git a/src/components/BuiltWithXmtp/ListOfDevs.json b/src/components/BuiltWithXmtp/ListOfDevs.json index 80667e217..c42550eda 100644 --- a/src/components/BuiltWithXmtp/ListOfDevs.json +++ b/src/components/BuiltWithXmtp/ListOfDevs.json @@ -30,6 +30,14 @@ "github": "https://github.com/lensterxyz/lenster", "twitter": "https://x.com/lensterxyz" }, + { + "name": "XMTP Inbox", + "href": "https://xmtp.chat", + "image": "/img/builtWithXmtp/xmtp.svg", + "bgColor": "", + "description": "XMTP Inbox chat app demonstrates core and advanced capabilities of the XMTP client SDK.", + "github": "https://github.com/xmtp-labs/xmtp-inbox-web" + }, { "name": "Chainjet", "href": "https://chainjet.io/", @@ -46,12 +54,6 @@ "github": "https://github.com/paragraph-xyz", "twitter": "https://x.com/paragraph_xyz" }, - { - "name": "Buttrfly", - "href": "https://www.buttrfly.app/", - "image": "/img/builtWithXmtp/buttrfly-icon-rounded.png", - "description": "Decentralized social media app built for a mobile first experience on iOS. Built on Lens Protocol." - }, { "name": "Relay", "href": "https://relay.cc/", @@ -68,6 +70,13 @@ "github": "https://github.com/EthereumPhone", "twitter": "https://x.com/EthereumPhone" }, + { + "name": "Bello", + "href": "https://bello.lol/", + "image": "/img/builtWithXmtp/bello.png", + "description": "nstantly analyze your Web3 community and its competitors without writing a single line of code.", + "twitter": "https://x.com/bellosights" + }, { "name": "Boson App", "href": "https://bosonapp.io/", @@ -106,11 +115,9 @@ "twitter": "https://x.com/PinstaApp" }, { - "name": "XMTP Inbox", - "href": "https://xmtp.chat", - "image": "/img/builtWithXmtp/xmtp.svg", - "bgColor": "", - "description": "XMTP Inbox chat app demonstrates core and advanced capabilities of the XMTP client SDK.", - "github": "https://github.com/xmtp-labs/xmtp-inbox-web" + "name": "Buttrfly", + "href": "https://www.buttrfly.app/", + "image": "/img/builtWithXmtp/buttrfly-icon-rounded.png", + "description": "Decentralized social media app built for a mobile first experience on iOS. Built on Lens Protocol." } ] diff --git a/static/img/builtWithXmtp/bello.png b/static/img/builtWithXmtp/bello.png new file mode 100644 index 000000000..92086cd76 Binary files /dev/null and b/static/img/builtWithXmtp/bello.png differ