InitialiseTokenTaps

InitialiseTokenTaps initialises the available token taps.

Overview

Method Options

Authorisation specification of the InitialiseTokenTaps method.

Type	METHOD_TYPE_WRITE
Access Level	METHOD_ACCESS_LEVEL_PUBLIC
Roles

Parameters

Request and response parameter message overview:

Input: InitialiseTokenTapsRequest Message

No parameters required.

Returns: InitialiseTokenTapsResponse Message

No response fields documented.

Protobuf

syntax = "proto3";

package meshtrade.testing.ledger.token_tap.v1;

import "buf/validate/validate.proto";
import "meshtrade/option/method_options/v1/method_options.proto";
import "meshtrade/testing/ledger/token_tap/v1/option.proto";
import "meshtrade/type/v1/amount.proto";
import "meshtrade/type/v1/token.proto";

option go_package = "github.com/meshtrade/api/go/testing/ledger/token_tap/v1;token_tap_v1";
option java_package = "co.meshtrade.api.testing.ledger.token_tap.v1";

/*
   TokenTapService provides token distribution and minting functionality for testing
   and development purposes. It enables initialization of token taps, querying
   available tokens, and minting tokens to specified addresses.
*/
service TokenTapService {
  // InitialiseTokenTaps initialises the available token taps.
  rpc InitialiseTokenTaps(InitialiseTokenTapsRequest) returns (InitialiseTokenTapsResponse) {
    option (meshtrade.option.method_options.v1.method_options) = {
      type: METHOD_TYPE_WRITE
      access_level: METHOD_ACCESS_LEVEL_PUBLIC
    };
  }

  // ListTokenTaps retrieves the list of available tokens for minting.
  rpc ListTokenTaps(ListTokenTapsRequest) returns (ListTokenTapsResponse) {
    option (meshtrade.option.method_options.v1.method_options) = {
      type: METHOD_TYPE_READ
      access_level: METHOD_ACCESS_LEVEL_PUBLIC
    };
  }

  // MintToken creates and distributes tokens to the specified address.
  rpc MintToken(MintTokenRequest) returns (MintTokenResponse) {
    option (meshtrade.option.method_options.v1.method_options) = {
      type: METHOD_TYPE_WRITE
      access_level: METHOD_ACCESS_LEVEL_PUBLIC
    };
  }
}

// InitialiseTokenTapsRequest is the message used to initialize token taps.
message InitialiseTokenTapsRequest {}

// InitialiseTokenTapsResponse is the response message from initializing token taps.
message InitialiseTokenTapsResponse {}

// ListTokenTapsRequest is the message used to retrieve available tokens.
message ListTokenTapsRequest {}

// ListTokenTapsResponse contains a list of available tokens for minting.
message ListTokenTapsResponse {
  // Available tokens that can be minted.
  repeated type.v1.Token tokens = 1;
}

// MintTokenRequest is the message used to mint tokens to an address.
message MintTokenRequest {
  // The amount of tokens to mint. Must be specified.
  type.v1.Amount amount = 1 [(buf.validate.field) = {required: true}];
  // The blockchain address to mint tokens to. Must be specified.
  string address = 2 [(buf.validate.field) = {required: true}];
  // Optional parameters for customizing the mint operation.
  meshtrade.testing.ledger.token_tap.v1.MintTokenOptions options = 3;
}

// MintTokenResponse is the response message from minting tokens.
message MintTokenResponse {}

Code Examples

Select supported SDK in the language of your choice for a full example of how to invoke the this method:

Go

package main

import (
	"context"
	"log"

	token_tapv1 "github.com/meshtrade/api/go/testing/ledger/token_tap/v1"
)

func main() {
	ctx := context.Background()

	// Default configuration is used and credentials come from MESH_API_CREDENTIALS
	// environment variable or default discovery methods. Zero config required
	// unless you want custom configuration.
	service, err := token_tapv1.NewTokenTapService()
	if err != nil {
		log.Fatalf("Failed to create service: %v", err)
	}
	defer service.Close()

	// Initialize the token tapping infrastructure
	// The InitialiseTokenTapsRequest takes no parameters
	request := &token_tapv1.InitialiseTokenTapsRequest{}

	// Call the InitialiseTokenTaps method to set up token tapping
	response, err := service.InitialiseTokenTaps(ctx, request)
	if err != nil {
		log.Fatalf("InitialiseTokenTaps failed: %v", err)
	}

	// Token tapping infrastructure has been initialized successfully
	log.Printf("Token tapping infrastructure initialized successfully: %+v", response)
}

Python

from meshtrade.testing.ledger.token_tap.v1 import (
    InitialiseTokenTapsRequest,
    TokenTapService,
)


def main():
    # Default configuration is used and credentials come from MESH_API_CREDENTIALS
    # environment variable or default discovery methods. Zero config required
    # unless you want custom configuration.
    service = TokenTapService()

    with service:
        # Initialize the token tapping infrastructure
        # The InitialiseTokenTapsRequest takes no parameters
        request = InitialiseTokenTapsRequest()

        # Call the InitialiseTokenTaps method to set up token tapping
        response = service.initialise_token_taps(request)

        # Token tapping infrastructure has been initialized successfully
        print("Token tapping infrastructure initialized successfully:", response)


if __name__ == "__main__":
    main()

Java

import co.meshtrade.api.testing.ledger.token_tap.v1.TokenTapService;
import co.meshtrade.api.testing.ledger.token_tap.v1.Service.InitialiseTokenTapsRequest;
import co.meshtrade.api.testing.ledger.token_tap.v1.Service.InitialiseTokenTapsResponse;

import java.util.Optional;

public class InitialiseTokenTapsExample {
    public static void main(String[] args) {
        // Default configuration is used and credentials come from MESH_API_CREDENTIALS
        // environment variable or default discovery methods. Zero config required
        // unless you want custom configuration.
        try (TokenTapService service = new TokenTapService()) {
            // Initialize the token tapping infrastructure
            // The InitialiseTokenTapsRequest takes no parameters
            InitialiseTokenTapsRequest request = InitialiseTokenTapsRequest.newBuilder()
                .build();

            // Call the InitialiseTokenTaps method to set up token tapping
            InitialiseTokenTapsResponse response = service.initialiseTokenTaps(
                request,
                Optional.empty()
            );

            // Token tapping infrastructure has been initialized successfully
            System.out.println("Token tapping infrastructure initialized successfully: " + response);
        } catch (Exception e) {
            System.err.println("InitialiseTokenTaps failed: " + e.getMessage());
            e.printStackTrace();
        }
    }
}

Advanced Configuration

For advanced client configuration options (custom endpoints, TLS settings, timeouts), see the SDK Configuration Guide.

Other Methods

• Testing/Ledger Token Tap v1 Method List - For Other methods