Utils for linking blockchain accounts

This package contains utility functions to link blockchain accounts to a DID.

Installation

npm install @ceramicnetwork/blockchain-utils-linking

Contributing

We are happy to accept small and large contributions. Make sure to check out the Ceramic specifications for details of how the protocol works.

License

Apache-2.0 or MIT

Index

Enumerations

OcapTypes

Classes

Interfaces

Type aliases

EthProviderOpts

Variables

Object literals

ADDRESS_TYPES

References

AuthProvider

Re-exports AuthProvider

AvalancheAuthProvider

Renames and re-exports EthereumAuthProvider

LinkProof

Re-exports LinkProof

NearAuthProvider

Re-exports NearAuthProvider

PolkadotAuthProvider

Re-exports PolkadotAuthProvider

RpcMessage

Re-exports RpcMessage

TezosAuthProvider

Re-exports TezosAuthProvider

TezosProvider

Re-exports TezosProvider

cosmos

Re-exports cosmos

encodeRpcMessage

Re-exports encodeRpcMessage

eosio

Re-exports eosio

ethereum

Re-exports ethereum

filecoin

Re-exports filecoin

getConsentMessage

Re-exports getConsentMessage

polkadot

Re-exports polkadot

tezos

Re-exports tezos

Type aliases

EthProviderOpts

EthProviderOpts: { eoaSignAccount?: string }

Type declaration

Optional eoaSignAccount?: string

Variables

Const CHAIN_ID

CHAIN_ID: "polkadot:b0a8d493285c2df73290dfb7e61f870f" = "polkadot:b0a8d493285c2df73290dfb7e61f870f"

Const CHAIN_NAMESPACE

CHAIN_NAMESPACE: "eip155" = "eip155"

Const TEZOS_CHAIN_REF

TEZOS_CHAIN_REF: "NetXdQprcVkpaWU" = "NetXdQprcVkpaWU"

Const TEZOS_NAMESPACE

TEZOS_NAMESPACE: "tezos" = "tezos"

Const maxWordLength

maxWordLength: 12 = 12

Functions

asTransaction

asTransaction(address: string, message: string): Tx

- Defined in packages/blockchain-utils-linking/src/cosmos.ts:12
Parameters
- address: string
- message: string
Returns Tx

asTransaction

asTransaction(address: string, message: string): MessageParams

- Defined in packages/blockchain-utils-linking/src/filecoin.ts:44
Parameters
- address: string
- message: string
Returns MessageParams

authenticate

authenticate(message: string, account: AccountID, provider: any): Promise<string>

- Defined in packages/blockchain-utils-linking/src/ethereum.ts:196
Parameters
- message: string
- account: AccountID
- provider: any
Returns Promise<string>

buildOcapRequestMessage

buildOcapRequestMessage(opts: OcapRequestParams): string

- Defined in packages/blockchain-utils-linking/src/ocap-util.ts:30
Parameters
- opts: OcapRequestParams
Returns string

createErc1271Link

createErc1271Link(did: string, account: AccountID, provider: any, opts: any): Promise<LinkProof>

- Defined in packages/blockchain-utils-linking/src/ethereum.ts:167
Parameters
- did: string
- account: AccountID
- provider: any
- opts: any
Returns Promise<LinkProof>

createEthLink

createEthLink(did: string, account: AccountID, provider: any, opts?: any): Promise<LinkProof>

- Defined in packages/blockchain-utils-linking/src/ethereum.ts:136
Parameters
- did: string
- account: AccountID
- provider: any
- Default value opts: any = {}
Returns Promise<LinkProof>

createLink

createLink(did: string, account: AccountID, provider: any, opts: any): Promise<LinkProof>

- Defined in packages/blockchain-utils-linking/src/ethereum.ts:182
Parameters
- did: string
- account: AccountID
- provider: any
- opts: any
Returns Promise<LinkProof>

encodeMessage

encodeMessage(text: string): string

- Defined in packages/blockchain-utils-linking/src/tezos.ts:26
Encodes a message to its Micheline string representation

Parameters
- text: string
  
  the message to Encode
Returns string

the message encoded to the micheline format

References:
- https://github.com/Cryptonomic/ConseilJS/blob/fb718632d6ce47718dad5aa77c67fc514afaa0b9/src/chain/tezos/lexer/Micheline.ts#L62L71
- https://tezos.gitlab.io/shell/micheline.html

encodeRpcMessage

encodeRpcMessage(method: string, params?: any): any

- Defined in packages/blockchain-utils-linking/src/util.ts:36
Parameters
- method: string
- Optional params: any
Returns any

getActiveAddress

getActiveAddress(provider: TezosProvider): Promise<string>

- Defined in packages/blockchain-utils-linking/src/tezos.ts:55
get the active address from the {TezosProvider}

Parameters
- provider: TezosProvider
  
  the provider to use for getting the active account
Returns Promise<string>
- a promise that resolves to the active account's address

getCode

getCode(address: string, provider: any): Promise<string>

- Defined in packages/blockchain-utils-linking/src/ethereum.ts:80
Parameters
- address: string
- provider: any
Returns Promise<string>

getConsentMessage

