Orca Protocol Documentation
App
Website
GitHub
Search…
Introduction
What is Orca Protocol?
Pod Basics
What Are Pods?
Benefits of Pods
Pod Roles and Membership
Pod Configurations
Getting Started With Pods
Creating A Pod
Managing Membership
Membership Requirements (coming soon)
Use Cases
Pods as Governance Coalitions
For Developers
Orca SDK
Pod Objects
Proposal Objects
GitHub
Understanding Orca
FAQ
Get Involved
Learn More
Join the Community
Media Kit
Powered By
GitBook
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!
Use Cases - Previous
Pods as Governance Coalitions
Next
Pod Objects
Last modified
29d ago
Copy link