0bsLink is an extension that allows users to securely interact with 0bsnetwork-enabled web services from the browser.

Seed phrases and private keys are encrypted and stored within the extension and cannot be accessed by online dApps and services, making sure that users' funds are always protected from hackers and malicious websites. Completion of a transaction doesn't require entering any sensitive information.

0bsLink is designed for convenience, so users can sign transactions with just a couple of clicks. Users can create multiple wallets and switch between them easily. And if a user ever forgets the password to the account, it can be recovered from the seed phrase.

This service is currently in beta and is not yet published to the chrome and firefox app store (Edge and Opera coming soon) However, you can still use the service to develop your application. The extensions are located here;

Chrome

FireFox

  • You can install the chrome extention manually as so;
  • Visit chrome://extensions/
  • Click 'Load Unpacked'
  • Select your folder
  • Setup 0bsLink - Remember to select TestNet if you need to!

On browser pages that operate under the http/https with 0bsLink extension installed, the 0bsLink global object becomes available, featuring the following methods:

  • auth
  • publicState
  • signAndPublishCancelOrder
  • signAndPublishOrder
  • signAndPublishTransaction
  • signCancelOrder
  • signOrder
  • signTransaction
  • signRequest
  • signTransactionPackage
  • on

All methods, except for "on" operate asynchronously and return promises.

In 0bsLink, for greater security and ease of use, each new website using API has to be allowed by the user. At the first attempt to use API (except "on"), the user will see a request to allow that website's access to 0bsLink. If the user agrees to allow access, the website is considered trusted and can use API on its pages. Otherwise, the website is blocked, and an error message will be displayed in response to all requests {message: "Api rejected by user", code: 12}. The users won't see new notifications. To grant access, the user will mark the website as trusted in the interface.

Description of methods

publicState

If a website is trusted, 0bsLink public data are returned.

Example:

    zbsLink.publicState()
        .then(state => {
            console.log(state); //displaying the result in the console
            /*...processing data */
        }).catch(error => {
            console.error(error); // displaying the result in the console
            /*...processing errors */
        })

or

    const getPublicState = async () => {
        try {
            const state = await zbsLink.publicState();
            console.log(state); // displaying the result in the console
            /*... processing data*/
        } catch(error) {
            console.error(error); // displaying the result in the console
            /*... processing errors */
        }
      }


      const result = await getPublicState();

REPLY

{
    "initialized": true,
    "locked": true,
    "account": {
        "name": "foo",
        "publicKey": "bar",
        "address": "address",
        "networkCode": "network byte",
        "balance": {
            "available": "balance in zbs",
            "leasedOut": "leased balance"
        }
    },
    "network": {
        "code": "T",
        "server": "https://nodes.testnet-0bsnetwork.com/",
        "matcher": "https://matcher.testnet-0bsnetwork.com/"
    },
    "messages": [],
    "txVersion": {
        "3": [ 2 ],
        "4": [ 2 ],
        "5": [ 2 ],
        ...
    }
}

Description of query return fields

  • initialized - boolean keeper initialized
  • locked - boolean keeper in wait mode
  • account – current account, if the user allowed access to the website, or null
  • network – current 0bsnetwork, node and matcher addresses
  • messages – signature request statuses
  • txVersion – available transaction versions for each type

Possible errors

  • { message: "Init 0bsLink and add account" } – 0bsLink is not initialized
  • { message: "Add 0bsLink account" } – 0bsLink accessed, but there are no accounts
  • { message: "User denied message" } – the user denied the website operation with 0bsLink

on

Allows subscribing to 0bsLink events.

Supports events:

  • update – subscribe to updates of the state

Example:

   zbsLink.on("update", state => {
        //state object as from zbsLink.publicState
   });

If a website is not trusted, events won't show.

auth

This is a method for obtaining a signature of authorization data while verifying 0bsnetwork user.

Example:

    const authData = { data: "Auth on my site" };
    zbsLink.auth(authData)
        .then(auth => {
            console.log(state); //displaying the result on the console
            /*...processing data */
        }).catch(error => {
            console.error(error); // displaying the result on the console
            /*...processing errors */
        })

or

    const getAuthData = async authData => {
        try {
            const state = await zbsLink.auth(authData);
            console.log(state); // displaying the result on the console
            /*... processing data */
        } catch(error) {
            console.error(error); // displaying the result on the console
            /*... processing errors */
        }
    }


    const authData = { data: "Auth on my site" };
    getAuthData(authData);

auth facilitates input of the following data

  • name – name of the service (optional field)
  • data – a line with any data (required field)
  • referrer – a websites' full URL for redirect (optional field)
  • icon – path to the logo relative to the referreror origin of the website (optional field)
  • successPath – relative path to the website's Auth API (optional field)

Example

    const authData = {
        data: "Generated string from server",
        name: "My test App",
        icon: "/img/icons/zbs_logo.svg",
        referrer: "https://client.testnet-0bsnetwork.com/",
        successPath: "login"
    };


    zbsLink.auth(authData).then((data) => {
        //data – data from 0bsLink
        //verifying signature and saving the address...
        console.log(data);
    }).catch((error) => {
        //processing the error
    });

If the verification is successful, 0bsLink will return in the promise an object containing data for signature verification:

  • host – a host that requested a signature
  • name – the name of an application that requested a signature
  • prefix – a prefix participating in the signature
  • address – an address in 0bsnetwork
  • publicKey – the user's public key
  • signature - signature
  • version – API version

ERRORS

  • {message: "Invalid data", data: "[{"field":"data","type":"string","message":"field is required"}]", code: 9} – signature data contain errors
  • {message: "User denied message", code: 10} – the user denied the request
  • {message: "Api rejected by user", code: 12} - the website is not trusted

signTransaction

A method for signing transactions in 0bsNetwork.

Example:

    const txData = {
        type: 4,
        data: {
            amount: {
               assetId: "ZBS",
               tokens: "1.567"
            },
            fee: {
                assetId: "ZBS",
                tokens: "0.001"
            },
            recipient: "test"
        }
    };
    zbsLink.signTransaction(txData).then((data) => {
        //data – a line ready for sending to 0bsNetwork's node (server)
    }).catch((error) => {
        //Processing errors
    });

API returns lines, not an object, as in javascript precision is lost in operation with 8-byte integers.

A description of supported transaction types is below.

In the example, we are signing a transaction for transferring ZBS to the alias testin 0bsnetwork.

REPLY {"version":2,"assetId":"", "amount":156700000,"feeAssetId":"",fee:100000, "recipient":"recipient","attachment":"", "timestamp":1548770230589,"senderPublicKey":"public key","proofs":["signature"],"type":4}

ERRORS

  • {message: "User denied message", code: 10} – The user denied the request.
  • {message: "Api rejected by user", code: 12} – The website is not trusted.
  • {message: "Invalid data", data: "Reason", code: 9} – invalid/incomplete request data.

signAndPublishTransaction

This is similar to "signTransaction", but it also broadcasts a transaction to the blockchain.

Example:

   const txData = {
           type: 4,
           data: {
               amount: {
                  assetId: "ZBS",
                  tokens: "1.567"
               },
               fee: {
                   assetId: "ZBS",
                   tokens: "0.001"
               },
               recipient: "test"
           }
       };
       zbsLink.signAndPublishTransaction(txData).then((data) => {
           //data - a line ready for sending to 0bsNetwork's node (server)
       }).catch((error) => {
           //processing errors
       });

REPLY A reply from 0bsNetwork returns as a line containing the entire past transaction.

ERRORS

  • Same as signTransaction
  • {message: "Filed request", data: "Error description", code: 15} – a request was signed but not broadcasted

signTransactionPackage

A package transaction signature. Sometimes several transactions need to be simultaneously signed, and for users' convenience, up to seven transactions at ones could be signed. Only certain types of transactions are permitted:

  • 3 – token issue
  • 4 – token transfer
  • 5 – token re-issue
  • 6 – token burning
  • 10 – creating an alias for an address in 0bsNetwork
  • 11 – mass transfer
  • 12 - DataTransaction

