The AP Dev Kit encapsulates all the essential components for a successful integration with Access Protocol, serving as a versatile guide for developers. It enables smart contract interactions, account management, and staking functionalities within the Access Protocol ecosystem, paired with a Nuxt v2 front-end. Additionally, it offers a starting point for a WordPress integration, providing a blueprint for managing premium content access and facilitating further development and custom implementations.
"0.1.8" - This package provides utility functions and classes for working with SPL Tokens on the Solana blockchain, which are similar to ERC-20 tokens on Ethereum.
"^0.9.5" - This is a base package for Solana wallet adapters, providing interfaces and types which standardize the connection between Solana wallets and applications.
"^0.15.5" - This package includes a collection of adapters for popular Solana wallets, allowing seamless integration and interaction with these wallets within your application.
"^1.47.3" - The Solana JavaScript API library (web3.js) enables communication with the Solana blockchain, offering functions to send transactions, query balances and state, and listen for events.
"*" - For creating and verifying JSON Web Tokens.
"*" - For parsing and serializing cookies.
"0.2.11" - smartcontract-jsbindings
The smartcontract-jsbindings folder contains the Javascript bindings of the smart contract. This package is published on NPM
npm i @access-protocol/js
yarn add @access-protocol/js
End to end tests are implemented using jest, they can be run using
yarn amman:start
yarn jest
Sever side clients used to interact with Access Protocol on the Solana Network
Provides a client in server-side applications like Nuxt.js, Next.js, expressjs or fastify to check if a user has access via the Access Protocol product.
Connection, PublicKey: From@solana/web3.jsfor blockchain interactions.getUserStakeState, getStakeAccount, getPoolData: From~/services/access/poolsfor accessing stake-related data.
- A default function that accepts a configuration object and returns an object with:
userHasAccess: An asynchronous function that takes aPublicKeyas an owner and returns a boolean indicating whether the user has access based on their stake state.
...
// Check amount staked
const isValidStake = await solana.userHasAccess(new PublicKey(address))
if (!isValidStake) {
return new ApiResponse(false, ErrorMessage.InvalidStake)
}
...Manages JWT-based authentication, including signing, decoding, verifying, and token management for server applications.
jsonwebtoken: For creating and verifying JSON Web Tokens.cookie: For parsing and serializing cookies.
- A default function that returns an object with methods for:
sign: Signs data into a JWT and sets it as a cookie in the response.decode: Decodes a JWT to retrieve its payload.getToken: Extracts the token from the request cookies.verify: Verifies a JWT and executes a callback function.isValid: Checks if a token is valid without throwing an error.validate: Validates the request's token and assigns payload to the request user object.destroy: Clears the authentication cookie from the response.
import jwt from '~/clients/auth'
function userHasAccessToPost (post, user): boolean {
if (post?.isAccess) {
return !!user.hasAccess
}
return false
}
...
const auth = jwt($config.JWT_SECRET)
auth.validate(request)
...
if (userHasAccessToPost(post, req.user)) {
//show full content
}-
Interface for the Staking Program
programId: PublicKey representing the unique identifier for the staking programconnection: Connection object used to communicate with the Solana blockchaincentralState: Object that holds the central state of the staking programunstakeURL: String URL to be used for unstaking operations
-
Default State Function for the Staking Program
- Returns a default
Programobject with initial empty states:programId: Initialized to an empty object, should be replaced with an actual PublicKeyconnection: Initialized to an empty object, to be set up with a Solana blockchain connectioncentralState: Initialized to an empty object, intended to hold stateful information of the programunstakeURL: Initialized to an empty string, should be assigned the endpoint for the unstake operation.
- Returns a default
- State Object for the Staking Application
poolID: Unique identifier for the staking poolhasAccess: Boolean flag indicating if the user has access to premium contentminStake: Minimum amount of tokens required to stake for accessuserBalance: The current balance of the user's walletrewards: The amount of rewards earned from stakingstakedAmount: The total amount of tokens the user has stakedstakeAccount: Object containing details of the user's staking accountstakeKey: Object holding keys pertaining to the user's stakestakerAta: Associated Token Account (ATA) for the stakerstakerAtaAccount: Object containing the staker's ATA account detailsdata: Miscellaneous data related to the staking process or user's stakeassociatedWallet: Boolean indicating if a wallet is associated with the stakerindicators: Object used for tracking various UI indicatorsprotocolFee: The fee charged by the protocol for staking services (2% in this case)loading: Boolean flag to indicate if a loading process is ongoingloadingAction: Describes the action being performed during loadingerror: String detailing any errors that have occurred during staking operations
This section outlines the types used in the Staking.ts module for the staking functionality.
Represents detailed information about a staking pool.
email: Contact email for the pool.name: Name of the pool.publicKey: Solana public key for the pool.description: Description of the pool.twitter: Twitter handle associated with the pool.website: Website URL for the pool.image_url: URL for the pool's image.hero_image_url: Optional URL for the pool's hero image.logo_image_url: Optional URL for the pool's logo.hasAccess: Boolean indicating access status.
Describes status indicators for the UI.
name: Name of the indicator.status: Status level.text: Descriptive text for the indicator.
Combines StakePool from @theblockcrypto/ap with PoolData.
Defines the structure of a stake in a pool.
poolID: Identifier for the staking pool.data: OptionalStakePooldata.stakeAccount: OptionalStakeAccountinformation.stakeKey: Generic key related to the stake.stakerAta: Public key for the staker's associated token account.stakerAtaAccount: Account information for the staker's ATA.minStake: Minimum stake amount required.userBalance: User's current balance.rewards: Earned staking rewards.stakedAmount: Amount staked by the user.associatedWallet: Indicates if a wallet is associated.indicators: Collection ofIndicatorobjects.protocolFee: Fee percentage for the protocol.loading: Indicates if a loading process is in progress.loadingAction: Describes the current loading action.error: Details any errors encountered.hasAccess: Indicates if the user has access (initialized as false).
The apiResponse.ts module defines structures for handling API responses in the system.
Describes the response structure for a nonce request.
nonce: A unique string used for security purposes during authentication.
Describes the response structure after a login attempt.
token: A string token representing the user's session or authentication state.
A union type that can be an ErrorMessage, NonceResponse, or LoginResponse.
A class representing a generic API response structure.
success: A boolean indicating if the API request was successful.result: The content of the response, which can be undefined or any of the types defined byResult.
This module provides a standardized way to handle different types of API responses, whether they're related to authentication or error handling.
Defines the structure for errors related to the Phantom wallet interactions.
code: Numerical code representing specific error types (e.g., 4900, 4100, 4001, -32000, -32003, -32601, -32603).message: Descriptive string providing details about the error.
Enumerates common error messages related to Access Protocol operations.
ErrorGeneratingNonce: Indicates a failure in nonce generation.InvalidNonce: Specifies that the provided nonce is not valid.InvalidStake: Denotes an error with the stake operation, such as incorrect parameters or failure in processing.ErrorValidatingNonce: Signifies an issue encountered during the nonce validation process.
Defines a standard format for requesting the balance of a Solana wallet.
Connection: From the@solana/web3.jslibrary, represents a connection to a Solana cluster.PublicKey: Also from@solana/web3.js, denotes a public key on the Solana blockchain.
walletPubKey: APublicKeyinstance representing the wallet's public key.connection: An instance ofConnectionto interact with the Solana network.
-
@solana/web3.js:Connection: Manages the network connection to Solana.LAMPORTS_PER_SOL: Converts lamports to SOL units.PublicKey: Works with Solana public keys.Transaction: Constructs and signs blockchain transactions.TransactionInstruction: Defines transaction instructions.
-
@solana/wallet-adapter-base:SendTransactionOptions: Options for transaction sending.
sendTx: Sends a transaction and confirms it with the Solana network.getSOLBalance: Retrieves and returns the SOL balance for a given public key.
sleep: Delays execution for a set amount of milliseconds.confirmTransaction: Confirms the transaction on the network, with retry logic.
MAX_CONFIRM_ATTEMPTS: Maximum number of attempts to confirm a transaction.
The Pools Service module provides a set of functions for managing and interacting with staking pools on the Solana blockchain.
@solana/web3.js: Provides the core Solana blockchain interaction functionality.@solana/spl-token: Solana's token program library, for working with SPL tokens.@theblockcrypto/ap: Contains the Access Protocol's specific staking logic.@/services/solana: A local module for handling Solana transactions.
getPoolData: Retrieves the details of a staking pool.getStakeAccount: Obtains information about a staker's account.createAccessStakeAccount: Creates a new staking account under the Access Protocol.getAssociatedTokenAddressAndAccount: Finds the associated token address and account details for a user.createAssociatedTokenAccountInstruction: Creates a token account associated with the user's staking account.claimAccessRewards: Claims rewards for participating in staking.stakeToPool: Facilitates staking operations by processing staking transactions.getBondAccounts: Gathers bond account data for a given owner.getUserStakeState: Evaluates the staking status and access eligibility of a user.getBondAccountStakeAmounts: Computes the total staked amount within bond accounts.crankAccessPool: Processes staking pool transactions through the crank instruction.calculateRewardForStaker: Calculates potential rewards for a staker based on various parameters.calculateRewardForPool: Estimates the rewards for a pool over a period of unclaimed days.
This module (service/access/user.ts) includes functionalities related to user operations within a Solana-based application.
@solana/spl-token: Provides functionality for handling SPL tokens on the Solana blockchain.@solana/web3.js: Core library for Solana blockchain interaction.bn.js: Library for working with big numbers in JavaScript.selectn: A utility for safely accessing nested JavaScript properties.
UserRole: Defines user roles within the system, such asUserandAdmin.
UserData: Defines the structure for user data, including their balance and role.
fetchAssociatedTokenAddress: Retrieves the associated token address for a given public key.fetchUser: Fetches and returns user data, including balance and role determination based on authority comparison.
Add Access Protocol fields to the post editor. This will only add fields if Advanced Custom Fields Pro is installed (https://www.advancedcustomfields.com/) , it does not affect the frontend of a site at all by itself.
- Title: Access Protocol
- Field Key:
field_ap-post-is-access - Name:
ap-post-is-access - Type:
true_false(Boolean) - Default Value:
0(False) - Message: 'Is Access'
- Instructions: Set a flag in WordPress to enable Access Protocol for a post. Specify additional post types if necessary.
This custom field is accessible on the post edit screen within the WordPress dashboard.
To check the Access Protocol state for a post:
$is_access = get_field('ap-post-is-access', $post->ID);