Orca SDK
How to integrate with the Orca Protocol SDK.

Getting Started

At a high level, the Orca SDK allows developers to:
  • Fetch and determine if addresses are pods
  • Fetch pod metadata
  • Fetch pod member data, including sub pods.
  • Determine roles of pod members
  • Mint and burn pod membership, either directly acting as an admin or through a proposal.
If you prefer, you can view auto-generated docs of our complete SDK here.
To begin, initialize the SDK with the init function:
1
import { init } from '@orcaprotocol/orca-sdk';
2
3
// Any ethers provider works.
4
// 1 for mainnet, 4 for rinkeby.
5
// Make sure that the provider is instantiated before the SDK
6
init({ provider: ethers.getDefaultProvider(), network: 1 });
Copied!
Copy link