@settlemint/sdk-js
Advanced tools
Core JavaScript SDK for integrating SettleMint's blockchain platform services into your applications
✨ https://settlemint.com ✨
Integrate SettleMint into your application with ease.
The SettleMint JavaScript SDK provides a type-safe wrapper around the SettleMint platform's GraphQL API. It enables you to interact with the platform's services in a fully typed manner, providing compile-time safety and autocompletion support.
createSettleMintClient(
options):SettlemintClient
Defined in: settlemint.ts:216
Creates a SettleMint client with the provided options. The client provides methods to interact with various SettleMint resources like workspaces, applications, blockchain networks, blockchain nodes, middleware, integration tools, storage, private keys, insights and custom deployments.
| Parameter | Type | Description |
|---|---|---|
options | SettlemintClientOptions | Configuration options for the client including access token and instance URL |
A SettleMint client object with resource-specific methods
If options are invalid or if called in browser environment
If provided options fail schema validation
import { createSettleMintClient } from '@settlemint/sdk-js';
const client = createSettleMintClient({
accessToken: process.env.SETTLEMINT_ACCESS_TOKEN,
instance: process.env.SETTLEMINT_INSTANCE,
});
// List workspaces
const workspaces = await client.workspace.list();
// Read a specific workspace
const workspace = await client.workspace.read('workspace-unique-name');
Defined in: settlemint.ts:111
Client interface for interacting with the SettleMint platform.
Defined in: settlemint.ts:103
Options for the Settlemint client.
ClientOptions| Property | Type | Default value | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
accessToken | string | AccessTokenSchema | The access token used to authenticate with the SettleMint platform | ClientOptions.accessToken | helpers/client-options.schema.ts:9 |
anonymous? | boolean | undefined | Whether to allow anonymous access (no access token required) | - | settlemint.ts:105 |
instance | string | UrlSchema | The URL of the SettleMint instance to connect to | ClientOptions.instance | helpers/client-options.schema.ts:11 |
Application:
ResultOf<typeofApplicationFragment>
Defined in: graphql/application.ts:24
Type representing an application entity.
BlockchainNetwork:
ResultOf<typeofBlockchainNetworkFragment>
Defined in: graphql/blockchain-network.ts:32
Type representing a blockchain network entity.
BlockchainNode:
ResultOf<typeofBlockchainNodeFragment>
Defined in: graphql/blockchain-node.ts:51
Type representing a blockchain node entity.
CustomDeployment:
ResultOf<typeofCustomDeploymentFragment>
Defined in: graphql/custom-deployment.ts:33
Type representing a custom deployment entity.
Insights:
ResultOf<typeofInsightsFragment>
Defined in: graphql/insights.ts:37
Type representing an insights entity.
IntegrationTool:
ResultOf<typeofIntegrationFragment>
Defined in: graphql/integration-tool.ts:35
Type representing an integration tool entity.
Middleware:
ResultOf<typeofMiddlewareFragment>
Defined in: graphql/middleware.ts:43
Type representing a middleware entity.
MiddlewareWithSubgraphs:
ResultOf<typeofgetGraphMiddlewareSubgraphs>["middlewareByUniqueName"]
Defined in: graphql/middleware.ts:101
Type representing a middleware entity with subgraphs.
PlatformConfig:
ResultOf<typeofgetPlatformConfigQuery>["config"]
Defined in: graphql/platform.ts:45
Type representing the platform configuration.
PrivateKey:
ResultOf<typeofPrivateKeyFragment>
Defined in: graphql/private-key.ts:27
Type representing a private key entity.
Storage:
ResultOf<typeofStorageFragment>
Defined in: graphql/storage.ts:35
Type representing a storage entity.
Workspace:
ResultOf<typeofWorkspaceFragment>
Defined in: graphql/workspace.ts:26
Type representing a workspace entity.
We welcome contributions from the community! Please check out our Contributing guide to learn how you can help improve the SettleMint SDK through bug reports, feature requests, documentation updates, or code contributions.
The SettleMint SDK is released under the FSL Software License. See the LICENSE file for more details.
FAQs
Core JavaScript SDK for integrating SettleMint's blockchain platform services into your applications
We found that @settlemint/sdk-js demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.