Example:

    const name = "For Test";
    const tx = [{
        type: 4,
        data: {
            amount: {
               assetId: "ZBS",
               tokens: "1.567"
            },
            fee: {
                assetId: "ZBS",
                tokens: "0.001"
            },
            recipient: "test"
    }},{
        type: 4,
        data: {
            amount: {
               assetId: "ZBS",
               tokens: "0.51"
            },
            fee: {
                assetId: "ZBS",
                tokens: "0.001"
            },
            recipient: "merry"
        }
    }];


    zbsLink.signTransactionPackage(tx, name)

Sign two transaction:

  • Transfer 1.567 ZBS to the alias test
  • Transfer 0.1 ZBS to the alias merry

REPLY

A unit of two lines – transactions that are signed and ready to be broadcasted.

ERRORS Same as in "signTransaction"

Every user of 0bsNetwork has a state (balances, assets, data, scripts), and every past transactions changes these data. \ In 0bsLink API it is different from NODE REST API.

signTransaction, signAndPublishTransaction accept transactions as follows

{
    type: number //transaction type,
    data: {
        ... //transaction data
    }
}

Legend keys

    • optional field, data are automatically supplied from zbsLink. \ [x,y] – length limit from x to y. \ [,x] – length limit to x. \ [y,] – length limit from y. \ [x-y] – number from x to y. x/y - x or y. (JLM) - JAVA LONG MAX = 9 223 372 036 854 775 807 \ MoneyLike - price

MoneyLike could look as:

  • { tokens: 1, assetId: "ZBS" }
  • { coins: 100000000, assetId: "ZBS" };

In both messages, the same price of 1 ZBS is indicated. You can easily convert coinsinto tokensand back, if you know in what asset the price is indicated and you have received its precision tokens = coins / (10 ** precision) \ If the field contains other types than MoneyLike, for instance, string/MoneyLike , the sum is indicated as a number in coins.

Type 3 ISSUE – token issue

  • name [4, 16] string – token name,
  • description [0, 1000] string – token description,
  • quantity [0 - (JLM)] number/string - quantity,
  • precision [0 - 8] number - precision,
  • reissuable true|false – reissuble,
  • fee MoneyLike -fee
  • *script string – asset script
  • *senderPublicKey string – sender's public key in base58
  • *timestamp number/string – time in ms

Example:

   zbsLink.signAndPublishTransaction({
        type: 3,
        data: {
             "name": "Best Token",
             "description": "Greate token",
             "quantity": 1000000,
             "precision": 2,
             "reissuable": true,
             fee: {
                 "tokens": "1",
                 "assetId": "ZBS"
             }
        }
   }).then((tx) => {
        console.log("Hurray! I've created my asset!!!");
   }).catch((error) => {
        console.error("Something went wrong", error);
   });

In case of a success, we are issuing a new asset in the quantity of 1,000,000, and your balance will show 10,000.00 Best Token

Тype 4 TRANSFER – asset transfer

  • amount MoneyLike - amount,
  • recipient string – recipient's address or alias
  • attachment[,140 bytes в base58] string – additional info
  • fee MoneyLike - fee
  • *senderPublicKey string – sender's public key in base58
  • *timestamp number/string – time in ms

Example:

    zbsLink.signAndPublishTransaction({
        type: 4,
        data: {
            amount: { tokens: "3.3333333", assetId: "ZBS" },
            fee: { tokens: "0.001", assetId: "ZBS"},
            recipient: "merry"
        }
    }).then((tx) => {
         console.log("Hurray! I've been able to send ZBS!!!");
    }).catch((error) => {
         console.error("Something went wrong", error);
    });

Тype 5 REISSUE – token reissue

  • assetId string - "asset ID",
  • quantity [0 - (JLM)] number/string/MoneyLike - quantity,
  • reissuable false – deny reissue
  • fee MoneyLike -fee
  • *senderPublicKey string – sender's public key in base58
  • *timestamp number/string – time in ms

Example:

      zbsLink.signAndPublishTransaction({
           type: 5,
           data: {
                "quantity": 1000,
                "assetId": "8LQW8f7P5d5PZM7GtZEBgaqRPGSzS3DfPuiXrURJ4AJS",
                "reissuable": true,
                fee: {
                    "tokens": "1",
                    "assetId": "ZBS"
                }
           }
      }).then((tx) => {
           console.log("Hurray! I've reissued my asset!!!");
      }).catch((error) => {
           console.error("Something went wrong", error);
      });

