Snowflake Safe SDK

Snowflake Safe SDK provides an easy way to interact with the Snowflake Safe app and onchain programs

Installation

Install with npm

``bash
npm i @snowflake-so/safe-sdk
`

Install with yarn

`bash
yarn add @snowflake-so/safe-sdk
`

Quick start guide

$3

To create a new Snowflake service, we would need to initialize with the Provider.

`typescript
// if your Anchor version is older than 0.24.2,
// please use Snowflake SDK version 1.0.11 and initialize the provider as below
let provider: Provider = Provider.local(API_URL);

// if your Anchor version is 0.24.2 or later,
// please use the latest version of Snowflake SDK and initialize the provider as below
let provider: Provider = AnchorProvider.local(API_URL);
`

The API_URL is the endpoint to the Solana cluster. Empty API_URL is pointed to the local testnet

- Mainnet Beta: https://api.mainnet-beta.solana.com
- Testnet: https://api.testnet.solana.com
- Devnet: https://api.devnet.solana.com

`typescript
let snowflakeSafe: SnowflakeSafe = new SnowflakeSafe(provider);
`

---

$3

Fetch safe onchain information by safe address

`typescript
await snowflakeSafe.fetchSafe(safeAddress);
`

$3

Fetch all onchain proposals of the safe

`typescript
await snowflakeSafe.fetchAllProposals(safeAddress);
`

$3

Fetch onchain proposal information

`typescript
await snowflakeSafe.fetchProposal(proposalAddress);
`

$3

Fetch all safes that the provided wallet owned

`typescript
await snowflakeSafe.fetchOwnedSafes(ownerAddress);
`

---

$3

Create a new safe with one owner and approvals required as one

`typescript
const input = {
approvalsRequired: 1,
owners: [owner],
};
const [newSafeAddress, txId] = await snowflakeSafe.createSafe(
input.owners,
input.approvalsRequired
);
`

$3

Create a new proposal that can be executed by any safe owners

`typescript
const response = await snowflakeSafe.createProposal(safeAddress, 'hello world', instructions);
`

$3

Create a new recurring proposal that can be executed automatically by Snowflake node operators

`typescript
const proposal = new MultisigJobBuilder()
.jobName('hello world')
.jobInstructions(instructions)
.scheduleCron('0 0 *')
.build();

const [newProposalAddress, txId] = await snowflakeSafe.createRecurringProposal(
safeAddress,
proposal
);
`

$3

In production, there is proposal created with multiple actions which has bunches of accounts. This method is used to solve the issue

`typescript
const [newProposalAddress] = await snowflakeSafe.createProposal(
safeAddress,
'hello world',
instructions,
[],
DEFAULT_FLOW_SIZE,
true,
true // Set separatedActions parameter to true
);
`

$3

#### Add owner proposal

The method will create a new instruction to propose adding new owner to the safe

`typescript
const ix = await snowflakeSafe.createAddOwnerProposalInstruction(safeAddress, newOwner);
`

#### Remove owner proposal

The method will create a new instruction to propose removing an existing owner from the safe

`typescript
const ix = await snowflakeSafe.createRemoveOwnerProposalInstruction(safeAddress, newOwner);
`

#### Change threshold proposal

The method will create a new instruction to propose changing threshold of the safe

`typescript
const ix = await snowflakeSafe.createChangeThresholdProposalInstruction(safeAddress, newThreshold);
`

$3

`typescript
await snowflakeSafe.approveProposal(flowAddress);
`

$3

`typescript
await snowflakeSafe.rejectProposal(flowAddress);
`

$3

`typescript
await snowflakeSafe.executeProposal(flowAddress);
`

$3

`typescript
await snowflakeSafe.abortRecurringProposal(flowAddress);
`

---

$3

With Snowflake SDK, you can create a job with two line of code.

`typescript
const job = new MultisigJobBuilder()
.jobName('hello world')
.jobInstructions(instructions)
.scheduleOnce(tomorrow())
.build();
`

$3

Schedule a job that runs every minute for 10 times.

`typescript
const job = new MultisigJobBuilder()
.jobName('hello world')
.jobInstructions(instructions)
.scheduleCron(' *', 10)
.build();
`

Schedule a job that runs at 10:00 AM on the first day of every month .

`typescript
const job = new MultisigJobBuilder()
.jobName('hello world')
.jobInstructions(instructions)
.scheduleCron('0 10 1 ')
.build();
`

$3

Schedule a job that is triggered based on an arbitrary condition defined within the user program.

`typescript
const job = new MultisigJobBuilder()
.jobName('hello world')
.jobInstructions(instructions)
.scheduleConditional(1)
.build();
``

Support

$3

If you have any problem with using the SDK in your system, drop a question our Snowflake Discord #sdk to receive a support from our engineers.

$3

If you find a bug or have any problem and idea while using the SDK, you can create an issue on SDK Github.

License

Apache Version 2.0