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: {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
}

备注
如果在生成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);
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 230,431评论 6 544
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 99,637评论 3 429
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 178,555评论 0 383
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 63,900评论 1 318
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 72,629评论 6 412
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 55,976评论 1 328
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 43,976评论 3 448
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 43,139评论 0 290
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 49,686评论 1 336
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 41,411评论 3 358
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 43,641评论 1 374
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 39,129评论 5 364
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 44,820评论 3 350
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 35,233评论 0 28
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 36,567评论 1 295
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 52,362评论 3 400
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 48,604评论 2 380

推荐阅读更多精彩内容