@fuul/sdk-solana 0.5.2

package/dist/types/index.d.ts

@@ -0,0 +1,6 @@
+export * from './common';
+export * from './constants';
+export * from './idls/fuul';
+export * from './pdas';
+export * from './sdks';
+export * from './types';

package/dist/types/instructions/admin-roles.d.ts

@@ -0,0 +1,26 @@
+import { PublicKey } from '@solana/web3.js';
+import * as anchor from '@coral-xyz/anchor';
+import { Network, GlobalRole } from '../types';
+export declare const grantGlobalRoleInstruction: (opts: {
+    connection: anchor.web3.Connection;
+    network: Network;
+    programId?: PublicKey;
+    authority: PublicKey;
+    account: PublicKey;
+    role: GlobalRole;
+}) => Promise<anchor.web3.TransactionInstruction[]>;
+export declare const revokeGlobalRoleInstruction: (opts: {
+    connection: anchor.web3.Connection;
+    network: Network;
+    programId?: PublicKey;
+    authority: PublicKey;
+    account: PublicKey;
+    role: GlobalRole;
+}) => Promise<anchor.web3.TransactionInstruction[]>;
+export declare const renounceGlobalRoleInstruction: (opts: {
+    connection: anchor.web3.Connection;
+    network: Network;
+    programId?: PublicKey;
+    authority: PublicKey;
+    role: GlobalRole;
+}) => Promise<anchor.web3.TransactionInstruction[]>;

package/dist/types/instructions/admin-token-management.d.ts

@@ -0,0 +1,28 @@
+import { PublicKey } from '@solana/web3.js';
+import * as anchor from '@coral-xyz/anchor';
+import { Network, TokenType } from '../types';
+export declare const addCurrencyTokenInstruction: (opts: {
+    connection: anchor.web3.Connection;
+    network: Network;
+    programId?: PublicKey;
+    authority: PublicKey;
+    tokenType: TokenType;
+    tokenMint: PublicKey;
+    claimLimitPerCooldown: anchor.BN;
+}) => Promise<anchor.web3.TransactionInstruction[]>;
+export declare const updateCurrencyTokenInstruction: (opts: {
+    connection: anchor.web3.Connection;
+    network: Network;
+    programId?: PublicKey;
+    authority: PublicKey;
+    tokenMint: PublicKey;
+    claimLimitPerCooldown?: anchor.BN;
+    isActive?: boolean;
+}) => Promise<anchor.web3.TransactionInstruction[]>;
+export declare const removeCurrencyTokenInstruction: (opts: {
+    connection: anchor.web3.Connection;
+    network: Network;
+    programId?: PublicKey;
+    authority: PublicKey;
+    tokenMint: PublicKey;
+}) => Promise<anchor.web3.TransactionInstruction[]>;

package/dist/types/instructions/admin.d.ts

@@ -0,0 +1,47 @@
+import * as anchor from '@coral-xyz/anchor';
+import { PublicKey } from '@solana/web3.js';
+import { Network } from '../types';
+export declare const updateGlobalConfigInstruction: (opts: {
+    connection: anchor.web3.Connection;
+    network: Network;
+    programId?: PublicKey;
+    authority: PublicKey;
+    claimCoolDown?: anchor.BN;
+    requiredSignersForClaim?: number;
+}) => Promise<anchor.web3.TransactionInstruction[]>;
+export declare const updateGlobalConfigFeesInstruction: (opts: {
+    connection: anchor.web3.Connection;
+    network: Network;
+    programId?: PublicKey;
+    authority: PublicKey;
+    feeCollector?: PublicKey;
+    userNativeClaimFee?: anchor.BN;
+    projectClaimFee?: number;
+    removeFee?: number;
+}) => Promise<anchor.web3.TransactionInstruction[]>;
+export declare const pauseProgramInstruction: (opts: {
+    connection: anchor.web3.Connection;
+    network: Network;
+    programId?: PublicKey;
+    authority: PublicKey;
+}) => Promise<anchor.web3.TransactionInstruction[]>;
+export declare const unpauseProgramInstruction: (opts: {
+    connection: anchor.web3.Connection;
+    network: Network;
+    programId?: PublicKey;
+    authority: PublicKey;
+}) => Promise<anchor.web3.TransactionInstruction[]>;
+export declare const addNoClaimFeeWhitelistInstruction: (opts: {
+    connection: anchor.web3.Connection;
+    network: Network;
+    programId?: PublicKey;
+    authority: PublicKey;
+    account: PublicKey;
+}) => Promise<anchor.web3.TransactionInstruction[]>;
+export declare const removeNoClaimFeeWhitelistInstruction: (opts: {
+    connection: anchor.web3.Connection;
+    network: Network;
+    programId?: PublicKey;
+    authority: PublicKey;
+    account: PublicKey;
+}) => Promise<anchor.web3.TransactionInstruction[]>;