In case of a success, we are re-issuing a new asset in the quantity of 1,000,000, and your balance will show 10,000.00 Best Token

Тype 6 BURN – burning tokens

  • assetId string – asset ID,
  • amount [0 - (JLM)] number/string/MoneyLike - quantity,
  • fee MoneyLike -fee
  • *senderPublicKey string - sender's public key in base58
  • *timestamp number/string – time in ms

Example:

   zbsLink.signAndPublishTransaction({
        type: 6,
        data: {
             amount: 1000,
             assetId: "8LQW8f7P5d5PZM7GtZEBgaqRPGSzS3DfPuiXrURJ4AJS",
             fee: {
                 "tokens": "0.001",
                 "assetId": "ZBS"
             }
        }
   }).then((tx) => {
        console.log("Hurray! I've burned unneeded tokens!!!");
   }).catch((error) => {
        console.error("Something went wrong", error);
   });

In case of a success, 1,000 coins are burned.

Тype 8 LEASE - Leasing

  • recipient string – recipient's address or alias,
  • amount [0 - (JLM)] number/string/MoneyLike - quantity,
  • fee MoneyLike -fee
  • *senderPublicKey string - sender's public key in base58
  • *timestamp number/string – time in ms

Example:

   zbsLink.signAndPublishTransaction({
        type: 8,
        data: {
             "amount": 1000,
             "recipient": "merry",
             fee: {
                 "tokens": "0.001",
                 "assetId": "ZBS"
             }
        }
   }).then((tx) => {
        console.log("Hurray! I've been able to lease tokens!!!");
   }).catch((error) => {
        console.error("Something went wrong", error);
   });

In case of a success, 0.00001000 ZBS is leased.

Тype 9 LEASE CANCEL – cancel leasing

  • leaseId string – leasing transaction ID,
  • fee MoneyLike -fee
  • *senderPublicKey string - sender's public key in base58
  • *timestamp number/string – time in ms

Example:

   zbsLink.signAndPublishTransaction({
        type: 9,
        data: {
             leaseId: "6frvwF8uicAfyEfTfyC2sXqBJH7V5C8he5K4YH3BkNiS",
             fee: {
                 "tokens": "0.001",
                 "assetId": "ZBS"
             }
        }
   }).then((tx) => {
        console.log("Hurray! I've cancelled leasing!!!");
   }).catch((error) => {
        console.error("Something went wrong ", error);
   });

In case of a success, the leasing transaction is cancelled.

Тype 10 CREATE ALIAS – creating an alias for an address

  • alias[4, 30] string - alias
  • fee MoneyLike -fee
  • *senderPublicKey string - sender's public key in base58
  • *timestamp number/string – time in ms

Example:

   zbsLink.signAndPublishTransaction({
        type: 10,
        data: {
             alias: "testAlias",
             fee: {
                 "tokens": "0.001",
                 "assetId": "ZBS"
             }
        }
   }).then((tx) => {
        console.log("Hurray! Now I have an alias!!!");
   }).catch((error) => {
        console.error("Something went wrong", error);
   });

In case of a success, an alias (another name) is created.

Тype 11 MASS TRANSFER - a mass transfer of an asset

  • totalAmount moneyLike – total to be sent // instead of calculating the amount you may insert { assetId: "ID of the asset to be sent", coins: 0},
  • transfers a mass of objects
    • { recipient: string - address/alias, amount: number/string/moneyLike }
  • fee MoneyLike -fee
  • attachment [,140 bytes в base58] string – additional info
  • *senderPublicKey string - sender's public key in base58
  • *timestamp number/string – time in ms

Example:

   zbsLink.signAndPublishTransaction({
        type: 11,
        data: {
             totalAmount: { assetId: "ZBS", coins: 0},
             transfers: [
                { recipient: "alias1", amount: "200000" },
                { recipient: "alias2", amount: "200000" },
             ],
             fee: {
                 "tokens": "0.002",
                 "assetId": "ZBS"
             }
        }
   }).then((tx) => {
        console.log("Hurray! I've sent hi to my friends!!!");
   }).catch((error) => {
        console.error("Something went wrong", error);
   });

In case of a success, 0.002 ZBS will be sent to alias1 and alias2.

