Skip to main content

SDK support for custom gas token Orbit chains

Arbitrum SDK is a TypeScript library for client-side interactions with Arbitrum. It provides common helper functionality as well as access to the underlying smart contract interfaces.

We've developed different versions of the SDK for different use cases. Orbit functionality can be found under the orbit and orbit-custom-fee-token tags of the Arbitrum SDK package.

PUBLIC PREVIEW, MAINNET READY

Orbit chains are now Mainnet ready! Note that Orbit is still a public preview capability - the Orbit product and its supporting documentation may change significantly as we capture feedback from readers like you.

To provide feedback, click the Request an update button at the top of this document, join the Arbitrum Discord, or reach out to our team directly by completing this form.

Custom gas token SDK​

The following custom gas token APIs are available under the orbit-custom-fee-token SDK tag:

  • getApproveFeeTokenRequest and approveFeeToken on EthBridger
  • getApproveFeeTokenRequest and approveFeeToken on Erc20Bridger

If you're using a custom gas token, you'll need to use each of these; on custom gas token chains, token approval is required when transferring ERC20 tokens (while Orbit chains that use ETH do not have this requirement).

Note that everything else is under the hood, and the custom gas token code paths will be executed just if the L2Network object config has a nativeToken field.