Class Mintblue

The main SDK class. Instantiate this class using the Mintblue.create() function

  const token = 'YOUR SDK TOKEN';
  const project_id = 'YOUR PROJECT ID*
  const client = await Mintblue.create({ token: token *
  const outputs = [
    {
      type: 'data',
      value: 'Hello world',
      sign: true,
      encrypt: true,
    },
  ];

  const { txid, rawtx } = await client.createTransaction({ project_id, outputs });

Hierarchy

Mintblue

Index

Methods

create createAccesstoken createTransaction getTransaction listTransactions experimentalStreamProject createProject getProject updateProject listProjects destroyProject listEventListeners getEventListener createEventListener experimentalGetPeppolKeyInfo experimentalGetKVKKeyInfo experimentalGetSigningKeyInfo experimentalGetDeriveKeyInfo

Methods

`Static` create

create(options): Promise<Mintblue>
Instantiate client with accesstoken (SDK-token)
Parameters
- options: MintblueOptions
  
  needs to contain an SDK token
Returns Promise<Mintblue>
MintBlue SDK instance
- Defined in src/lib/mintblue.ts:105

createAccesstoken

createAccesstoken(options): Promise<{
sdkToken: string;
apiToken: string;
}>
Create access token
Parameters
- options: CreateAccesstokenOptions
Returns Promise<{
sdkToken: string;
apiToken: string;
}>
SDK token & API token
- Defined in src/lib/mintblue.ts:143

createTransaction

createTransaction(options): Promise<CreatedTransaction>
Create a blockchain transaction
Parameters
- options: CreateTransactionOptions
Returns Promise<CreatedTransaction>
Published transaction
- Defined in src/lib/mintblue.ts:272

getTransaction

getTransaction(options): Promise<Output[]>
Fetch a blockchain transaction
Parameters
- options: GetTransactionOptions
Returns Promise<Output[]>
Array of decrypted & parsed outputs
- Defined in src/lib/mintblue.ts:284

listTransactions

listTransactions(options): Promise<ListTransactionsResult>
List transactions
Parameters
- options: ListTransactionsOptions
Returns Promise<ListTransactionsResult>
Array of transactions (without payload)
- Defined in src/lib/mintblue.ts:312

experimentalStreamProject

experimentalStreamProject(options): Promise<{
close: (() => void);
}>
Experimental
Stream Project (experimental)

This function allows you to stream experimental data from a project.
Parameters
- options: experimentalStreamProjectOptions
  
  The options for streaming experimental data.
Returns Promise<{
close: (() => void);
}>
A promise that resolves with an object containing a close method. The close method can be used to gracefully close the streaming connection.

This function is experimental and subject to change. Use it with caution.
- Defined in src/lib/mintblue.ts:333

createProject

createProject(options): Promise<Project>
Create a project
Parameters
- options: CreateProjectOptions
Returns Promise<Project>
Array of transactions (without payload)
- Defined in src/lib/mintblue.ts:368

getProject

getProject(params): Promise<Project>
Retrieves project data with the specified ID.
Parameters
- params: {
  id: string;
  }
  
  The parameters for retrieving the project.
  - id: string
    
    The ID of the project to retrieve.
Returns Promise<Project>
A promise that resolves with the retrieved project data.
- Defined in src/lib/mintblue.ts:379

updateProject

updateProject(params): Promise<Project>
Updates a project with the specified ID using the provided data.
Parameters
- params: {
  id: string;
  data: CreateProjectOptions;
  }
  
  The parameters for updating the project.
  - id: string
    
    The ID of the project to update.
  - data: CreateProjectOptions
    
    The data to update the project with.
Returns Promise<Project>
A promise that resolves with the updated project data.
- Defined in src/lib/mintblue.ts:391

listProjects

listProjects(): Promise<Project[]>
Retrieves a list of projects.

Returns Promise<Project[]>
A promise that resolves with an array of project data.
- Defined in src/lib/mintblue.ts:400

destroyProject

destroyProject(params): Promise<void>
Deletes a project with the specified ID.
Parameters
- params: {
  id: string;
  }
  
  The parameters for deleting the project.
  - id: string
    
    The ID of the project to delete.
Returns Promise<void>
A promise that resolves when the project is deleted.
- Defined in src/lib/mintblue.ts:411

listEventListeners

listEventListeners(): Promise<EventListener[]>
Retrieves a list of event listeners.

Returns Promise<EventListener[]>
A promise that resolves with an array of event listener data.
- Defined in src/lib/mintblue.ts:419

getEventListener

getEventListener(id): Promise<EventListener>
Retrieves event listener data with the specified ID.
Parameters
- id: {
  id: string;
  }
  
  The ID of the event listener to retrieve.
  - id: string
Returns Promise<EventListener>
A promise that resolves with the retrieved event listener data.
- Defined in src/lib/mintblue.ts:429

createEventListener

createEventListener(data): Promise<EventListener>
Creates a new event listener.
Parameters
- data: CreateEventListenerOptions
  
  The data for creating the event listener.
Returns Promise<EventListener>
A promise that resolves with the created event listener data.
- Defined in src/lib/mintblue.ts:439

experimentalGetPeppolKeyInfo

experimentalGetPeppolKeyInfo(): {
    uncompressedPublicKey: string;
    compressedPublicKey: string;
    jwk: JWK;
    kid: string;
    info: string;
}
Experimental
Get Peppol Key information

Returns {
    uncompressedPublicKey: string;
    compressedPublicKey: string;
    jwk: JWK;
    kid: string;
    info: string;
}
Object containing uncompressed public key in hex format.
Read more about compressed and decompressed keys here
- uncompressedPublicKey: string
- compressedPublicKey: string
- jwk: JWK
- kid: string
- info: string
- Defined in src/lib/mintblue.ts:450

experimentalGetKVKKeyInfo

experimentalGetKVKKeyInfo(): Promise<{
    uncompressedPublicKey: string;
    compressedPublicKey: string;
    jwk: JWK;
    kid: string;
    info: string;
    SHA1Fingerprint: string;
}>
Experimental
Get Peppol Key information

Returns Promise<{
    uncompressedPublicKey: string;
    compressedPublicKey: string;
    jwk: JWK;
    kid: string;
    info: string;
    SHA1Fingerprint: string;
}>
Object containing uncompressed public key in hex format.
Read more about compressed and decompressed keys here
- Defined in src/lib/mintblue.ts:470

experimentalGetSigningKeyInfo

experimentalGetSigningKeyInfo(): Promise<{
    uncompressedPublicKey: string;
    compressedPublicKey: string;
    jwk: JWK;
    kid: string;
    info: string;
    SHA1Fingerprint: string;
}>
Experimental
Get Signing Key information

Returns Promise<{
    uncompressedPublicKey: string;
    compressedPublicKey: string;
    jwk: JWK;
    kid: string;
    info: string;
    SHA1Fingerprint: string;
}>
Object containing uncompressed public key in hex format.
Read more about compressed and decompressed keys here
- Defined in src/lib/mintblue.ts:494

experimentalGetDeriveKeyInfo

experimentalGetDeriveKeyInfo(): Promise<{
    uncompressedPublicKey: string;
    compressedPublicKey: string;
    jwk: JWK;
    kid: string;
    info: string;
    SHA1Fingerprint: string;
}>
Experimental
Get Derive Key information

Returns Promise<{
    uncompressedPublicKey: string;
    compressedPublicKey: string;
    jwk: JWK;
    kid: string;
    info: string;
    SHA1Fingerprint: string;
}>
Object containing uncompressed public key in hex format.
Read more about compressed and decompressed keys here
- Defined in src/lib/mintblue.ts:518

Class Mintblue

Hierarchy

Index

Methods

Methods

Static create

Parameters

options: MintblueOptions

Returns Promise<Mintblue>

createAccesstoken

Parameters

options: CreateAccesstokenOptions

Returns Promise<{ sdkToken: string; apiToken: string; }>

createTransaction

Parameters

options: CreateTransactionOptions

Returns Promise<CreatedTransaction>

getTransaction

Parameters

options: GetTransactionOptions

Returns Promise<Output[]>

listTransactions

Parameters

options: ListTransactionsOptions

Returns Promise<ListTransactionsResult>

experimentalStreamProject

Parameters

options: experimentalStreamProjectOptions

Returns Promise<{ close: (() => void); }>

createProject

Parameters

options: CreateProjectOptions

Returns Promise<Project>

getProject

Parameters

params: { id: string; }

id: string

Returns Promise<Project>

updateProject

Parameters

params: { id: string; data: CreateProjectOptions; }

id: string

data: CreateProjectOptions

Returns Promise<Project>

listProjects

Returns Promise<Project[]>

destroyProject

Parameters

params: { id: string; }

id: string

Returns Promise<void>

listEventListeners

Returns Promise<EventListener[]>

getEventListener

Parameters

id: { id: string; }

id: string

Returns Promise<EventListener>

createEventListener

Parameters

data: CreateEventListenerOptions

Returns Promise<EventListener>

experimentalGetPeppolKeyInfo

Returns { uncompressedPublicKey: string; compressedPublicKey: string; jwk: JWK; kid: string; info: string; }

uncompressedPublicKey: string

compressedPublicKey: string

jwk: JWK

kid: string

info: string

experimentalGetKVKKeyInfo

Returns Promise<{ uncompressedPublicKey: string; compressedPublicKey: string; jwk: JWK; kid: string; info: string; SHA1Fingerprint: string; }>

experimentalGetSigningKeyInfo

Returns Promise<{ uncompressedPublicKey: string; compressedPublicKey: string; jwk: JWK; kid: string; info: string; SHA1Fingerprint: string; }>

experimentalGetDeriveKeyInfo

Returns Promise<{ uncompressedPublicKey: string; compressedPublicKey: string; jwk: JWK; kid: string; info: string; SHA1Fingerprint: string; }>

Settings

Member Visibility

Theme

On This Page

`Static` create

Returns Promise<{
sdkToken: string;
apiToken: string;
}>

Returns Promise<{
close: (() => void);
}>

params: {
id: string;
}

params: {
id: string;
data: CreateProjectOptions;
}

params: {
id: string;
}

id: {
id: string;
}

Returns {
uncompressedPublicKey: string;
compressedPublicKey: string;
jwk: JWK;
kid: string;
info: string;
}

Returns Promise<{
uncompressedPublicKey: string;
compressedPublicKey: string;
jwk: JWK;
kid: string;
info: string;
SHA1Fingerprint: string;
}>

Returns Promise<{
uncompressedPublicKey: string;
compressedPublicKey: string;
jwk: JWK;
kid: string;
info: string;
SHA1Fingerprint: string;
}>

Returns Promise<{
uncompressedPublicKey: string;
compressedPublicKey: string;
jwk: JWK;
kid: string;
info: string;
SHA1Fingerprint: string;
}>