Welcome to the Nosana Kit API Reference! This documentation is automatically generated from the source code using TypeDoc.
Need Help?
- Check out our Getting Started guide.
- Learn about key concepts in our Core Concept guides.
- Explore code examples.
Overview
@nosana/kit v0.0.0
@nosana/kit
Namespaces
| Namespace | Description |
|---|---|
| JobsClient | - |
| MerkleDistributorClient | - |
| StakingClient | - |
Enumerations
| Enumeration | Description |
|---|---|
| ClaimTarget | Claim target enum for merkle distributor. Determines which address receives the claimed tokens. |
| JobState | - |
| MarketQueueType | - |
Classes
| Class | Description |
|---|---|
| ClaimStatusNotFoundError | Error thrown when a claim status account is not found |
| Logger | - |
| NosanaError | - |
Interfaces
| Interface | Description |
|---|---|
| APIConfig | - |
| ClientConfig | - |
| JobsProgram | Jobs program interface |
| LoggerOptions | - |
| MerkleDistributorProgram | Merkle distributor program interface |
| NosanaClient | The Nosana client interface. Contains all the services and programs needed to interact with the Nosana network. |
| PartialClientConfig | - |
| ProgramConfig | - |
| ProgramDeps | Dependencies for program services |
| SolanaConfig | - |
| SolanaService | Solana service interface |
| SolanaServiceDeps | Dependencies for SolanaService |
| StakeProgram | Stake program interface |
| TokenAccount | - |
| TokenAccountWithBalance | - |
| TokenService | TokenService interface |
| TokenServiceConfig | Config for TokenService |
| TokenServiceDeps | Dependencies for TokenService |
Type Aliases
| Type Alias | Description |
|---|---|
| ClaimStatus | - |
| ConvertTypesForDb | Type helper to convert bigint to number and ReadonlyUint8Array to string |
| Delist | - |
| DelistInstruction | - |
| DelistParams | - |
| ErrorCode | - |
| Extend | - |
| ExtendInstruction | - |
| ExtendParams | - |
| Job | - |
| LogLevel | - |
| Market | - |
| MerkleDistributor | - |
| MonitorEvent | Event types for monitoring (extends SimpleMonitorEvent with run events) |
| MonitorEventType | Monitor event type constants |
| MonitorEventType | - |
| Post | - |
| PostInstruction | - |
| PostParams | - |
| Run | - |
| SimpleMonitorEvent | Simple monitor event (run accounts are auto-merged into job events) |
| SolanaClusterMoniker | - |
| SolanaClusterMoniker | - |
| SolanaCommitment | - |
| SolanaCommitment | - |
| Stake | - |
| Wallet | A wallet that can sign both messages and transactions. This is a combination of MessageSigner and TransactionSigner, allowing the wallet to be used for both message signing and transaction signing. |
Functions
| Function | Description |
|---|---|
| createJobsProgram | - |
| createMerkleDistributorProgram | - |
| createNosanaClient | - |
| createSolanaService | - |
| createStakeProgram | - |
| createTokenService | - |
| getNosanaConfig | - |
| walletToAuthorizationSigner | - |
Variables
| Variable | Description |
|---|---|
| DEFAULT_CONFIGS | - |
| ErrorCodes | - |
@nosana/authorization
Interfaces
| Interface | Description |
|---|---|
| NosanaAuthorization | - |
Type Aliases
| Type Alias | Description |
|---|---|
| AuthorizationStore | - |
| GenerateHeaderOptions | - |
| GenerateOptions | - |
| SignerOrKey | - |
| SignMessageFn | - |
| ValidateOptions | - |
Functions
| Function | Description |
|---|---|
| createNosanaAuthorization | - |
| validate | - |
| validateHeaders | - |
@nosana/ipfs
Interfaces
| Interface | Description |
|---|---|
| IPFSConfig | - |
Type Aliases
| Type Alias | Description |
|---|---|
| FetchClient | - |
| GetOverride | - |
| PostOverride | - |
Functions
| Function | Description |
|---|---|
| createIpfsClient | - |
| ipfsHashToSolBytesArray | - |
| solBytesArrayToIpfsHash | - |
@nosana/endpoints
| Variable | Description |
|---|---|
| createHash | - |
| getExposeIdHash | - |
| getExposePorts | - |
| getJobExposedServices | - |
| getJobExposeIdHash | - |
| isOperator | - |
| isOpExposed | - |
| isSpreadMarker | - |
@nosana/api
Interfaces
| Interface | Description |
|---|---|
| ApiConfig | - |
| ApiDeploymentsApi | - |
| DeploymentsApi | - |
| NosanaApi | - |
| NosanaCreditsApi | - |
| NosanaJobsApi | - |
| NosanaMarketsApi | - |
| TopupVaultOptions | - |
Type Aliases
Functions
| Function | Description |
|---|---|
| createNosanaApi | - |
@nosana/types
Interfaces
| Interface | Description |
|---|---|
| JobExposeSecrets | Job definition types for creating Nosana jobs |
Type Aliases
| Type Alias | Description |
|---|---|
| Alias | Job definition types for creating Nosana jobs |
| Aliases | Job definition types for creating Nosana jobs |
| CMDArray | Job definition types for creating Nosana jobs |
| CMDString | Job definition types for creating Nosana jobs |
| DeploymentId | Job definition types for creating Nosana jobs |
| DeploymentRaw | Job definition types for creating Nosana jobs |
| DeploymentStatus | - |
| DeploymentStrategy | - |
| DockerAuth | Job definition types for creating Nosana jobs |
| EndpointSecret | Job definition types for creating Nosana jobs |
| EndpointStatus | Job definition types for creating Nosana jobs |
| Env | Job definition types for creating Nosana jobs |
| Events | Job definition types for creating Nosana jobs |
| Execution | Job definition types for creating Nosana jobs |
| Expose | Job definition types for creating Nosana jobs |
| ExposeBase | Job definition types for creating Nosana jobs |
| ExposedPort | Job definition types for creating Nosana jobs |
| Flow | Job definition types for creating Nosana jobs |
| FlowSecrets | Job definition types for creating Nosana jobs |
| FlowState | Job definition types for creating Nosana jobs |
| GPU | Job definition types for creating Nosana jobs |
| HealthCheck | Job definition types for creating Nosana jobs |
| HealthCheckType | - |
| HFResource | Job definition types for creating Nosana jobs |
| HttpHealthCheck | Job definition types for creating Nosana jobs |
| Image | Job definition types for creating Nosana jobs |
| JobDefinition | Job definition types for creating Nosana jobs |
| LiteralString | Job definition types for creating Nosana jobs |
| Log | Job definition types for creating Nosana jobs |
| Logistic | Job definition types for creating Nosana jobs |
| LogTypeTuple | Job definition types for creating Nosana jobs |
| MarketQueue | - |
| Meta | Job definition types for creating Nosana jobs |
| NosanaNetwork | - |
| OllamaResource | Job definition types for creating Nosana jobs |
| Operation | Job definition types for creating Nosana jobs |
| OperationArgsMap | Job definition types for creating Nosana jobs |
| OperationResult | Job definition types for creating Nosana jobs |
| OperationResults | Job definition types for creating Nosana jobs |
| OperationType | Job definition types for creating Nosana jobs |
| Ops | Job definition types for creating Nosana jobs |
| OpState | Job definition types for creating Nosana jobs |
| Port | Job definition types for creating Nosana jobs |
| Private | Job definition types for creating Nosana jobs |
| RemoveIfEmptyMarker | Job definition types for creating Nosana jobs |
| RequiredResource | Job definition types for creating Nosana jobs |
| Resource | Job definition types for creating Nosana jobs |
| ResourceBase | Job definition types for creating Nosana jobs |
| Resources | Job definition types for creating Nosana jobs |
| ResourceType | Job definition types for creating Nosana jobs |
| Revision | Job definition types for creating Nosana jobs |
| S3Auth | Job definition types for creating Nosana jobs |
| S3Base | Job definition types for creating Nosana jobs |
| S3Resource | Job definition types for creating Nosana jobs |
| S3Unsecure | Job definition types for creating Nosana jobs |
| S3WithBucket | Job definition types for creating Nosana jobs |
| S3WithBuckets | Job definition types for creating Nosana jobs |
| ServiceType | - |
| SpreadMarker | Job definition types for creating Nosana jobs |
| StdOption | Job definition types for creating Nosana jobs |
| Task | Job definition types for creating Nosana jobs |
| TypesJob | Job definition types for creating Nosana jobs |
| TypesMarket | Job definition types for creating Nosana jobs |
| TypesRun | Job definition types for creating Nosana jobs |
| UniqueExposedPorts | Job definition types for creating Nosana jobs |
| UniqueLogTypeTag | Job definition types for creating Nosana jobs |
| Variables | Job definition types for creating Nosana jobs |
| VaultRaw | Job definition types for creating Nosana jobs |
| Volume | Job definition types for creating Nosana jobs |
| webhooks | Job definition types for creating Nosana jobs |
| WebSocketHealthCheck | Job definition types for creating Nosana jobs |
| WorkDir | Job definition types for creating Nosana jobs |
Variables
| Variable | Description |
|---|---|
| DeploymentStatus | - |
| DeploymentStrategy | - |
| HealthCheckType | - |
| jobSchemas | - |
| LogisticType | Logistic type for job definitions. - api - we receive and send via an endpoint - api-listen - we create an endpoint to listen for incoming requests |
| MarketQueue | - |
| NosanaNetwork | - |
| ResourceTypeEnum | - |
| ServiceType | - |
| StdOptions | - |
| validateJobDefinition | - |
@solana/kit
Type Aliases
| Type Alias | Description |
|---|---|
| Address | Represents a string that validates as a Solana address or public key. |
Functions
| Function | Description |
|---|---|
| address | - |
Interfaces
| Interface | Description |
|---|---|
| Vault | Vault interface for managing deployment funding. NOTE: Implementation will be provided by @nosana/kit |
Note
This documentation is automatically generated from the source code using TypeDoc. If you find any issues or have suggestions, please open an issue.