package/dist/types/instructions/create-global-config.d.ts

@@ -0,0 +1,10 @@
+import * as anchor from '@coral-xyz/anchor';
+import { PublicKey } from '@solana/web3.js';
+import { Network } from '../types';
+export declare const createGlobalConfigInstruction: (opts: {
+    connection: anchor.web3.Connection;
+    network: Network;
+    programId?: PublicKey;
+    authority: PublicKey;
+    feeCollector: PublicKey;
+}) => Promise<anchor.web3.TransactionInstruction[]>;

package/dist/types/instructions/create-project.d.ts

@@ -0,0 +1,11 @@
+import * as anchor from '@coral-xyz/anchor';
+import { PublicKey } from '@solana/web3.js';
+import { Network } from '../types';
+export declare const createProjectInstruction: (opts: {
+    connection: anchor.web3.Connection;
+    network: Network;
+    programId?: PublicKey;
+    authority: PublicKey;
+    projectAdmin: PublicKey;
+    metadataUri: string;
+}) => Promise<anchor.web3.TransactionInstruction[]>;

package/dist/types/instructions/index.d.ts

@@ -0,0 +1,8 @@
+export * from './admin-token-management';
+export * from './create-project';
+export * from './create-global-config';
+export * from './admin-roles';
+export * from './admin';
+export * from './project-budget';
+export * from './project-roles';
+export * from './project';

package/dist/types/instructions/project-budget.d.ts

@@ -0,0 +1,47 @@
+import * as anchor from '@coral-xyz/anchor';
+import { PublicKey } from '@solana/web3.js';
+import { Network } from '../types';
+import { ClaimMessage, Signature } from '../common';
+export declare const depositFungibleTokenInstruction: (opts: {
+    connection: anchor.web3.Connection;
+    network: Network;
+    programId?: PublicKey;
+    authority: PublicKey;
+    projectNonce: anchor.BN;
+    tokenMint: PublicKey;
+    amount: anchor.BN;
+}) => Promise<anchor.web3.TransactionInstruction[]>;
+export declare const depositNonFungibleTokenInstruction: (opts: {
+    connection: anchor.web3.Connection;
+    network: Network;
+    programId?: PublicKey;
+    authority: PublicKey;
+    projectNonce: anchor.BN;
+    tokenMint: PublicKey;
+}) => Promise<anchor.web3.TransactionInstruction[]>;
+export declare const removeNonFungibleTokenInstruction: (opts: {
+    connection: anchor.web3.Connection;
+    network: Network;
+    programId?: PublicKey;
+    authority: PublicKey;
+    projectNonce: anchor.BN;
+    tokenMint: PublicKey;
+}) => Promise<anchor.web3.TransactionInstruction[]>;
+export declare const removeFungibleTokenInstruction: (opts: {
+    connection: anchor.web3.Connection;
+    network: Network;
+    programId?: PublicKey;
+    authority: PublicKey;
+    projectNonce: anchor.BN;
+    tokenMint: PublicKey;
+    amount: anchor.BN;
+}) => Promise<anchor.web3.TransactionInstruction[]>;
+export declare const claim: (opts: {
+    connection: anchor.web3.Connection;
+    network: Network;
+    programId?: PublicKey;
+    authority: PublicKey;
+    projectNonce: anchor.BN;
+    message: ClaimMessage;
+    signatures: Signature[];
+}) => Promise<anchor.web3.TransactionInstruction[]>;

package/dist/types/instructions/project-roles.d.ts

@@ -0,0 +1,29 @@
+import { PublicKey } from '@solana/web3.js';
+import * as anchor from '@coral-xyz/anchor';
+import { Network, ProjectRole } from '../types';
+export declare const grantProjectRoleInstruction: (opts: {
+    connection: anchor.web3.Connection;
+    network: Network;
+    programId?: PublicKey;
+    authority: PublicKey;
+    account: PublicKey;
+    projectNonce: anchor.BN;
+    role: ProjectRole;
+}) => Promise<anchor.web3.TransactionInstruction[]>;
+export declare const revokeProjectRoleInstruction: (opts: {
+    connection: anchor.web3.Connection;
+    network: Network;
+    programId?: PublicKey;
+    authority: PublicKey;
+    projectNonce: anchor.BN;
+    account: PublicKey;
+    role: ProjectRole;
+}) => Promise<anchor.web3.TransactionInstruction[]>;
+export declare const renounceProjectRoleInstruction: (opts: {
+    connection: anchor.web3.Connection;
+    network: Network;
+    programId?: PublicKey;
+    authority: PublicKey;
+    projectNonce: anchor.BN;
+    role: ProjectRole;
+}) => Promise<anchor.web3.TransactionInstruction[]>;