getConsentMessage(did: string, addTimestamp?: boolean): ConsentMessage

- Defined in packages/blockchain-utils-linking/src/util.ts:25
Parameters
- did: string
- Default value addTimestamp: boolean = true
Returns ConsentMessage

getMetaData

getMetaData(): SignMeta

- Defined in packages/blockchain-utils-linking/src/cosmos.ts:33
Returns SignMeta

Const getSignature

getSignature(signer: Signer, accountId: string, message: any, networkId: string): Promise<string>

- Defined in packages/blockchain-utils-linking/src/near.ts:8
Parameters
- signer: Signer
- accountId: string
- message: any
- networkId: string
Returns Promise<string>

isERC1271

isERC1271(account: AccountID, provider: any): Promise<boolean>

- Defined in packages/blockchain-utils-linking/src/ethereum.ts:120
Parameters
- account: AccountID
- provider: any
Returns Promise<boolean>

isEthAddress

isEthAddress(address: string): boolean

- Defined in packages/blockchain-utils-linking/src/ethereum.ts:76
Parameters
- address: string
Returns boolean

normalizeAccountId

normalizeAccountId(account: AccountID): AccountID

- Defined in packages/blockchain-utils-linking/src/ethereum.ts:125
Parameters
- account: AccountID
Returns AccountID

safeSend

safeSend(provider: any, method: string, params?: Array<any>): Promise<any>

- Defined in packages/blockchain-utils-linking/src/ethereum.ts:84
Parameters
- provider: any
- method: string
- Optional params: Array<any>
Returns Promise<any>

sanitize

sanitize(str: string, size: number): string

- Defined in packages/blockchain-utils-linking/src/eosio.ts:54
Parameters
- str: string
- size: number
Returns string

sign

sign(provider: TezosProvider, message: string): Promise<string>

- Defined in packages/blockchain-utils-linking/src/tezos.ts:42
signs a message with the active address and returns the signature

Parameters
- provider: TezosProvider
  
  the provider to use for signing
- message: string
  
  the message to sign
Returns Promise<string>

the signature prefixed with the signing method

Const stringEncode

stringEncode(str: string): string

- Defined in packages/blockchain-utils-linking/src/cosmos.ts:8
Parameters
- str: string
Returns string

Const stringHex

stringHex(str: string): string

- Defined in packages/blockchain-utils-linking/src/polkadot.ts:6
Parameters
- str: string
Returns string

toCAIPChainId

toCAIPChainId(chainId: string): string

- Defined in packages/blockchain-utils-linking/src/eosio.ts:50
Parameters
- chainId: string
Returns string

toPayload

toPayload(message: string, accountID: AccountID): string

- Defined in packages/blockchain-utils-linking/src/eosio.ts:58
Parameters
- message: string
- accountID: AccountID
Returns string

toSignedPayload

toSignedPayload(message: string, accountID: AccountID, provider: any): Promise<string>

- Defined in packages/blockchain-utils-linking/src/eosio.ts:64
Parameters
- message: string
- accountID: AccountID
- provider: any
Returns Promise<string>

utf8toHex

utf8toHex(message: string): string

- Defined in packages/blockchain-utils-linking/src/ethereum.ts:130
Parameters
- message: string
Returns string

validateChainId

validateChainId(account: AccountID, provider: any): Promise<void>

- Defined in packages/blockchain-utils-linking/src/ethereum.ts:157
Parameters
- account: AccountID
- provider: any
Returns Promise<void>

w3cDate

w3cDate(date?: number | string): string

- Defined in packages/blockchain-utils-linking/src/ocap-util.ts:78
Parameters
- Optional date: number | string
Returns string

Object literals

Const ADDRESS_TYPES

ADDRESS_TYPES: object

erc1271

erc1271: string = "erc1271"

ethereumEOA

ethereumEOA: string = "ethereum-eoa"

Utils for linking blockchain accounts

Installation

Contributing

License

Index

References

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

References

AuthProvider

AvalancheAuthProvider

ConsentMessage

CosmosAuthProvider

EosioAuthProvider

EthereumAuthProvider

FilecoinAuthProvider

LinkProof

NearAuthProvider

PolkadotAuthProvider

RpcMessage

TezosAuthProvider

TezosProvider

cosmos

encodeRpcMessage

eosio

ethereum

filecoin

getConsentMessage

polkadot

tezos

Type aliases

EthProviderOpts

Type declaration

Optional eoaSignAccount?: string

Variables

Const CHAIN_ID

Const CHAIN_NAMESPACE

Const TEZOS_CHAIN_REF

Const TEZOS_NAMESPACE

Const maxWordLength

Functions

asTransaction

Parameters

address: string

message: string

Returns Tx

asTransaction

Parameters

address: string

message: string

Returns MessageParams

authenticate

Parameters

message: string

account: AccountID

provider: any

Returns Promise<string>

buildOcapRequestMessage

Parameters

opts: OcapRequestParams

Returns string

createErc1271Link

Parameters

did: string

account: AccountID

provider: any

opts: any

Returns Promise<LinkProof>

createEthLink

Parameters

did: string

account: AccountID

provider: any

Default value opts: any = {}

Returns Promise<LinkProof>