JSPM

@settlemint/sdk-js

2.4.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 7321
  • Score
    100M100P100Q119671F
  • License FSL-1.1-MIT

Core JavaScript SDK for integrating SettleMint's blockchain platform services into your applications

Package Exports

  • @settlemint/sdk-js
  • @settlemint/sdk-js/package.json

Readme

SettleMint logo

SettleMint SDK

✨ https://settlemint.com ✨
Integrate SettleMint into your application with ease.

CI status License npm stars

Documentation   •   NPM   •   Issues

Table of Contents

About

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.

API Reference

Functions

createSettleMintClient()

createSettleMintClient(options): SettlemintClient

Defined in: settlemint.ts:275

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.

Parameters
Parameter Type Description
options SettlemintClientOptions Configuration options for the client including access token and instance URL
Returns

SettlemintClient

A SettleMint client object with resource-specific methods

Throws

If options are invalid or if called in browser environment

Throws

If provided options fail schema validation

Example
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');

Interfaces

SettlemintClient

Defined in: settlemint.ts:145

Client interface for interacting with the SettleMint platform.

SettlemintClientOptions

Defined in: settlemint.ts:135

Options for the Settlemint client.

Extends
  • Omit<ClientOptions, "accessToken">
Properties
Property Type Default value Description Inherited from Defined in
accessToken? string undefined The access token used to authenticate with the SettleMint platform - settlemint.ts:137
anonymous? boolean undefined Whether to allow anonymous access (no access token required) - settlemint.ts:139
instance string UrlSchema The URL of the SettleMint instance to connect to Omit.instance helpers/client-options.schema.ts:11

Type Aliases

Application

Application = ResultOf<*typeof* ApplicationFragment>

Defined in: graphql/application.ts:24

Type representing an application entity.

BlockchainNetwork

BlockchainNetwork = ResultOf<*typeof* BlockchainNetworkFragment>

Defined in: graphql/blockchain-network.ts:82

Type representing a blockchain network entity.

BlockchainNode

BlockchainNode = ResultOf<*typeof* BlockchainNodeFragment>

Defined in: graphql/blockchain-node.ts:96

Type representing a blockchain node entity.

CustomDeployment

CustomDeployment = ResultOf<*typeof* CustomDeploymentFragment>

Defined in: graphql/custom-deployment.ts:33

Type representing a custom deployment entity.

Insights

Insights = ResultOf<*typeof* InsightsFragment>

Defined in: graphql/insights.ts:37

Type representing an insights entity.

IntegrationTool

IntegrationTool = ResultOf<*typeof* IntegrationFragment>

Defined in: graphql/integration-tool.ts:35

Type representing an integration tool entity.

LoadBalancer

LoadBalancer = ResultOf<*typeof* LoadBalancerFragment>

Defined in: graphql/load-balancer.ts:31

Type representing a load balancer entity.

Middleware

Middleware = ResultOf<*typeof* MiddlewareFragment>

Defined in: graphql/middleware.ts:43

Type representing a middleware entity.

MiddlewareWithSubgraphs

MiddlewareWithSubgraphs = ResultOf<*typeof* getGraphMiddlewareSubgraphs>["middlewareByUniqueName"]

Defined in: graphql/middleware.ts:101

Type representing a middleware entity with subgraphs.

PlatformConfig

PlatformConfig = ResultOf<*typeof* getPlatformConfigQuery>["config"]

Defined in: graphql/platform.ts:56

Type representing the platform configuration.

PrivateKey

PrivateKey = ResultOf<*typeof* PrivateKeyFragment>

Defined in: graphql/private-key.ts:44

Type representing a private key entity.

Storage

Storage = ResultOf<*typeof* StorageFragment>

Defined in: graphql/storage.ts:35

Type representing a storage entity.

Workspace

Workspace = ResultOf<*typeof* WorkspaceFragment>

Defined in: graphql/workspace.ts:26

Type representing a workspace entity.

Contributing

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.

License

The SettleMint SDK is released under the FSL Software License. See the LICENSE file for more details.