package/dist/types/instructions/project.d.ts

@@ -0,0 +1,13 @@
+import * as anchor from '@coral-xyz/anchor';
+import { PublicKey } from '@solana/web3.js';
+import { Network } from '../types';
+export declare const updateProjectFeesInstruction: (opts: {
+    connection: anchor.web3.Connection;
+    network: Network;
+    programId?: PublicKey;
+    authority: PublicKey;
+    projectNonce: anchor.BN;
+    userNativeClaimFee?: anchor.BN;
+    projectClaimFee?: number;
+    removeFee?: number;
+}) => Promise<anchor.web3.TransactionInstruction[]>;

package/dist/types/pdas.d.ts

@@ -0,0 +1,8 @@
+import * as anchor from '@coral-xyz/anchor';
+import { PublicKey } from '@solana/web3.js';
+export declare const getGlobalConfigPda: (programId: PublicKey) => [anchor.web3.PublicKey, number];
+export declare const getProjectPda: (programId: PublicKey, nonce: anchor.BN) => [anchor.web3.PublicKey, number];
+export declare const getCurrencyTokenPda: (programId: PublicKey, tokenAccount: PublicKey) => [anchor.web3.PublicKey, number];
+export declare const getProjectCurrencyBudgetPda: (programId: PublicKey, project: PublicKey, currencyToken: PublicKey) => [anchor.web3.PublicKey, number];
+export declare const getProjectAttributionPda: (programId: PublicKey, project: PublicKey, proof: Buffer) => [anchor.web3.PublicKey, number];
+export declare const getProjectUserPda: (programId: PublicKey, project: PublicKey, user: PublicKey) => [anchor.web3.PublicKey, number];

package/dist/types/sdks/fuul.d.ts

