2.1 - Quick Start

原文链接：https://docs.simpleid.xyz/javascript-sdk/quick-start

开始使用SimpleID

如果你从NPM安装SimpleID:

$ npm i simpleid-js-sdk

如果您正在使用CDN，我们推荐JSDelivr的简单脚本标记方法:

<script src="https://cdn.jsdelivr.net/npm/simpleid-js-sdk" type="text/javascript" />

备注
如果使用CDN，则SimpleID函数的实现将根据框架的不同而有所不同。但是这些文档尽可能的通用化。

一旦安装了包或添加了CDN脚本标记，就可以导入库或引用它:

import { createUserAccount, login } from 'simpleid-js-sdk'; //import statement
const { createUserAccount, login } = require('simpleid-js-sdk'); //require package

你还需要创建一个配置对象，它将被传递到你的SimpleID函数:

const config = {
apiKey: {yourDevId}, //found in your SimpleID account page
authProviders: ['blockstack', 'ethereum', 'textile'], //array of auth providers that matches your modules selected
storageProviders: ['blockstack', 'ipfs'], //array of storage providers that match the modules you selected
appOrigin: "https://yourapp.com", //even if using SimpleID on a server or as a desktop/mobile app, you'll need to pass an origin for reference
scopes: ['publish_data', 'store_write', 'email'] //array of permission you are requesting from the user
}

备注
如果在生成API密钥时通过与所选模块不匹配的授权或存储提供程序，则函数将被拒绝，并返回一条错误消息。

对于帐户创建和登录，除了配置对象外，还需要将某些细节传递给函数。凭据对象需要通过用户输入和通过您自己的配置传递的数据的组合来构建。下面是凭证对象的一个例子:

const credObj = {
  id: ${availableName}, //This is the name the user selects and will be checked against existing registered names automatically.
  password: ${userPassword}, //This should be a complex password supplied by the user 
  hubUrl: ${storageHubURL}, //This will likely be "http://hub.blockstack.org" but can be any storage hub you allow
  email: ${emailToUse} //Email address for the user, used during account recovery
}

对于登录，您需要将一些数据合并到一个对象中。可以是这样的:

const params = {
credObj,
config,
userPayload: {} //this can be left as an empty object
}

现在您已经有了基本的实现，您可以在您的应用程序中使用这些功能。

import { createUserAccount, login } from 'simpleid-js-sdk';
const config = {
  apiKey: ${yourApiKey}, //found in your SimpleID account page
  devId: ${yourDevId}, //found in your SimpleID account page
  authProviders: ['blockstack', 'ethereum', 'textile'], //array of auth providers that matches your modules selected
  storageProviders: ['blockstack', 'ipfs'], //array of storage providers that match the modules you selected
  appOrigin: "https://yourapp.com", //even if using SimpleID on a server or as a desktop/mobile app, you'll need to pass an origin for reference
  scopes: ['publish_data', 'store_write', 'email'] //array of permission you are requesting from the user
}

const credObj = {
  id: "somenamethatuserwants",
  password: "super secure password",
  hubUrl: "https://hub.blockstack.org", //only applies for Blockstack storage
  email: "thebestemail@email.com"
}

const params = {
  credObj,
  config,
  userPayload: {} //this can be left as an empty object
}

//For account creation:
const account = await createUserAccount(credObj, config);
console.log(account);

//For login:
const signIn = await login(params);
console.log(signIn);