Тype 12 DATA TRANSACTION - saving data

  • data mass of objects
    • type "binary"/string/"integer"/"boolean" - type,
    • key string – field name
    • value /string/string/number/boolean depends on the type
  • fee MoneyLike - fee
  • *senderPublicKey string - sender's public key in base58
  • *timestamp number/string – time in ms

Field:

   zbsLink.signAndPublishTransaction({
        type: 12,
        data: {
             data: [
                  { key: "string", value: "testVal", type: "string" },
                  { key: "binary", value: "base64:AbCd", type: "binary" },
                  { key: "integer", value: 20, type: "integer" },
                  { key: "boolean", value: false, type: "boolean" },
             ],
             fee: {
                 "tokens": "0.01",
                 "assetId": "ZBS"
             }
        }
   }).then((tx) => {
        console.log("Hurray! I've saved data!!!");
   }).catch((error) => {
        console.error("Something went wrong", error);
   });

In case of a success, new data will be stored in the state.

Тype 13 SET SCRIPT – scrypting an account

  • script string - script
  • fee MoneyLike -fee
  • *senderPublicKey string - sender's public key in base58
  • *timestamp number/string – time in ms

For cancelling a script the field scripthas to be "". Script development on RIDE

Example:

   zbsLink.signAndPublishTransaction({
        type: 13,
        data: {
             script: "",
             fee: {
                 "tokens": "0.04",
                 "assetId": "ZBS"
             }
        }
   }).then((tx) => {
        console.log("Hurray! I've cancelled a script!!!");
   }).catch((error) => {
        console.error("Something went wrong", error);
   });

In case of a success, the script will be removed from the account.

Example 2:

   zbsLink.signAndPublishTransaction({
        type: 13,
        data: {
             script: "base64:AQa3b8tH",
             fee: {
                 "tokens": "0.01",
                 "assetId": "ZBS"
             }
        }
   }).then((tx) => {
        console.log("Hurray! I've added a script!!!");
   }).catch((error) => {
        console.error("Something went wrong", error);
   });

In case of a success, a new script will be added to the account, allowing any transactions without a signature (be careful!).

Тype 14 Sponsored Fee Transaction - Sponsorship

  • minSponsoredAssetFee MoneyLike – fee price in the asset.
  • fee MoneyLike - fee
  • *senderPublicKey string - sender's public key in base58
  • *timestamp number/string – time in ms

Example:

   zbsLink.signAndPublishTransaction({
        type: 14,
        data: {
             minSponsoredAssetFee: {
                assetId: "6frvwF8uicAfyEfTfyC2sXqBJH7V5C8he5K4YH3BkNiS",
                tokens: 0.1
             },
             fee: {
                 "tokens": "1",
                 "assetId": "ZBS"
             }
        }
   }).then((tx) => {
        console.log("Hurray! I've become a sponsor!!!");
   }).catch((error) => {
        console.error("Something went wrong", error);
   });

In case of a success, a transfer fee can be paid in the asset.

Тype 15 SET ASSET SCRIPT – setting a script to an asset

  • assetId string – asset ID
  • script string - [script]
  • fee MoneyLike -fee
  • *senderPublicKey string - sender's public key in base58
  • *timestamp number/string – time in ms

It's now impossible to cancel a script, you can only add a new script. Script development on RIDE

Example:

   zbsLink.signAndPublishTransaction({
        type: 15,
        data: {
             assetId: "",
             script: "base64:AQa3b8tH",
             fee: {
                 "tokens": "0.01",
                 "assetId": "ZBS"
             }
        }
   }).then((tx) => {
        console.log("Hurray! I have reset a script to the asset!!!");
   }).catch((error) => {
        console.error("Something went wrong", error);
   });

In case of a success, the asset's script will be reset.

signOrder

0bsLink's method for signing an order to the matcher. As input, it accepts an object similar to a transaction like this:

    {
        type: 1002,
        data: {
            ...data
        }
    }
  • amount MoneyLike - amount
  • price MoneyLike - price
  • orderType 'sell'/'buy' – order type
  • matcherFee MoneyLike - fee (0.003 ZBS minimum),
  • matcherPublicKey string - the public key of the exchange service
  • expiration string/number – the order's expiration time
  • *timestamp string/number - current time
  • *senderPublicKey string - public key in base58