@@ -0,0 +1,130 @@
+import * as anchor from '@coral-xyz/anchor';
+import { Connection, PublicKey } from '@solana/web3.js';
+import { ClaimMessage, ContractSdk, Signature } from '../common';
+import { FuulIdl } from '../idls/fuul';
+import { CurrencyToken, Project, GlobalConfig, Network, GlobalRole, TokenType, ProjectCurrencyBudget, ProjectRole, ProjectUser } from '../types';
+export declare class FuulSdk extends ContractSdk<FuulIdl> {
+    constructor(connection: Connection, env: Network, programId?: PublicKey);
+    getGlobalConfig(): Promise<GlobalConfig | null>;
+    getProject(nonce: anchor.BN): Promise<Project | null>;
+    getCurrencyToken(tokenAccount: PublicKey): Promise<CurrencyToken | null>;
+    getProjectCurrencyBudget(projectNonce: anchor.BN, currencyTokenMint: PublicKey): Promise<ProjectCurrencyBudget | null>;
+    getProjectUser(projectNonce: anchor.BN, user: PublicKey): Promise<ProjectUser | null>;
+    createGlobalConfig(opts: {
+        authority: PublicKey;
+        feeCollector: PublicKey;
+    }): Promise<anchor.web3.TransactionInstruction[]>;
+    updateGlobalConfig(opts: {
+        authority: PublicKey;
+        claimCoolDown?: anchor.BN;
+        requiredSignersForClaim?: number;
+    }): Promise<anchor.web3.TransactionInstruction[]>;
+    updateGlobalConfigFees(opts: {
+        authority: PublicKey;
+        feeCollector?: PublicKey;
+        userNativeClaimFee?: anchor.BN;
+        projectClaimFee?: number;
+        removeFee?: number;
+    }): Promise<anchor.web3.TransactionInstruction[]>;
+    addNoClaimFeeWhitelist(opts: {
+        authority: PublicKey;
+        account: PublicKey;
+    }): Promise<anchor.web3.TransactionInstruction[]>;
+    removeNoClaimFeeWhitelist(opts: {
+        authority: PublicKey;
+        account: PublicKey;
+    }): Promise<anchor.web3.TransactionInstruction[]>;
+    grantGlobalRole(opts: {
+        authority: PublicKey;
+        account: PublicKey;
+        role: GlobalRole;
+    }): Promise<anchor.web3.TransactionInstruction[]>;
+    revokeGlobalRole(opts: {
+        authority: PublicKey;
+        account: PublicKey;
+        role: GlobalRole;
+    }): Promise<anchor.web3.TransactionInstruction[]>;
+    renounceGlobalRole(opts: {
+        authority: PublicKey;
+        role: GlobalRole;
+    }): Promise<anchor.web3.TransactionInstruction[]>;
+    pauseProgram(opts: {
+        authority: PublicKey;
+    }): Promise<anchor.web3.TransactionInstruction[]>;
+    unpauseProgram(opts: {
+        authority: PublicKey;
+    }): Promise<anchor.web3.TransactionInstruction[]>;
+    addCurrencyToken(opts: {
+        authority: PublicKey;
+        tokenType: TokenType;
+        tokenMint: PublicKey;
+        claimLimitPerCooldown: anchor.BN;
+    }): Promise<anchor.web3.TransactionInstruction[]>;
+    updateCurrencyToken(opts: {
+        authority: PublicKey;
+        tokenMint: PublicKey;
+        isActive?: boolean;
+        claimLimitPerCooldown?: anchor.BN;
+    }): Promise<anchor.web3.TransactionInstruction[]>;
+    removeCurrencyToken(opts: {
+        authority: PublicKey;
+        tokenMint: PublicKey;
+    }): Promise<anchor.web3.TransactionInstruction[]>;
+    createProject(opts: {
+        authority: PublicKey;
+        projectAdmin: PublicKey;
+        metadataUri?: string;
+    }): Promise<anchor.web3.TransactionInstruction[]>;
+    updateProjectFees(opts: {
+        authority: PublicKey;
+        projectNonce: anchor.BN;
+        userNativeClaimFee?: anchor.BN;
+        projectClaimFee?: number;
+        removeFee?: number;
+    }): Promise<anchor.web3.TransactionInstruction[]>;
+    grantProjectRole(opts: {
+        authority: PublicKey;
+        projectNonce: anchor.BN;
+        account: PublicKey;
+        role: ProjectRole;
+    }): Promise<anchor.web3.TransactionInstruction[]>;
+    revokeProjectRole(opts: {
+        authority: PublicKey;
+        projectNonce: anchor.BN;
+        account: PublicKey;
+        role: ProjectRole;
+    }): Promise<anchor.web3.TransactionInstruction[]>;
+    renounceProjectRole(opts: {
+        authority: PublicKey;
+        projectNonce: anchor.BN;
+        role: ProjectRole;
+    }): Promise<anchor.web3.TransactionInstruction[]>;
+    depositFungibleToken(opts: {
+        authority: PublicKey;
+        projectNonce: anchor.BN;
+        tokenMint: PublicKey;
+        amount: anchor.BN;
+    }): Promise<anchor.web3.TransactionInstruction[]>;
+    depositNonFungibleToken(opts: {
+        authority: PublicKey;
+        projectNonce: anchor.BN;
+        tokenMint: PublicKey;
+    }): Promise<anchor.web3.TransactionInstruction[]>;
+    removeNonFungibleToken(opts: {
+        authority: PublicKey;
+        projectNonce: anchor.BN;
+        tokenMint: PublicKey;
+    }): Promise<anchor.web3.TransactionInstruction[]>;
+    removeFungibleToken(opts: {
+        authority: PublicKey;
+        projectNonce: anchor.BN;
+        tokenMint: PublicKey;
+        amount: anchor.BN;
+    }): Promise<anchor.web3.TransactionInstruction[]>;
+    claim(opts: {
+        authority: PublicKey;
+        projectNonce: anchor.BN;
+        message: ClaimMessage;
+        signatures: Signature[];
+    }): Promise<anchor.web3.TransactionInstruction[]>;
+}

package/dist/types/sdks/index.d.ts

@@ -0,0 +1 @@
+export * from './fuul';

package/dist/types/types.d.ts

