Type Alias EnvironmentConfig

A configuration for a specific environment. For most purposes simply specifying 'MAINNET' or 'TESTNET' as your Environment is sufficient, but you can also specify a custom configuration if needed.

See

Salt

type EnvironmentConfig = {
    apiUrl: string;
    chainConfig: Chain;
    chainId:
        | 1
        | 11155111
        | 421614
        | 80002
        | 137
        | 42161
        | 560048
        | 998
        | 999
        | 8453
        | 84532
        | 1287
        | 1284
        | 50312
        | 5031
        | 43113
        | 43114
        | 10143
        | 143
        | 50
        | 51;
    name: EnvironmentName;
    publicClient: ViemPublicClientLike;
    registryAddress: `0x${string}`;
    saltDomain: string;
    websocketUrl: string;
}

Index

Properties

apiUrl chainConfig chainId name publicClient registryAddress saltDomain websocketUrl

Properties

apiUrl

apiUrl: string

URI for the API server, including protocol

Example

https://testnet.salt.space/api

chainConfig

chainConfig: Chain

Registry contract chain

Example

arbitrumSepolia

chainId

chainId:
    | 1
    | 11155111
    | 421614
    | 80002
    | 137
    | 42161
    | 560048
    | 998
    | 999
    | 8453
    | 84532
    | 1287
    | 1284
    | 50312
    | 5031
    | 43113
    | 43114
    | 10143
    | 143
    | 50
    | 51

The ID of the orcehstration chain. For testnet, this is 421614 (Arbitrum Sepolia)

Example

name

name: EnvironmentName

Environment name

Example

EnvironmentName.Staging

publicClient

publicClient: ViemPublicClientLike

Viem RPC client

Example

const client = createPublicClient({
  chain: arbitrum,
  transport: http(globalThis.process.env.VITE_ARBITRUM_ONE_NODE_URL),
});

registryAddress

registryAddress: `0x${string}`

Salt shard registry contract address

Example

'0x447603546Ee18245d1640Aaa5150eB3A328256EF'

saltDomain

saltDomain: string

The FQDN for the client, with no protocol

Example

testnet.salt.space/api

websocketUrl

websocketUrl: string

The URL for the websocket server, used for account setup and transaction signing

Example

https://testnet.salt.space/api

Type Alias EnvironmentConfig

See

Index

Properties

Properties

apiUrl

Example

chainConfig

Example

chainId

Example

name

Example

publicClient

Example

registryAddress

Example

saltDomain

Example

websocketUrl

Example

Settings

On This Page