⚙️Configuration du SDK

Mise en route en quelques étapes simples

Génération de votre configuration

Une fois que vous avez installé le SDK Shogun, vous pouvez commencer à le configurer en utilisant la fonction generateConfig. C'est ici que vous définirez la configuration de base pour le SDK, y compris vos points de terminaison RPC, vos options de routage et vos paramètres de frais.

Le seul paramètre obligatoire est affiliateName, qui permet d’attribuer un identifiant unique à votre intégration.

import { generateConfig } from '@{PLACEHOLDER}/sdk'

generateConfig({
  affiliateName: 'affiliate-example',
})

Paramètres disponibles

Les paramètres suivants vous permettent de personnaliser la configuration de votre SDK :

Paramètre	Description	Type
affiliateName	Identifie l'intégrateur du SDK et permet la surveillance des activités ainsi qu'un support proactif.	string (obligatoire)
apiKey	Clé unique attribuée par Shogun pour authentifier l'intégrateur et permettre des limites de débit plus élevées.	string (optionnel)
baseUrl	URL de base pour l'API Shogun. Toutes les requêtes passent par ce point de terminaison.	string (optionnel)
routingFilters	Paramètres configurables pour inclure/exclure des routes spécifiques, des plateformes de liquidité, des chaînes, des tokens, etc.	RoutingFilter (optionnel)
rpcs	Carte des IDs de chaînes vers leurs URLs RPC respectives.	RPCs (optionnel)
chains	Tableau des chaînes que vous prendrez en charge dans votre intégration.	Chain[] (optionnel)

Lors de la génération de votre configuration, ajoutez simplement l’un des paramètres ci-dessus à l’appel de generateConfig. Bien que affiliateName soit le seul paramètre obligatoire, il est fortement recommandé de spécifier vos propres points de terminaison RPC dans rpcs afin d’éviter la congestion et les autres problèmes associés aux points de terminaison RPC publics.

Voici un exemple d’ajout d’URL RPC personnalisées pour Arbitrum et Solana :

import { generateConfig } from '@{PLACEHOLDER}/sdk'

generateConfig({
  affiliateName: 'affiliate-example',
  rpcs: {
    42161: 'https://test-node.io/',
    900: 'https://test-node.io/',
  },
})

Mise à jour de votre configuration

Si vous souhaitez mettre à jour votre configuration après la configuration initiale, vous pouvez le faire en important l’objet baseConfig. Cet objet contient tous les paramètres que vous avez définis lors de la configuration initiale.

import { baseConfig } from '@{PLACEHOLDER}/sdk';

Vous pouvez utiliser baseConfig pour consulter vos configurations existantes, ainsi que pour définir de nouvelles valeurs pour chaque paramètre.

Méthodes de configuration

Méthode	Description
getBaseConfig()	Retourne tous les paramètres de configuration du fichier baseConfig existant.
getChains()	Retourne une promesse qui résout une liste de toutes les blockchains activées définies dans votre baseConfig.
getRpcs()	Retourne une promesse qui résout une liste de tous les points de terminaison RPC définis dans votre baseConfig.
set()	Permet de définir n’importe quel paramètre dans le baseConfig. Prend en entrée un objet de type BaseConfig.

Après avoir configuré votre SDK, vous êtes prêt à commencer à soumettre des intentions :

🛤️Diffusion des intentions