@@ -0,0 +1,40 @@
+import * as anchor from '@coral-xyz/anchor';
+import { FuulIdl } from './idls/fuul';
+export type TransactionInstruction = anchor.web3.TransactionInstruction;
+declare const program: anchor.Program<FuulIdl>;
+export type GlobalConfig = Awaited<ReturnType<typeof program.account.globalConfig.fetch>>;
+export type CurrencyToken = Awaited<ReturnType<typeof program.account.currencyToken.fetch>>;
+export type Project = Awaited<ReturnType<typeof program.account.project.fetch>>;
+export type ProjectCurrencyBudget = Awaited<ReturnType<typeof program.account.projectCurrencyBudget.fetch>>;
+export type ProjectUser = Awaited<ReturnType<typeof program.account.projectUser.fetch>>;
+export declare enum Network {
+    FOGO_MAINNET = "fogo-mainnet",
+    FOGO_TESTNET = "fogo-testnet",
+    MAINNET = "mainnet",
+    DEVNET = "devnet",
+    TESTNET = "testnet",
+    LOCALHOST = "localhost"
+}
+export declare enum TokenType {
+    Native = "native",
+    FungibleSpl = "fungibleSpl",
+    NonFungibleSpl = "nonFungibleSpl"
+}
+export declare const TokenTypeAnchor: Record<TokenType, any>;
+export declare enum GlobalRole {
+    Admin = "admin",
+    Pauser = "pauser",
+    Unpauser = "unpauser",
+    Signer = "signer"
+}
+export declare const GlobalRoleAnchor: Record<GlobalRole, any>;
+export declare enum ProjectRole {
+    Admin = "admin"
+}
+export declare const ProjectRoleAnchor: Record<ProjectRole, any>;
+export declare enum ClaimReason {
+    AffiliatePayout = "affiliatePayout",
+    EndUserPayout = "endUserPayout"
+}
+export declare const ClaimReasonAnchor: Record<ClaimReason, any>;
+export {};

package/dist/types/utils/ed25519.d.ts

@@ -0,0 +1,7 @@
+import { TransactionInstruction, PublicKey } from '@solana/web3.js';
+import { Signature } from '../common/messages';
+export declare function createEd25519Instruction(signature: Signature, message: Buffer): TransactionInstruction;
+export declare function createEd25519InstructionWithMultipleSigners(signatures: {
+    signature: Uint8Array;
+    signer: PublicKey;
+}[], message: Buffer): TransactionInstruction;

package/dist/types/utils/helpers.d.ts

@@ -0,0 +1,13 @@
+import * as anchor from '@coral-xyz/anchor';
+import { FuulIdl } from '../idls/fuul';
+import { Network } from '../types';
+import { PublicKey } from '@solana/web3.js';
+export declare const getProgram: (opts: {
+    connection: anchor.web3.Connection;
+    network: Network;
+    programId?: PublicKey;
+}) => anchor.Program<FuulIdl>;
+export declare const ensureAtaAccounts: (connection: anchor.web3.Connection, payer: PublicKey, mint: PublicKey, tokenAccounts: {
+    owner: PublicKey;
+    ata: PublicKey;
+}[]) => Promise<anchor.web3.TransactionInstruction[]>;

package/dist/types/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './helpers';

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@fuul/sdk-solana",
+  "version": "0.5.2",
+  "description": "SDK to interact with the Full Solana program",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "scripts": {
+    "build": "npm run build:cjs && npm run build:esm",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "prepare": "husky || true",
+    "lint": "eslint \"src/**/*.ts\"",
+    "lint:fix": "eslint \"src/**/*.ts\" --fix",
+    "docs": "typedoc --options typedoc.json",
+    "docs:serve": "serve ./docs"
+  },
+  "files": ["dist", "README.md"],
+  "repository": {
+    "type": "git",
+    "url": "git+git@github.com:fuul-protocol/protocol-program-svm.git"
+  },
+  "keywords": [
+    "Solana",
+    "Anchor",
+    "Web3"
+  ],
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/fuul-protocol/protocol-program-svm/issues"
+  },
+  "homepage": "https://github.com/fuul-protocol/protocol-program-svm#readme",
+  "dependencies": {
+    "@coral-xyz/anchor": "0.32.1",
+    "@noble/ed25519": "3.0.0",
+    "@solana/web3.js": "1.98.4",
+    "borsh": "2.0.0"
+  },
+  "devDependencies": {
+    "@eslint/eslintrc": "3.3.1",
+    "@eslint/js": "9.39.1",
+    "@typescript-eslint/eslint-plugin": "8.46.3",
+    "@typescript-eslint/parser": "8.46.3",
+    "eslint": "9.39.1",
+    "eslint-config-prettier": "10.1.8",
+    "eslint-plugin-prettier": "5.5.4",
+    "glob": "13.0.0",
+    "globals": "16.5.0",
+    "prettier": "3.6.2",
+    "serve": "14.2.5",
+    "typedoc": "^0.28.14",
+    "typedoc-plugin-markdown": "4.9.0",
+    "typescript": "5.9.3"
+  },
+  "engines": {
+    "node": ">=23"
+  }
+}