TransferChain Docs
  • Introduction to TransferChain
    • Why TransferChain
    • Who is using TransferChain
    • About
  • Client & SDKs
    • Getting Started
      • Introduction to TransferChain SDKs
      • FAQ
    • Python
    • Go
    • Javascript
    • TransferChain SDK Standard
    • Prerequisites
  • CLI
    • About
    • Quickstart
    • Using TransferChain CLI
      • Initialize
      • Storage
      • Blockchain
    • Authentication and Access Credentials
    • Prerequisites
  • Core Concepts
    • Understanding TransferChain
    • Cryptography
      • Authentication & Authorization
      • Encryption
      • Elliptic-Curve
      • Address Generation
    • Blockchain
      • Decentralization
      • Architecture
    • gRPC
    • Data Distribution
    • Immutability
    • Data Redundancy
    • Multi Region Availability
    • Secure Messaging
    • Overview of TransferChain System Components
  • Management & Roles
    • TransferChain Management Portal
    • User Roles
  • Billing & Payment
    • Developer Plan
  • Resources
    • Blog
    • Support Center
    • Knowledge Base
    • Community
Powered by GitBook
On this page
  1. Client & SDKs

TransferChain SDK Standard

SDK Standards

What is the purpose of an SDK standard?

An SDK standard is a description of a protocol, standard, or feature that the TransferChain SDK is expected to use. It should list the required properties of the standard, explain why it was designed this way, and provide detailed technical specifications. The person who wrote the standard is responsible for getting it approved by the community and making sure that everyone agrees with it. An SDK standard must have the following sections:

  • A brief overview of what the standard is about.

  • A motivation for why the standard is needed.

  • A definition of any new terms used in the standard.

  • A description of the system model and properties.

  • A technical specification of the standard.

  • A history of the standard.

  • A copyright notice.

The technical specification is the most important part of the SDK standard. It should include a detailed description of the API, the technical details, the backwards compatibility, any known issues, and an example implementation. The history section should list any documents that inspired the standard and a log of any changes that have been made to it. The copyright notice should state that the standard is licensed under the Apache 2.0 license.

PreviousJavascriptNextPrerequisites

Last updated 11 months ago