the_bulletin_board_for_trust

TheBulletinBoardForTrust - JavaScript client for the_bulletin_board_for_trust Bulletin Board Service This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• Package version: 1.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://github.com/USTRWG/bulletin-board-api

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install the_bulletin_board_for_trust --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your the_bulletin_board_for_trust from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var TheBulletinBoardForTrust = require('the_bulletin_board_for_trust');


var api = new TheBulletinBoardForTrust.BulletinBoardServiceApi()
var address = "address_example"; // {String} The SHA512 of the blockchain address.
var body = new TheBulletinBoardForTrust.CreateAddressOwnershipRequest(); // {CreateAddressOwnershipRequest} 
api.createAddressOwnership(address, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- TheBulletinBoardForTrust.BulletinBoardServiceApi | createAddressOwnership | PUT /v1/addresses/{address} | Claim custody of an (address/chain) TheBulletinBoardForTrust.BulletinBoardServiceApi | createAddressOwnershipProof | PUT /v1/address_ownership_proofs/{address} | Submit a proof of address ownership for a previously claimed (address/chain) TheBulletinBoardForTrust.BulletinBoardServiceApi | deleteAddressOwnership | DELETE /v1/addresses/{address} | Delete a Record of Address Custody TheBulletinBoardForTrust.BulletinBoardServiceApi | getAddressOwnership | GET /v1/addresses/{address} | Retrieve the custody of an address and the proof of address ownership TheBulletinBoardForTrust.BulletinBoardServiceApi | getVasp | GET /v1/vasps/{vaspId} | Retrieve the information of a specific VASP TheBulletinBoardForTrust.BulletinBoardServiceApi | getVasps | GET /v1/vasps | Retrieve the information of all VASPs TheBulletinBoardForTrust.BulletinBoardServiceApi | health | GET /health | Health check endpoint

Documentation for Models

• TheBulletinBoardForTrust.BulletinBoardV1AddressOwnershipProof
• TheBulletinBoardForTrust.BulletinBoardV1AuxProofData
• TheBulletinBoardForTrust.BulletinBoardV1CreateAddressOwnershipProofResponse
• TheBulletinBoardForTrust.BulletinBoardV1CreateAddressOwnershipResponse
• TheBulletinBoardForTrust.BulletinBoardV1DeleteAddressOwnershipResponse
• TheBulletinBoardForTrust.BulletinBoardV1GetAddressOwnershipResponse
• TheBulletinBoardForTrust.BulletinBoardV1GetVaspResponse
• TheBulletinBoardForTrust.BulletinBoardV1GetVaspsResponse
• TheBulletinBoardForTrust.BulletinBoardV1HealthResponse
• TheBulletinBoardForTrust.BulletinBoardV1VASP
• TheBulletinBoardForTrust.CreateAddressOwnershipProofRequest
• TheBulletinBoardForTrust.CreateAddressOwnershipRequest
• TheBulletinBoardForTrust.GoogleProtobufAny
• TheBulletinBoardForTrust.GoogleRpcStatus

Documentation for Authorization

All endpoints do not require authorization.