Typescript

minima-global · Dec 31, 2020 · 4cc7f46 · 4cc7f46
1 parent b96f93c
commit 4cc7f46
Show file tree

Hide file tree

Showing 30 changed files with 188 additions and 5 deletions.
diff --git a/docs/api/api.rst b/docs/api/api.rst
@@ -1,6 +1,6 @@
-####################
-Minima API Functions
-####################
+##########
+Minima API
+##########
 
 The Minima API is used to drive MiniDapps.
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -6,9 +6,9 @@ minima.js
     :alt: Minima logo
     :align: center
 
-Minima is a cryptocurrency designed to be ultra-compact. Designed to remain Totally Decentralised. Designed to have no rulers. There are no miners and no ever-growing database. A simple yet powerful scripting language, Cascading Proof Chain, adaptive block scaling, and an innovative Proof of Work (PoW) backed user-centric blockchain algorithm that uses both on-chain and off-chain traffic for security. All Quantum Secure Cryptography. Small enough to run efficiently on your mobile phone. Everyone runs a complete node. Forever.
+Minima is a wholly decentralised, mobile-first, quantum secure cryptocurrency. There are no miners and no database that grows indefinitely. It features a simple yet powerful scripting language, adaptive block scaling, and an innovative proof of work consensus protocol featuring a cascading proof blockchain secured by a user-centric algorithm that uses both on-chain and off-chain traffic. Everyone runs a complete node. Forever.
 
-Minima.js is the means by which it is is possible to build distributed applications that access the Minima blockchain.
+Minima.js makes it possible to access the Minima blockchain and build fully-featured distributed applications that take advantage of Minima's endless possibilities.
 
 Contents
 ========
