Check out the sdk quickstart guide for help setting up your client.
Usage
import { downlinkClient } from './config'
const data = await downlinkClient.getAllChannels()
import { TransmissionsClient } from '@tx-kit/sdk'
import { BASE_MAINNET_SUBGRAPH_URL } from '@tx-kit/sdk/constants'
import { CreatePublicClient, CreateWalletClient } from 'viem'
import { base } from 'viem/chains'
const publicClient = createPublicClient({
chain: base,
transport: http()
})
const walletClient = createWalletClient({
account, // from local private key or browser wallet
chain: base,
transport: http()
})
export const { downlinkClient } = new TransmissionsClient({
publicClient,
walletClient,
chain: base,
apiConfig: {
serverUrl: BASE_MAINNET_SUBGRAPH_URL
}
})
Returns
IChannel[]
type IChannel = {
id: Address
uri: string
name: string
admin: Address
managers: Address[]
transportLayer: ITransportLayer
creatorLogic: ILogicConfig | null
minterLogic: ILogicConfig | null
fees: IFeeConfig | null
tokens: IToken[]
blockNumber?: bigint
blockTimestamp?: bigint
}
Parameters
includeTokens (optional)
- type:
boolean - default:
false
const data = await downlinkClient.getChannel({
channelAddress: '0x1234567890123456789012345678901234567890',
includeTokens: true,
...
})
filters (optional)
- type:
Filters
type Filters = {
where?: GqlVariables
orderBy?: string
orderDirection?: string
pageSize?: number
skip?: number
}
// Fetch all channels with infinite transport layer type
const data = await downlinkClient.getAllChannels(
{
filters: {
where: {
transportLayer_: {
type: "infinite"
},
}
}
}
)