Example:

   zbsLink.signOrder({
        type: 1002,
        data: {
             matcherPublicKey: "7kPFrHDiGw1rCm7LPszuECwWYL3dMf6iMifLRDJQZMzy",
             orderType: "sell",
             expiration: Date.now() + 100000,
             amount: {
                 tokens: "100",
                 assetId: "ZBS"
             },
             price: {
                 tokens: "0.01",
                 assetId: "8LQW8f7P5d5PZM7GtZEBgaqRPGSzS3DfPuiXrURJ4AJS"
             },
             matcherFee: {
                 tokens: "0.03",
                 assetId: "ZBS"
             }
        }
   }).then((tx) => {
        console.log("Hurray! I've signed an order!!!");
   }).catch((error) => {
        console.error("Something went wrong", error);
   });

REPLY: A line with data for sending to the matcher.

ERRORS:

  • { message: "User denied message", code: 10 } – the user rejected the request
  • { message: "Api rejected by user", code: 12 } – The website is not trusted
  • { message: "Invalid data", data: "Reason", code: 9 } - invalid/incomplete request data

signAndPublishOrder

0bsLink's method for creating an order to the matcher is identical to signOrder, but it also tries to send data to the matcher.

REPLY: the matcher's reply line about successful creation of an order.

ERRORS:

  • Same as for signOrder
  • {message: "Filed request", data: "Error description", code: 15} – a request has been signed, but not sent to the matcher

signCancelOrder

0bsLink's method for signing cancellation of an order to the matcher. As input, it accepts an object similar to a transaction like this:

    {
        type: 1003,
        data: {
            ...data
        }
    }
  • id string – order ID
  • *senderPublicKey - string - sender's public key in base58

Example:

    zbsLink.signCancelOrder({
        type: 1003,
        data: {
            id: '31EeVpTAronk95TjCHdyaveDukde4nDr9BfFpvhZ3Sap'
        }
    });

REPLY: A data line for sending to the matcher.

ERRORS:

  • { message: "User denied message", code: 10 } – the user rejected the request
  • { message: "Api rejected by user", code: 12 } – The website is not trusted
  • { message: "Invalid data", data: "Reason", code: 9 } - invalid/incomplete request data

signAndPublishCancelOrder

0bsLink's method for cancelling an order to the matcher. It works identically to signCancelOrder, but also tries to send data to the matcher.

Example:

    zbsLink.signAndPublishCancelOrder({
        type: 1003,
        data: {
            id: '31EeVpTAronk95TjCHdyaveDukde4nDr9BfFpvhZ3Sap'
        }
    }).then(() => {
        console.log('Hurray! I've cancelled an order');
    }).catch((error) => {
        console.error("Something went wrong", error);
    })

REPLY: Data that came from the matcher

ERRORS:

  • Same as for signCancelOrder
  • {message: "Filed request", data: "Error description", code: 15} – a request has been signed, but not sent to the matcher

signRequest

0bsLink's method for signing typified data, for signing requests on various services. As input, it accepts an object similar to a transaction like this:

    {
        type: number,
        data: {
            ...data
        }
    }

Currently, the method supports the following types:

1001 – signing data for a request to the matcher for your orders

  • timestamp number/string
  • *senderPublicKey string public key in base58

Example:

    zbsLink.signRequest({
        type: 1001,
        data: {
            timestamp: 234234242423423
        }
    });

REPLY: a line with a signature in base58.

ERRORS:

  • { message: "User denied message", code: 10 } – the user rejected the request
  • { message: "Api rejected by user", code: 12 } – The website is not trusted
  • { message: "Invalid data", data: "Reason", code: 9 } - invalid/incomplete request data

1004 – signing data for a request to Coinomat

  • timestamp number/string

Request:

    zbsLink.signRequest({
        type: 1004,
        data: {
            timestamp: 234234242423423
        }
    });

REPLY: a line with a signature in base58.

ERRORS:

  • { message: "User denied message", code: 10 } – the user rejected the request
  • { message: "Api rejected by user", code: 12 } – The website is not trusted
  • { message: "Invalid data", data: "Reason", code: 9 } - invalid/incomplete request data