@@ -27,3 +27,9 @@ Contents
    :caption: API:
 
    api/api.rst
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Typescript:
+
+   typescript/typescript.rst
diff --git a/docs/typescript/interfaces/address.rst b/docs/typescript/interfaces/address.rst
@@ -0,0 +1,5 @@
+#######
+Address
+#######
+
+.. _interfacesAddress:
diff --git a/docs/typescript/interfaces/burnTransaction.rst b/docs/typescript/interfaces/burnTransaction.rst
@@ -0,0 +1,5 @@
+###############
+BurnTransaction
+###############
+
+.. _interfacesBurnTransaction:
diff --git a/docs/typescript/interfaces/burnWitness.rst b/docs/typescript/interfaces/burnWitness.rst
@@ -0,0 +1,5 @@
+###########
+BurnWitness
+###########
+
+.. _interfacesBurnWitness:
diff --git a/docs/typescript/interfaces/coin.rst b/docs/typescript/interfaces/coin.rst
@@ -0,0 +1,5 @@
+####
+Coin
+####
+
+.. _interfacesCoin:
diff --git a/docs/typescript/interfaces/history.rst b/docs/typescript/interfaces/history.rst
@@ -0,0 +1,5 @@
+#######
+History
+#######
+
+.. _interfacesHistory:
diff --git a/docs/typescript/interfaces/listen.rst b/docs/typescript/interfaces/listen.rst
@@ -0,0 +1,5 @@
+######
+Listen
+######
+
+.. _interfacesListen:
diff --git a/docs/typescript/interfaces/magic.rst b/docs/typescript/interfaces/magic.rst
@@ -0,0 +1,5 @@
+#####
+Magic
+#####
+
+.. _interfacesMagic:
diff --git a/docs/typescript/interfaces/mmrProof.rst b/docs/typescript/interfaces/mmrProof.rst
@@ -0,0 +1,5 @@
+########
+MMRProof
+########
+
+.. _interfacesMMRProof:
diff --git a/docs/typescript/interfaces/proof.rst b/docs/typescript/interfaces/proof.rst
@@ -0,0 +1,5 @@
+#####
+Proof
+#####
+
+.. _interfacesProof:
diff --git a/docs/typescript/interfaces/response.rst b/docs/typescript/interfaces/response.rst
@@ -0,0 +1,5 @@
+########
+Response
+########
+
+.. _interfacesResponse:
diff --git a/docs/typescript/interfaces/script.rst b/docs/typescript/interfaces/script.rst
@@ -0,0 +1,5 @@
+######
+Script
+######
+
+.. _interfacesScript:
diff --git a/docs/typescript/interfaces/signatureWitness.rst b/docs/typescript/interfaces/signatureWitness.rst
@@ -0,0 +1,5 @@
+################
+SignatureWitness
+################
+
+.. _interfacesSignatureWitness:
diff --git a/docs/typescript/interfaces/signatureWitnessProof.rst b/docs/typescript/interfaces/signatureWitnessProof.rst
@@ -0,0 +1,5 @@
+#####################
+SignatureWitnessProof
+#####################
+
+.. _interfacesSignatureWitnessProof:
diff --git a/docs/typescript/interfaces/state.rst b/docs/typescript/interfaces/state.rst
@@ -0,0 +1,5 @@
+#####
+State
+#####
+
+.. _interfacesState:
diff --git a/docs/typescript/interfaces/status.rst b/docs/typescript/interfaces/status.rst
@@ -0,0 +1,5 @@
+######
+Status
+######
+
+.. _interfacesStatus:
diff --git a/docs/typescript/interfaces/superParents.rst b/docs/typescript/interfaces/superParents.rst
@@ -0,0 +1,5 @@
+############
+SuperParents
+############
+
+.. _interfacesSuperParents:
diff --git a/docs/typescript/interfaces/token.rst b/docs/typescript/interfaces/token.rst
@@ -0,0 +1,5 @@
+#####
+Token
+#####
+
+.. _interfacesToken:
diff --git a/docs/typescript/interfaces/tokenGen.rst b/docs/typescript/interfaces/tokenGen.rst
@@ -0,0 +1,5 @@
+########
+TokenGen
+########
+
+.. _interfacesTokenGen:
diff --git a/docs/typescript/interfaces/transaction.rst b/docs/typescript/interfaces/transaction.rst
@@ -0,0 +1,5 @@
+###########
+Transaction
+###########
+
+.. _interfacesTransaction:
diff --git a/docs/typescript/interfaces/transactionBody.rst b/docs/typescript/interfaces/transactionBody.rst
@@ -0,0 +1,5 @@
+###############
+TransactionBody
+###############
+
+.. _interfacesTransactionBody:
diff --git a/docs/typescript/interfaces/transactionHeader.rst b/docs/typescript/interfaces/transactionHeader.rst
@@ -0,0 +1,5 @@
+#################
+TransactionHeader
+#################
+
+.. _interfacesTransactionHeader:
diff --git a/docs/typescript/interfaces/transactionInput.rst b/docs/typescript/interfaces/transactionInput.rst
@@ -0,0 +1,5 @@
+################
+TransactionInput
+################
+
+.. _interfacesTransactionInput:
diff --git a/docs/typescript/interfaces/transactionOutput.rst b/docs/typescript/interfaces/transactionOutput.rst
@@ -0,0 +1,5 @@
+#################
+TransactionOutput
+#################
+
+.. _interfacesTransactionOutput:
diff --git a/docs/typescript/interfaces/txPow.rst b/docs/typescript/interfaces/txPow.rst
@@ -0,0 +1,5 @@
+#####
+TxPow
+#####
+
+.. _interfacesTxPow:
diff --git a/docs/typescript/interfaces/value.rst b/docs/typescript/interfaces/value.rst
@@ -0,0 +1,5 @@
+#####
+Value
+#####
+
+.. _interfacesValue:
diff --git a/docs/typescript/interfaces/witness.rst b/docs/typescript/interfaces/witness.rst
@@ -0,0 +1,5 @@
+#######
+Witness
+#######
+
+.. _interfacesWitness:
diff --git a/docs/typescript/types/callback.rst b/docs/typescript/types/callback.rst
@@ -0,0 +1,5 @@
+########
+Callback
+########
+
+.. _typesCallback:
diff --git a/docs/typescript/typescript.rst b/docs/typescript/typescript.rst
@@ -0,0 +1,42 @@
+#############################
+Minima Typescript Definitions
+#############################
+
+The Minima API uses Typescript to describe its interface.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Interfaces:
+
+   interfaces/mmrProof.rst
+   interfaces/burnTransaction.rst
+   interfaces/script.rst
+   interfaces/coin.rst
+   interfaces/transactionInput.rst
+   interfaces/listen.rst
+   interfaces/proof.rst
+   interfaces/status.rst
+   interfaces/address.rst
+   interfaces/signatureWitness.rst
+   interfaces/magic.rst
+   interfaces/transaction.rst
+   interfaces/response.rst
+   interfaces/burnWitness.rst
+   interfaces/transactionOutput.rst
+   interfaces/superParents.rst
+   interfaces/token.rst
+   interfaces/state.rst
+   interfaces/value.rst
+   interfaces/tokenGen.rst
+   interfaces/history.rst
+   interfaces/transactionHeader.rst
+   interfaces/transactionBody.rst
+   interfaces/txPow.rst
+   interfaces/signatureWitnessProof.rst
+   interfaces/witness.rst
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Types:
+
+   types/callback.rst