@keetanetwork/keetanet-client 0.14.2 → 0.14.3

package/README.md

@@ -5,3 +5,7 @@ This package implements KeetaNet Client SDK in JavaScript
 
 See the [Getting Started](docs/GETTING-STARTED.md) Guide for more
 information on first steps with the KeetaNet SDK.
+
+## Documentation
+
+See the full documentation for the KeetaNet Client JavaScript/TypeScript SDK at [https://static.test.keeta.com/docs/](https://static.test.keeta.com/docs/).

package/api/node.d.ts

@@ -28,6 +28,7 @@ interface GetAccountChainAPIResponse {
 interface AccountState {
     account: GenericAccount;
     currentHeadBlock: BlockHash | null;
+    currentHeadBlockHeight: bigint | null;
     representative: Account | null;
     balances: GetAllBalancesResponse;
     info: AccountInfo;

package/client/index-browser.d.ts

@@ -42,6 +42,11 @@ type GetAccountStateAPIResponseFormatted = {
      * this will be null if the account is not open
      */
     currentHeadBlock: string | null;
+    /**
+     * The current height of the head block for the account, if there is one
+     * this will be null if the account is not open
+     */
+    currentHeadBlockHeight: string | null;
     /**
      * The current representative for the account, if there is one
      * this will be null if the account is not open or if the

package/client/index-browser.js

@@ -117272,10 +117272,36 @@ class client_LedgerStorageBase {
     }));
     return Object.fromEntries(response);
   }
+  async getAccountsBlockHeightInfo(transaction, toFetch) {
+    const response = await Promise.all(toFetch.map(async _ref2 => {
+      let {
+        blockHash,
+        account
+      } = _ref2;
+      if (blockHash === undefined) {
+        const block = await this.getHeadBlock(transaction, account, 'main');
+        if (block !== null) {
+          blockHash = block.hash;
+        }
+      }
+      const retval = [];
+      if (blockHash === undefined) {
+        retval.push(...[account.publicKeyString.get(), null]);
+      } else {
+        const height = await this.getBlockHeight(transaction, blockHash, account);
+        retval.push(...[account.publicKeyString.get(), {
+          blockHash,
+          height
+        }]);
+      }
+      return retval;
+    }));
+    return Object.fromEntries(response);
+  }
   async getHeadBlockHashes(transaction, accounts) {
     const received = await this.getHeadBlocks(transaction, accounts.toArray(), 'both');
-    return Object.fromEntries(Object.entries(received).map(function (_ref2) {
-      let [account, value] = _ref2;
+    return Object.fromEntries(Object.entries(received).map(function (_ref3) {
+      let [account, value] = _ref3;
       if (value) {
         return [account, value.hash];
       } else {
@@ -125948,6 +125974,11 @@ class client_LedgerAtomicInterface {
     const retval = await client_ledger_classPrivateFieldGet(client_ledger_storage, this).getBlock(transaction, blockhash, from);
     return retval;
   }
+  async getAccountsBlockHeightInfo(toFetch) {
+    const transaction = client_ledger_assertClassBrand(client_LedgerAtomicInterface_brand, this, client_assertTransaction).call(this);
+    const retval = await client_ledger_classPrivateFieldGet(client_ledger_storage, this).getAccountsBlockHeightInfo(transaction, toFetch);
+    return retval;
+  }
   async getVoteStaple(stapleBlockHash) {
     let from = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'main';
     client_ledger_assertClassBrand(client_LedgerAtomicInterface_brand, this, client_assertTransaction).call(this);
@@ -126853,57 +126884,65 @@ class src_client_Ledger {
       return await transaction.getBlock(...args);
     });
   }
-  async getVoteStaple() {
+  async getAccountsBlockHeightInfo() {
     for (var _len19 = arguments.length, args = new Array(_len19), _key19 = 0; _key19 < _len19; _key19++) {
       args[_key19] = arguments[_key19];
     }
+    return await this.runReadOnly('db-getAccountsBlockHeightInfo', async function (transaction) {
+      return await transaction.getAccountsBlockHeightInfo(...args);
+    });
+  }
+  async getVoteStaple() {
+    for (var _len20 = arguments.length, args = new Array(_len20), _key20 = 0; _key20 < _len20; _key20++) {
+      args[_key20] = arguments[_key20];
+    }
     return await this.runReadOnly('db-getVoteStaple', async function (transaction) {
       return await transaction.getVoteStaple(...args);
     });
   }
   async getVoteStaples() {
-    for (var _len20 = arguments.length, args = new Array(_len20), _key20 = 0; _key20 < _len20; _key20++) {
-      args[_key20] = arguments[_key20];
+    for (var _len21 = arguments.length, args = new Array(_len21), _key21 = 0; _key21 < _len21; _key21++) {
+      args[_key21] = arguments[_key21];
     }
     return await this.runReadOnly('db-getVoteStaples', async function (transaction) {
       return await transaction.getVoteStaples(...args);
     });
   }
   async getHistory() {
-    for (var _len21 = arguments.length, args = new Array(_len21), _key21 = 0; _key21 < _len21; _key21++) {
-      args[_key21] = arguments[_key21];
+    for (var _len22 = arguments.length, args = new Array(_len22), _key22 = 0; _key22 < _len22; _key22++) {
+      args[_key22] = arguments[_key22];
     }
     return await this.runReadOnly('db-getHistory', async function (transaction) {
       return await transaction.getHistory(...args);
     });
   }
   async getStaplesFromBlockHashes() {
-    for (var _len22 = arguments.length, args = new Array(_len22), _key22 = 0; _key22 < _len22; _key22++) {
-      args[_key22] = arguments[_key22];
+    for (var _len23 = arguments.length, args = new Array(_len23), _key23 = 0; _key23 < _len23; _key23++) {
+      args[_key23] = arguments[_key23];
     }
     return await this.runReadOnly('db-getStaplesFromBlockHashes', async function (transaction) {
       return await transaction.getStaplesFromBlockHashes(...args);
     });
   }
   async getVoteStaplesAfter() {
-    for (var _len23 = arguments.length, args = new Array(_len23), _key23 = 0; _key23 < _len23; _key23++) {
-      args[_key23] = arguments[_key23];
+    for (var _len24 = arguments.length, args = new Array(_len24), _key24 = 0; _key24 < _len24; _key24++) {
+      args[_key24] = arguments[_key24];
     }
     return await this.runReadOnly('db-getVoteStaplesAfter', async function (transaction) {
       return await transaction.getVoteStaplesAfter(...args);
     });
   }
   async gc() {
-    for (var _len24 = arguments.length, args = new Array(_len24), _key24 = 0; _key24 < _len24; _key24++) {
-      args[_key24] = arguments[_key24];
+    for (var _len25 = arguments.length, args = new Array(_len25), _key25 = 0; _key25 < _len25; _key25++) {
+      args[_key25] = arguments[_key25];
     }
     return await this.run('db-gc', async function (transaction) {
       return await transaction.gc(...args);
     });
   }
   async getFee() {
-    for (var _len25 = arguments.length, args = new Array(_len25), _key25 = 0; _key25 < _len25; _key25++) {
-      args[_key25] = arguments[_key25];
+    for (var _len26 = arguments.length, args = new Array(_len26), _key26 = 0; _key26 < _len26; _key26++) {
+      args[_key26] = arguments[_key26];
     }
     return await this.runReadOnly('db-getFee', async function (transaction) {
       return await transaction.getFee(...args);
@@ -126935,7 +126974,7 @@ client_lib_ledger_defineProperty(src_client_Ledger, "isInstance", client_checkab
 // EXTERNAL MODULE: ws (ignored)
 var client_ws_ignored_ = __webpack_require__(4708);
 ;// ./src/version.ts
-const client_version = '0.14.2+g68f40cc8d6fed6135fa06451bd1fb0691868e25f';
+const client_version = '0.14.3+gc0f4c96265aa999e6f32e3b21443d294bbf33806';
 /* harmony default export */ const client_src_version = ((/* unused pure expression or super */ null && (client_version)));
 ;// ./src/lib/p2p.ts
 /* provided dependency */ var client_p2p_Buffer = __webpack_require__(8287)["Buffer"];
@@ -132076,6 +132115,7 @@ function client_parseAccountInfo(account, accountInfo) {
   return {
     account: client_src_lib.Account.fromPublicKeyString(accountInfo.account),
     currentHeadBlock: currentHeadBlock,
+    currentHeadBlockHeight: accountInfo.currentHeadBlockHeight,
     representative: currentRepresentative,
     info: client_client_assertClassBrand(client_Client_brand, this, client_formatAccountInfo).call(this, accountInfo.info),
     balances: client_client_assertClassBrand(client_Client_brand, this, client_formatAllBalances).call(this, accountInfo.balances)

package/client/index.d.ts

@@ -42,6 +42,11 @@ type GetAccountStateAPIResponseFormatted = {
      * this will be null if the account is not open
      */
     currentHeadBlock: string | null;
+    /**
+     * The current height of the head block for the account, if there is one
+     * this will be null if the account is not open
+     */
+    currentHeadBlockHeight: string | null;
     /**
      * The current representative for the account, if there is one
      * this will be null if the account is not open or if the

package/client/index.js

@@ -59579,6 +59579,7 @@ async function _Client_apiRaw(rep, api, method, options = {}) {
     return ({
         account: lib_1.default.Account.fromPublicKeyString(accountInfo.account),
         currentHeadBlock: currentHeadBlock,
+        currentHeadBlockHeight: accountInfo.currentHeadBlockHeight,
         representative: currentRepresentative,
         info: __classPrivateFieldGet(this, _Client_instances, "m", _Client_formatAccountInfo).call(this, accountInfo.info),
         balances: __classPrivateFieldGet(this, _Client_instances, "m", _Client_formatAllBalances).call(this, accountInfo.balances)
@@ -66097,6 +66098,26 @@ class LedgerStorageBase {
         }));
         return (Object.fromEntries(response));
     }
+    async getAccountsBlockHeightInfo(transaction, toFetch) {
+        const response = await Promise.all(toFetch.map(async ({ blockHash, account }) => {
+            if (blockHash === undefined) {
+                const block = await this.getHeadBlock(transaction, account, 'main');
+                if (block !== null) {
+                    blockHash = block.hash;
+                }
+            }
+            const retval = [];
+            if (blockHash === undefined) {
+                retval.push(...[account.publicKeyString.get(), null]);
+            }
+            else {
+                const height = await this.getBlockHeight(transaction, blockHash, account);
+                retval.push(...[account.publicKeyString.get(), { blockHash, height }]);
+            }
+            return (retval);
+        }));
+        return (Object.fromEntries(response));
+    }
     async getHeadBlockHashes(transaction, accounts) {
         const received = await this.getHeadBlocks(transaction, accounts.toArray(), 'both');
         return (Object.fromEntries(Object.entries(received).map(function ([account, value]) {
@@ -67596,6 +67617,11 @@ class LedgerAtomicInterface {
         const retval = await __classPrivateFieldGet(this, _LedgerAtomicInterface_storage, "f").getBlock(transaction, blockhash, from);
         return (retval);
     }
+    async getAccountsBlockHeightInfo(toFetch) {
+        const transaction = __classPrivateFieldGet(this, _LedgerAtomicInterface_instances, "m", _LedgerAtomicInterface_assertTransaction).call(this);
+        const retval = await __classPrivateFieldGet(this, _LedgerAtomicInterface_storage, "f").getAccountsBlockHeightInfo(transaction, toFetch);
+        return (retval);
+    }
     async getVoteStaple(stapleBlockHash, from = 'main') {
         __classPrivateFieldGet(this, _LedgerAtomicInterface_instances, "m", _LedgerAtomicInterface_assertTransaction).call(this);
         const results = await this.getVoteStaples([stapleBlockHash], from);
@@ -68365,6 +68391,11 @@ class Ledger {
             return (await transaction.getBlock(...args));
         }));
     }
+    async getAccountsBlockHeightInfo(...args) {
+        return (await this.runReadOnly('db-getAccountsBlockHeightInfo', async function (transaction) {
+            return (await transaction.getAccountsBlockHeightInfo(...args));
+        }));
+    }
     async getVoteStaple(...args) {
         return (await this.runReadOnly('db-getVoteStaple', async function (transaction) {
             return (await transaction.getVoteStaple(...args));
@@ -77415,7 +77446,7 @@ exports.Testing = { findRDN, blockHashesFromVote, feeFromVote };
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.version = void 0;
-exports.version = '0.14.2+g68f40cc8d6fed6135fa06451bd1fb0691868e25f';
+exports.version = '0.14.3+gc0f4c96265aa999e6f32e3b21443d294bbf33806';
 exports["default"] = exports.version;
 
 

package/docs/GETTING-STARTED.md

@@ -0,0 +1,361 @@
+---
+Title: Getting Started
+Category: Guides
+---
+
+# KeetaNet Client SDK Getting Started
+
+## Documentation
+
+See the full documentation for the KeetaNet Client JavaScript/TypeScript SDK at [https://static.test.keeta.com/docs/](https://static.test.keeta.com/docs/).
+
+## Installation
+
+The KeetaNet Client JavaScript/TypeScript SDK can be loaded with:
+```bash
+$ npm install @keetanetwork/keetanet-client
+```
+
+## Concepts
+### Accounts
+
+{@link KeetaNetSDK.Referenced.Account | Accounts} in the KeetaNet SDK are the way in which key pairs or identifiers are
+represented.
+
+For key pairs, they securely store the private key (where applicable) and
+provide operations like {@link KeetaNetSDK.Referenced.Account#sign | digital signing} and {@link KeetaNetSDK.Referenced.Account#verify | verification},
+{@link KeetaNetSDK.Referenced.Account.fromSeed | key derivation from seed} and {@link KeetaNetSDK.Referenced.Account.seedFromPassphrase | passphrase}, and
+{@link KeetaNetSDK.Referenced.Account#encrypt | encryption} and {@link KeetaNetSDK.Referenced.Account#decrypt | decryption} using ECIES.
+
+For identifiers, they are used to represent the identity of a specific kind of
+address, such as a Token, the Network Address, or a Storage account.
+
+Additionally, for key pair accounts the key may be held internally or
+externally using an external key provider.  No particular external key provider
+interface (e.g. PKCS#11) is specified but users may implement their own
+provider using the {@link KeetaNetSDK.Referenced.ExternalKeyPair | ExternalKeyPair} interface.
+
+### Blocks
+
+{@link KeetaNetSDK.Referenced.Block | Blocks} are used within KeetaNet to represent a collection of operations
+(transactions) by an account.  They contain the {@link KeetaNetSDK.Referenced.Block#account | account identifier}, the
+{@link KeetaNetSDK.Referenced.Block#network | network identifier}, the {@link KeetaNetSDK.Referenced.Block#previous | previous block identifier}, an optional
+{@link KeetaNetSDK.Referenced.Block#signer | signer} (if different from the account), a {@link KeetaNetSDK.Referenced.Block#date | timestamp}, and a list of
+{@link KeetaNetSDK.Referenced.Block#operations | operations}.
+
+The block is digitally signed by the signer (if present, otherwise the account)
+and the signature is included in the block.  The block is identified by its
+{@link KeetaNetSDK.Referenced.Block#hash | hash} which is the hash of the block
+not including the signature.
+
+The KeetaNet SDK also provides a block builder method which allows the user to
+create blocks in an incremental fashion.  The block builder is created using the
+{@link KeetaNetSDK.Referenced.BlockBuilder | BlockBuilder} class, however in
+most cases a {@link KeetaNetSDK.Referenced.UserClientBuilder | UserClientBuilder}
+from a {@link KeetaNetSDK.UserClient#initBuilder | UserClient} should be used
+because it will handle things like getting the correct network and previous
+block hash.
+
+### Operations
+
+{@link KeetaNetSDK.Referenced.BlockOperation | Operations} describe the actions performed by an account on the ledger.  They
+are fundamentally composed of effects, which are the specific changes or
+constraints performed on the ledger.
+
+An example operation is a {@link KeetaNetSDK.Referenced.BlockOperationSEND | Send}
+operation which has the effects of decrementing the balance of the sender,
+incrementing the balance of the receiver, and validating that the sender's
+balance does not drop below zero.
+
+The KeetaNet SDK provides {@link KeetaNetSDK.Referenced.BlockOperation | a number of operations}
+which are used to perform actions on the ledger.
+
+### Votes
+
+{@link KeetaNetSDK.Referenced.Vote | Votes} in KeetaNet are used for consensus forming among "representatives".
+Each vote is an assertion by a representative that a specific group of blocks
+(identified by their hashes) are valid and conform to the rules of the
+ledger of that representative.
+
+Votes are used to form a consensus on the state of the ledger and are
+aggregated by the representatives to form a "vote staple".  A vote staple is
+a collection of votes and the blocks which are referenced by those vote.
+
+Votes come in two flavors: temporary and permanent.  Temporary votes are
+used to get initial consensus on a set of blocks.  A quorum of temporary votes
+can be "traded in" for permanent votes.
+
+When a temporary vote is issued by a representative the vote and block are
+stored on the representative's "side ledger", which is a non-synchronized
+portion of the ledger.  The client can request a copy of the block from the
+representative {@link KeetaNetSDK.Client#getPendingBlock | Client.getPendingBlock}
+or {@link KeetaNetSDK.UserClient#pendingBlock | UserClient.pendingBlock} method,
+or the {@link KeetaNetSDK.Client#getVoteStaple | Client.getVoteStaple} method to
+with the "`side`" parameter set to `side` to retrieve the vote staple from the
+representative's side ledger.
+
+Additionally, the {@link KeetaNetSDK.UserClient#recover | UserClient.recover} method
+can be used to query all known representatives for side ledger vote staples
+to complete any partially completed consensus rounds.
+
+### Vote Staples
+
+{@link KeetaNetSDK.Referenced.VoteStaple | Vote Staples}, as discussed above, are a
+collection of votes and the blocks.  Every vote in a vote staple must be for the same
+set of blocks in the same order.
+
+Vote Staples are the unit of transaction in the KeetaNet network.  The set of
+blocks in a vote staple are applied altogether as a single atomic transaction
+acting on the ledger.
+
+### Networks
+
+{@link KeetaNetSDK.Referenced.src/config.networksArray | Networks} in KeetaNet
+a group of representative nodes and clients which all agree to a common set of
+rules and initial ledger state.  There can be many different networks, such as
+the "test" network, "main" network, and "dev" network.  Each network has its
+own set of representatives and clients.
+
+The network is identified within each block by the {@link KeetaNetSDK.Referenced.Block#network | network identifier}
+property, which is an integer.
+
+Each network also has a {@link KeetaNetSDK.UserClient.networkAddress | Network Address},
+which is a special kind of account derived from the network identifier.  The
+purpose of the network address is to define permissions which apply to the
+network as a whole, such as the permission to create tokens, or create storage
+accounts.
+
+### Tokens
+
+{@link KeetaNetSDK.Referenced.AccountKeyAlgorithm.TOKEN | Tokens} in KeetaNet are a
+special kind of account which is used to represent a fungible asset.  Tokens can be
+created using the {@link KeetaNetSDK.Referenced.BlockOperationCREATE_IDENTIFIER | Create Identifier}
+method though the {@link KeetaNetSDK.Referenced.UserClientBuilder#generateIdentifier | UserClientBuilder.generateIdentifier}
+method is recommended.
+
+Each network also has a base token which is used for consensus and other
+management functions.  The base token can be thought of as the native currency
+of the network and is derived from the network identifier.
+
+### Ledger
+
+The ledger within KeetaNet refers to a couple of different things:
+
+- The live state of accounts and their balances of tokens, as well as other attributes
+- The record of how that state came to be, represented by vote staples
+
+#### The ledger state
+
+The ledger state is the current state of all accounts and their balances of tokens,
+it can be thought of like this:
+
+| Account | Base Token | Token 1 | Token 2 | Token 3
+| ------- | ---------- | ------- | ------- | -------
+| kta1    |          1 | 100     | 200     | 300
+| kta2    |          5 |         | 0       | 3
+| kta3    |            | 90      |         |
+
+Where `kta1`, `kta2`, and `kta3` are the account identifiers, and the columns
+represent the balance of that account for the base token and other tokens.
+
+#### The ledger history
+
+The ledger history is the record of how the ledger state came to be.  It is
+represented by the set of vote staples which have been applied to the ledger.
+
+This is expressed in two different ways in the KeetaNet SDK
+
+- The {@link KeetaNetSDK.UserClient#history | UserClient.history} method which returns a list of
+  {@link KeetaNetSDK.Referenced.VoteStaple | vote staples} which have affected
+  the given account.
+- The {@link KeetaNetSDK.UserClient#chain | UserClient.chain} method which returns a list of
+  {@link KeetaNetSDK.Referenced.Block | blocks} which have been applied for a given
+  account.
+
+These two differ in that the history method returns all vote staples which
+affected an account, even if they were not issued by the account -- for
+example if a transfer was made to the account, the history method would return
+the vote staple which included the transfer, but the chain method would not
+because it was not issued by the account.
+
+Additionally there is a method to {@link KeetaNetSDK.UserClient.filterStapleOperations | filter a list of vote staples}
+to a list of operations which are relevant to a specific account.  This is useful
+because the list of operations in a vote staple may include changes that are uninteresting
+from an account perspective.
+
+### Permissions
+
+{@link KeetaNetSDK.Referenced.Permissions | Permissions} in KeetaNet are used
+to allow users and operators to manage access to resources on the network.
+They are used to control who can create tokens, create storage accounts, as well
+as delegate permissions to other accounts.
+
+There are two kinds of permissions:
+
+- {@link KeetaNetSDK.Referenced.BaseSet | Base} permissions are the permissions which are
+  defined by the network.  These are the permissions which the network representatives
+  will look at to grant or deny access
+- {@link KeetaNetSDK.Referenced.ExternalSet | External} permissions are the permissions which
+  applications can define.  These are the permissions which are defined by the
+  users of KeetaNet and the network representatives will not process them.
+  These are useful for applications which want to define their own permissions and in
+  the future may be used with Smart Contracts.
+
+Additionally, permissions may be applied to a specific account or set as
+default permissions on some the following resources:
+
+- Network Account: `ACCESS`, `STORAGE_CREATE`, `TOKEN_ADMIN_CREATE`
+- Token Accounts: `ACCESS`
+- Storage Accounts: `ACCESS`, `STORAGE_CAN_HOLD`, `STORAGE_DEPOSIT`
+
+Setting default permissions is done with the {@link KeetaNetSDK.UserClient#setInfo | UserClient.setInfo}
+method.  Setting permission on an account are set with the
+{@link KeetaNetSDK.UserClient#updatePermissions | UserClient.updatePermissions} method.
+
+#### Base Permissions
+
+The base permissions are defined by the network and are used to control access
+to the network.  Each base permission has a {@link KeetaNetSDK.Referenced.BaseFlag | flag name}
+which can be used to identify the permission.  The base permissions are:
+
+- `ACCESS` - The permission to access the resource it is granted on -- if this
+  permission is missing then no access to the resource is granted, this is
+  useful as to create deny-list or permit-list resources.
+- `ADMIN` - The `ADMIN` permission allows the `principal` to perform all actions
+  on the resource, excluding deleting the resource and transferring ownership.
+  For example, administrators of Token resources can mint and burn tokens and
+  set the permissions of the token.
+- `OWNER` - The owner permission grants all the privileges of the `ADMIN`
+  permission but also the ability to delete the resource and transfer
+  ownership.  All resources have exactly 1 owner.
+- `UPDATE_INFO` - The update info permission allows the `principal` to update the
+  information of the resource.  See {@link KeetaNetSDK.UserClient#setInfo | UserClient.setInfo}
+  for more information on how to set the info.
+- `STORAGE_CREATE` - This permission on the network account allows the
+  specified account to create storage accounts.  As a default permission it
+  allows everyone to create storage accounts.
+- `TOKEN_ADMIN_CREATE` - This permission on the network account allows the
+  specified account to create token accounts.  As a default permission it
+  allows everyone to create token accounts.
+- `TOKEN_ADMIN_SUPPLY` - This permission on a token account allows the specified
+  specified account to mint and burn tokens.  This is useful for fungible tokens
+  where the supply can be changed.
+- `TOKEN_ADMIN_MODIFY_BALANCE` - This permission on a token account allows the
+  specified specified account to modify the balance of holders of this token's
+  balance.
+- `STORAGE_DEPOSIT` - This permission on a storage account allows the specified
+  specified account to deposit the specified tokens into the storage account.
+- `STORAGE_CAN_HOLD` - This permission on a storage account allows the specified
+  specified account to hold the specified token in the storage account.
+- `SEND_ON_BEHALF` - This permission of an account allows the specified principal
+  account to send the specified token on behalf of the account.  This is useful for
+  shared accounts where multiple accounts can send on behalf of the account.
+  To use this feature see the {@link KeetaNetSDK.Referenced.UserClientConfig#signer | signer} option
+  to specify a different signatory for the transaction from the specified
+  {@link KeetaNetSDK.Referenced.UserClientConfig#account | account}.
+- `PERMISSION_DELEGATE_ADD` - This permission grants a subset of the abilities
+  of the current account to some other account.  Must be used with
+  {@link KeetaNetSDK.Referenced.AdjustMethod.ADD | AdjustMethod.ADD}.
+- `PERMISSION_DELEGATE_REMOVE` - This permission revokes a subset of the abilities
+  that have been delegated.  Must be used with {@link KeetaNetSDK.Referenced.AdjustMethod.SUBTRACT | AdjustMethod.SUBTRACT}
+- `MANAGE_CERTIFICATE` - This permission allows the specified account to manage
+  the certificate of the account.  This is used to set the certificate of the
+  account, which is used to verify the identity of the account.
+
+### Clients
+
+{@link KeetaNetSDK.UserClient | Clients} in the KeetaNet SDK are the ways in
+which applications primarily interact with the KeetaNet network.  There are
+two different clients supported:
+
+- {@link KeetaNetSDK.UserClient | UserClient} is the main client which is used to
+  interact with the network.  It is used to send transactions, query the ledger,
+  and perform other operations through the {@link KeetaNetSDK.Referenced.UserClientBuilder | UserClientBuilder}.
+- {@link KeetaNetSDK.Client | Client} is a lower level client which is used to
+  by the {@link KeetaNetSDK.UserClient | UserClient} to interact with the
+  network.
+
+## Usage
+
+The KeetaNet SDK is designed to be used in a variety of environments, including
+NodeJS, the browser, and other JavaScript environments.  It has TypeScript
+type definitions.
+
+### NodeJS
+
+The KeetaNet SDK can be used in NodeJS by importing the package:
+
+```javascript
+import * as KeetaNet from '@keetanetwork/keetanet-client';
+```
+
+From there, the SDK can be used to create a {@link KeetaNetSDK.UserClient | UserClient} and
+interact with the KeetaNet network.  See the {@link KeetaNetSDK.UserClient | UserClient}
+documentation for more information on how to use the client.
+
+Many other functions needed to support usage of the SDK are also in the
+`@keetanetwork/keetanet-client` package, such as the {@link KeetaNetSDK.Referenced.Account | Account}
+class, which is used to represent key pairs and identifiers, and the
+{@link KeetaNetSDK.Referenced.Block | Block} class, which is used to represent
+blocks on the ledger -- these are all imported with the `KeetaNet` import
+and accessed with the {@link KeetaNetSDK.lib} namespace.
+
+### Browser
+
+The KeetaNet SDK can be used in the browser by including the script tag:
+
+```html
+<script src="https://static.test.keeta.com/keetanet-browser.js"></script>
+```
+
+The KeetaNet SDK can then be accessed using the `KeetaNet` global variable.
+
+## Examples
+### Basic usage (NodeJS)
+
+The {@link KeetaNetSDK.UserClient} is the main entry point to interact with
+the KeetaNet network. It is initialized with a network name and an account
+using the {@link KeetaNetSDK.UserClient.fromNetwork} constructor.
+
+```javascript
+import * as KeetaNet from '@keetanetwork/keetanet-client';
+
+const seed = KeetaNet.lib.Account.generateRandomSeed({ asString: true });
+const account = KeetaNet.lib.Account.fromSeed(seed, 0);
+const client = KeetaNet.UserClient.fromNetwork('test', account);
+
+async function main() {
+	console.debug(await client.chain());
+}
+
+main().then(function() {
+	process.exit(0);
+}, function(error) {
+	console.error(error);
+	process.exit(1);
+});
+```
+
+### Basic usage (Browser)
+
+The SDK can be loaded in the browser with a script tag:
+```html
+<html>
+	<head>
+		<script src="https://static.test.keeta.com/keetanet-browser.js"></script>
+	</head>
+	<body>
+		<script>
+			const seed = KeetaNet.lib.Account.generateRandomSeed({ asString: true });
+			const account = KeetaNet.lib.Account.fromSeed(seed, 0);
+			const client = KeetaNet.UserClient.fromNetwork('test', account);
+
+			client.chain().then(console.debug);
+		</script>
+	</body>
+</html>
+```
+
+### Full examples
+- [Basic Example](./examples/basic/index.js)
+- [Real World Assets with NFT](./examples/rwa-nft/index.js)

package/docs/assets/hierarchy.js

@@ -1 +1 @@
-window.hierarchyData = "eJy1m11T4zYUhv9LrlXqT9nZu5CYXRcIaZyls9NhMiYR4GKc1HZ2YHb479WxTbDkOJFk98abJejVo6+jo1fm1yDdbPJs8OVvbBsWcmzdQRib9JNVfHJt+GQj7OoaMrGJEbZtC+Gh4SLHdOnvmZZJf8XQaFn4ZGtD+q2mI2y5GjKwZSNzaAyRZRn2HRqk5CEmqzzaJLTOXwPdwC78m4QvZPBlcLvJSZCH25gM0OA5StaDLzqtaLBLY/rtKg6zjGS/XxKSh1OSB5PLszl5IClJVmR99ln47Cl/ialCUYAWzLP1b6D2W/mDdzTQsW5z9f65ow/FaouyArU62OBqVazwdF2GbtZbeB5vVs/fwuxJocJ9WYFaTc2s1TomaR49RKswJ4p1cwoiBJbG9XGXtjPlBWqn871W+/eMpOM4Ikl+sy3n/AeBYeMPgijJSfoQrtohGjKtIHst+PIpitdUga5tA9vmXYFnmwfxxpvkIXrsSleqCMBRFNNw6ih04eaZwvgU5U6Pi2kycWYUTPUbf6LW3ixdLePofrnLozhbhlmin1V6gi03HZ1jCUjeKwvVE2bBHMt5lAd5GiWKs6GFaK8qyuVqHNckrEXLPpBAUJjG4kes/y6S6h+6E9ej++6Bqgf5Jg0fVbYUlui+UDtjRE8sMTba0K0HwU6AIBgjy9QxsiCnsG3HQDbWDOQYOjxMmjAYWIfQBEnCobh9vkvWyulATUGmAZCVAJOlMVFjtsmy6D5+8163UUrWitv3ARUpNppDFGy0Vw9mTh02uk+B0xEV8jmu/qvomZyHmepgfRSX6g2axyEYpqJLbCaw7hOz8x39fZJ2ye0qCYFuofOcY+gwIIJDgRtpZbcmi7fWMU0+ybzZkjSELCXwphMFgKaICAezXfASi+Xcm/WAUugI0Lj6sV5ZLP3pxU0vOCAkwoNxK8/1zcS/+LGcefNrPwj8m2nQmawpKcA41J1WxvHcGy28pT/xpgv/wvfmnREbiiKEeNhKuLi59KbL0eTany6D77PZ1Y/OiE3J04y2prevg7pgNUTno6vRdOz1yspKizDb7bNz7o09/7Y7YKUjQKPrbvtaGU1HX73l2JvDpBnTGdR9rTQkBRhNl5mJdM+sHyAkUMqSAjVazK7mvdJUNAljtVprpUVqdt0DNV+St1kYqexvnIIAAU1a6wTjSTAKvPGMpvyX+mx3H0crqqVCclhJgIhm0C1E896I5nJEJkM0MWxbH3ZC4SREGPCRcUqjn/S418tA7aVEmIZa+0j1xTSXY3KYCPfR0Z1geA0RCqse9f01ScDnI6kaAVNepHZn2DpXgugxCfNdqnKOaVESIHI1p3Wm9EU0lyNiDORqjDuhcBKnGbDJ2PRXZP24dyQWaZhkYXGVoHjoPCYnwGYxZ47CiJyRZF23hSR9zKq4zAEYbFQ4+8LtDW9w3v9DVoq+4md5WasZnFYEFic8MAIjDx4WooRweWTqFS7vO3qvWxrqIzCRc/KaL0JFd+2wlpitBngclv/SH1ZTSxTLrg8uLZ7l6W5FJ64aS01AdngpyrAcQLseQf+K8ic/86lsmKwUbVpWQ7Bn2Hs8P4nyKIzLe4hgt93Gb2osB4REgZhMGULJV5J8nDo73LIcUpIePNpbxeBh1+Ygu5lGnIJMAAPTDoGDVYC5R86vnc9aUliOaSKwlRC4OQgsFAQeBQIbAME5G8HBFcF5sSRnxx0q/iO4mR52w+RG/qCW7NhDg0pQq2FOceKsXdaZ9bhr1orrahVuwx1o6DN+Wg+8R221NmA6TUpg2zgKfMRw64gu4bu1NgLjqhENF4Spqt2R69gGcWOurQl0kZZNYEzP612cRzTz/DwojFNCDyuj9HH3Qn+keDN/UlZw13CdRtxjuuWIv9ixwyVsxtYex2VK4DrHQ6CAAdljYwR9yJZGQYSvGtVwfZkqeYeyYwtOGZWtuHa1cN3j4fKIhdk1+og7mW2N+NhLh1o9C5+R9CXKMojNJP+2UUxRDqjI5APguSKwQUtAox4eL8mbX2uRLFm9uBSS5boID2li4tCOow9cJndDJvAV5/8OdmmtuAwcHg4pl2aXsZj+p9Vu6cjG65w+uANVq9XSD81cgkY/ZMd1wGAEROrHdpsRp4jQ0BCgMPR61rS3fflXWqRiFK8iHY/2r6uAv43AsrwrWJlL7wOUUmtf4QWbEoeemRAYzAgc3RodrgfPvdmmzshLSJE6Dg2bruYgsBMLPpM5fxzz4Dq9MykgLH18NvWqCU49gMyM2YyQ9CrKcjifK85VVkQsbXTYt+Qub+nWVrVt8bZVXDW8ijCKxaAUXkW06gGnqSQ7cNBPxcBZeuOdaCaH6SsXkp5ZrmkhOJnDAyM4Q8KDbu/0YAAP+JauJEjvqoY4nIHT88HmqKR883CFbWj8mSyLHrvYYqyGOhgTNLk74otdUv7FAhiBmzTPvGSVvm3VJ4y4vuDis7AjgD/d/F/gdWVBZJvN8cvwNydb5i5HJYRWGsIYwyZGZwZBAC5IOQ78+UxxPwJ/h8Mt8La+V1/fbYrS5HT1IJiDJTmzv09pxKDB+zaMd8RL8lTRj2/ISDNip8TDrC20WUcPb4vNM6GJQQz3Dh0gW8QEZyJmXjOZk393JMsLsTlZkehnF7I2NWG0+mQsVKoB6cDUkJEfUjj60m67e39//w+4gALt"
+window.hierarchyData = "eJy1m11z2jgUhv8L19qsPyW7dwSclk0CLNDsdHYyjANK4o1jWNt0mun0v6+OTYglY5Bk7w1lkujVo6+jc167P3vpZpNnvU9/YxdjRFzXRxgT9s2Bb8Qi8I0g7LkWsrFrIuz6GGGfGOwXFvs723PZN2yxtvDNhT/xHZv9nWUhCzsesn3HQY7jGPeol9LHmK7yaJOwPn/2TIsY8G8SvtLep97dJqfzPNzGtId6L1Gy7n0yLQ/1dmnMfruKwyyj2e/XlObhmObz4fXFjD7SlCYrur74aHzxnL/GTKFowBrm2fo3UPut/MEv1DOxSYR+/9yxD81ui7YSvRLsCL1qdni+L8u0qyO8jDerly9h9qzR4aGtRK+2gSu9DmiaR4/RKsypZt+CggyBYwtz3GbsXHuJ3tl+r/T+NaPpII5okk+25Z5/J7Bc/E4QJTlNH8NVM0RNphHkoAW/fI7iNVNgZ9tih/u+wHPxUbzBJnmMntrSlSoScAzFtrzqTLGDm2ca61O0O78utu1Vd0V/PjYno6HeeLN0tYyjh+Uuj+JsGWaJebHXkxy57WGBZU7zTlmYniyLbwosl1E+z9Mo0dwNDUQHVWkuV+AahpVo2QUSCErT+OKKdT9FSvPDbuJqdN89MvV5vknDJ50rhSd6KNQuONEzR4yPNuzqQXATIAjGyLFtEznY8ZHreh5ysekhYrkO+yAsYbANG0ITJAnH4vblLllrpwMVBZUBQFYCTI7BRY3pJsuih/gt+LGNUrrWvL6PqCixsRyiYGOzejRzanHRfQicj6iQzwn930Qv9DLMdBfrvbnSbLA8DsEyFVPicoH1kJhd7tjf07RNbreXkJgWts8FhhYLIrkUmIjJbLshy4+WcOlOcdwmW5qGkKXMg/FQA6AuIsPBXReixGI5C6YdoBQ6EjSedWpWFsvR+GrSCQ4IyfB4ZiPP7WQ4uvq2nAaz29F8PpqM563J6pISjL5tNTIOZkF/ESxHw2C8GF2NgllrxJqiDKHnNBIuJtfBeNkf3o7Gy/nX6fTmW2vEuuR5Rtewms9BVXC/RJf9m/54EHTKykvLMJPm3TkLBsHorj3gXkeCxrTt5rPSH/c/B8tBMINNM2A7qP1ZqUlKMDoGtxPZnVktIBRQypYyPXK3WvCDpaJJGOv1Wmkt0bPLjfW97TV9m4aRzv0mKMgQcIVqMBjO+/NgMGUp/7U53T3E0Ypp6ZAcV5IgYhl0A9GsM6KZGhGXBwRDy3VNvxWKICHDQE6sUxp9Z+VeJwt1kJJgIpwdJsxvV0wzRSbbObJWrWBEDRkKXL3vR2uagM9HUz0Crr1M71y+yC/wPHpKwnyX6tQxDUoSRJ5lN+6UrohmakScxbBf41YogsR5Bmy71crmhq6fDo7EIg2TLCweJWgWnafkJNhcq7qDCyNySpN11RZS9DH3zVUKYLBR7wsaLJqKk4d/6ErTV/xor2o1g9OKwOJE4C3ChwsfPmKEHvsg9h7XE3CDH1sW6iMwkXP6I1+Emu7acS05Ww3wBKzRa3dYdS1ZLJ97qrJJsjzdrdjG1WOpCKguL8aGWSwg+7eC9FeUP4+yEZMNk5WmTctrSM4M5gLEKInyKIzL5xDz3XYbv+mxHBGSBSJYyM0/0+S96mzxlOWYkvriuaRYPGIRAbKdaSQoqAQwMO0QOFgFmOc2uwCtay0lLOJ4CGwlBG4OAgsFgUeBwAZAUGcjKFwR1IslOb/u0PEf88n4uBumtvJHtVTXHgZUgno1i0AQ5+2y1qynXbNGXN/d49a8tJo+56d1wHvSVmsCZtukBPZrNhHXwQnDrSW6gu/WOAivjO6+YZwcRLMj13IM8sZc0xDYId0PobpxbndxHrHM86NQGKSUFSv99Gn3yn6k+WT+rKzkreGbtbjHTcsJf7HlhCvYjI0z7jnljJunQ6CEAdnhYCR9yIZBQYQvB2XV3EmuS9GhbDmCc0ZlIy7ZH9z6owc+RjRbmG2jj7yT2TSI97vU517hmdL0NcoyiM00/7LRTFGOqKjkA+C5IrBBS0DurbVr+jaqjEiVrNpcCcllSMQwPERMbCBiGUUOBT8RnYQWdmmluQocMWzGZfh+iWQ3W3Mt2USd84U7UDVaLd3QzBRo2NrVbZYWGJyARP9s2zQZcZoINQ0ZCreaNR1sX/GVFqUYJaoox6PD6yrgbyOwLIvdbBGXP/36L95IwB07+QUOJsBkYASO7gedbVSD58Fs02cUJZRIoYICbxOBnVjycfXHKQ+u1TuTEsLK5bNdls/EMasBZGpNp5SmN1GWQ32uuVd5Ebm0kTicBXl9x662/dgWb1vNUyOqSKNgDqXwKqJVBzh1JdWFg3kqF86tvRPN5TBd5ULKO8sjGEFlDh8eghoSQQ2GoDCAD3jj3oIX68siE17OFwycjgubk5LKw2O1WInNPfQpiqcsempji/Ea2mAuFzSFZ8RXu6T8HwtgBG7SPAuSVfq21d8w8vqSh881jj2eF+XHm/8LvKosi8zn+GX4m9Et9yxHJ4TuNWQxuIdce4nWDJIAQpAyfQTTUm7I2gFvmnv9892kqEzOTg+CPViSc/f7mEUMFrzvwnhHgyRPNf34mowyIzFLPMLbQpt19Pi22LxQlhjE8NyhBWSDmOROJGY1A57Rf3c0ywuxGV3R6HsbsiY1abTqZixU9gvSgqkmo76kUPqyabv/9evXf55aA4A="