Skip to content

Repository files navigation

@moneybutton/paymail-client

Description

Javascript client to interact with BSV paymail protocol.

See the docs

Ussage.

import{PaymailClient,Verifi}from'@moneybutton/paymail-client'importfetchfrom'isomorphic-fetch'importdnsfrom'dns'importPrivKeyfrom'bsv/lib/priv-key'importPubKeyfrom'bsv/lib/pub-key'constclient=newPaymailClient(dns,fetch)// Any implementation of fetch can be used.constsomePaymailAddress='some_name@moneybutton.com'client.getPublicKey(somePaymailAddress).then(pubkey=>{console.log(`Current public key for ${somePaymailAddress} is ${pubkey}`)})// You can look for someones public identity key.constsenderPrivateKey='L3kZEuaEgdfsV7BXCrwhs8E9BuJaN67HvdkSNTfy3CmKjbXkBEjX'client.getOutputFor(somePaymailAddress,{senderHandle: 'sender@moneybutton.com',amount: 10000,// Amount in satoshissenderName: 'Mr. Sender',purpose: 'Pay for your services.',pubkey: '03aa44757af33e7c9c9ceb1d5655741867ef8efea00bbc3f498424c91a16c85779'},senderPrivateKey).then(output=>{console.log(`Now I can send money to ${somePaymailAddress} using this output: ${output}`)})// You can also use a previously created signature instead of passing in the private key.import{VerifiableMessage}from'@moneybutton/paymail-client'consttimestamp=newDate().toISOString()constpreMadeSignature=VerifiableMessage.forBasicAddressResolution({senderHandle: 'sender@moneybutton.com',amount: 10000,dt: timestamp,purpose: 'Pay for your services.'}).sign('senderPrivateKey')client.getOutputFor(somePaymailAddress,{senderHandle: 'sender@moneybutton.com',amount: 10000,// Amount in satoshissenderName: 'Mr. Sender',purpose: 'Pay for your services.',pubkey: '03aa44757af33e7c9c9ceb1d5655741867ef8efea00bbc3f498424c91a16c85779',signature: preMadeSignature}).then(output=>{console.log(`Now I can send money to ${somePaymailAddress} using this output: ${output}`)})// You can check if a given key belongs to a given paymailconstsomePubKey=PubKey.fromPrivKey(PrivKey.fromRandom()).toString()client.verifyPubkeyOwner(somePubKey,'someuser@moneybutton.com').then(aBoolean=>{console.log(`The key ${somePubKey}${aBoleean ? 'does' : 'doesn\'t'} belongs to someuser@moneybutton.com`)})// Lastly it lets you verify if certain signature is valid for certain paymail address.constaMessage=newVerifiableMessage(['very','important','message'])constaSignature='some signature for the message'client.isValidSignature(aMessage,aSignature,'someone@moneybutton.com').then(aBoolean=>{if(aBoolean){console.log('the signature is valid, yey!')}else{console.log('the signature is invalid, don\'t trust them')}})

About

Js client to interact with servers using paymail specification.

Resources

Stars

25 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages